TAG LINE
SMALL TITLE

Collection Type

(API Version v4)


This entity represents different payment types. Such as "Credit Card", "ACH", "Cheque" etc.


What can you do with CollectionType?


Properties

Property Details
identity
READ-ONLY
"identity": 11
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": 7
Type: Number
Unused


End Points

GETapi/v4/CollectionType/
Retrieve all of the CollectionType objects.
Retrieve all of the CollectionType objects.
GET api/v4/CollectionType/
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "totalCount": 1,
    "items": [
        {
            "identity": 1,
            "name": "Credit Card",
            "sortOrder": 20
        }
    ]
}
GETapi/v4/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/v4/CollectionType/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": "Credit Card",
                "sortOrder": 10
            }
        ]
    }
}
GETapi/v4/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/v4/CollectionType/{id}
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "instance": {
        "identity": 1,
        "name": "Credit Card",
        "sortOrder": 19
    }
}
POSTapi/v4/CollectionType/Search
Retreive a list of CollectionType 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 CollectionType objects based on search criteria.
POST api/v4/CollectionType/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": "Credit Card",
            "sortOrder": 12
        }
    ]
}