TAG LINE
TAG LINE
SMALL TITLE
This entity represents different payment types. Such as "Credit Card", "ACH", "Cheque" etc.
identity READ-ONLY | "identity": 21 Type: Number This is the unique numeric identifier for the CollectionType |
name READ-ONLY | "name": "Credit Card" Type: String The name for this Collection Type. |
sortOrder READ-ONLY | "sortOrder": 0 Type: Number Unused |
| GET | CollectionType/ |
| Retrieve all of the CollectionType objects. | |
Retrieve all of the CollectionType objects. GET CollectionType/ HTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"totalCount": 1,
"items": [
{
"identity": 1,
"name": "Credit Card",
"sortOrder": 26
}
]
} | |
| GET | CollectionType/Paged |
| Retrieve all of the CollectionType 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 CollectionType objects in a paged fashion. GET CollectionType/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": "Credit Card",
"sortOrder": 11
}
]
}
} | |
| GET | CollectionType/{id} |
| Retrieve an instance of the CollectionType object by its ID. | |
| {id} | Unique identifier for the CollectionType object. |
Retrieve an instance of the CollectionType object by its ID. GET CollectionType/{id}HTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"instance": {
"identity": 1,
"name": "Credit Card",
"sortOrder": 25
}
} | |