TAG LINE
SMALL TITLE
This entity represents different payment types. Such as "Credit Card", "ACH", "Cheque" etc.
identity READ-ONLY | "identity": 2 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": 17 Type: Number Unused |
When updating an object you use the update request header with the list of properties to update. Then you need only supply the new values in the body of your request. Please note, this header can only be used with PUT or PATCH requests.
Field List:
| GET | api/v3/CollectionType/ |
| Retrieve all of the CollectionType objects. | |
Retrieve all of the CollectionType objects. GET api/v3/CollectionType/ HTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"totalCount": 1,
"items": [
{
"identity": 1,
"name": "Credit Card",
"sortOrder": 21
}
]
} | |
| GET | api/v3/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 api/v3/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": 4
}
]
}
} | |
| GET | api/v3/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 api/v3/CollectionType/{id}HTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"instance": {
"identity": 1,
"name": "Credit Card",
"sortOrder": 13
}
} | |