TAG LINE
TAG LINE
SMALL TITLE
System defined types of payment types such as Credit Card, ACH or Cash.
identity READ-ONLY | "identity": 12 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. |
| GET | Payment/BaseType/ |
| Retrieve all of the PaymentBaseType objects. | |
Retrieve all of the PaymentBaseType objects. GET Payment/BaseType/ HTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"totalCount": 1,
"items": [
{
"identity": 1,
"name": "ACH",
"vendorPaymentType": "credit_card"
}
]
} | |
| GET | 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 Payment/BaseType/Paged 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"
}
]
}
} | |
| GET | 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 Payment/BaseType/{id}HTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"instance": {
"identity": 1,
"name": "ACH",
"vendorPaymentType": "credit_card"
}
} | |