TAG LINE
SMALL TITLE

Payment Base Type

(API Version v4)


System defined types of payment types such as Credit Card, ACH or Cash.


What can you do with PaymentBaseType?


Properties

Property Details
identity
READ-ONLY
"identity": 23
Type: Number
This is the unique numeric identifier for the PaymentBaseType
name
READ-ONLY
"name": "ACH"
Type: String
System defined name for the Payment Base Type.
vendorPaymentType
READ-ONLY
"vendorPaymentType": "credit_card"
Type: String
Payment Gateway friendly system definition for the payment type.


End Points

GETapi/v4/Payment/BaseType/
Retrieve all of the PaymentBaseType objects.
Retrieve all of the PaymentBaseType objects.
GET api/v4/Payment/BaseType/
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "totalCount": 1,
    "items": [
        {
            "identity": 1,
            "name": "ACH",
            "vendorPaymentType": "credit_card"
        }
    ]
}
GETapi/v4/Payment/BaseType/Paged
Retrieve all of the PaymentBaseType objects in a paged fashion. This endpoint implements pagination for its results. Individual pages can be requested to return a particular paged set in the list of results. To learn more, see details on working with paginated endpoints.
Retrieve all of the PaymentBaseType objects in a paged fashion.
GET api/v4/Payment/BaseType/Paged
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "pagination": {
        "pageNumber": 1,
        "pageSize": 20,
        "excludeTotalCount": false
    },
    "pagedResults": {
        "totalCount": 1,
        "items": [
            {
                "identity": 1,
                "name": "ACH",
                "vendorPaymentType": "credit_card"
            }
        ]
    }
}
GETapi/v4/Payment/BaseType/{id}
Retrieve an instance of the PaymentBaseType object by its ID.
{id}Unique identifier for the PaymentBaseType object.
Retrieve an instance of the PaymentBaseType object by its ID.
GET api/v4/Payment/BaseType/{id}
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "instance": {
        "identity": 1,
        "name": "ACH",
        "vendorPaymentType": "credit_card"
    }
}
POSTapi/v4/Payment/BaseType/Search
Retreive a list of PaymentBaseType objects based on search criteria. Search end points allow for retrieving results based on search criteria. Search criteria is sent as the payload of the POST.
Retreive a list of PaymentBaseType objects based on search criteria.
POST api/v4/Payment/BaseType/Search

{
    "query": {
        "top": 20,
        "search": [
            {
                "name": "MyFieldName",
                "operator": "startsWith",
                "value": "a"
            }
        ]
    }
}
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "itemCount": 1,
    "items": [
        {
            "identity": 1,
            "name": "ACH",
            "vendorPaymentType": "credit_card"
        }
    ]
}