API Library

This section includes the three (3) Transaction History API endpoints listed below. Each page offers a brief summary of the API endpoint in question, common use-case scenarios, and sample request/response messages with response codes.

API endpoints

Health Check

Test and confirm that the Transaction History API is up and ready to process requests.

Collector Request

Retrieve the transaction history for a logged in Collector.

Sponsor Request

Retrieve the transaction history for a specified Collector number and filter by sponsor.

Handling request/response messages

As described above, the RESTful specification defines a transaction as a pair of request and response messages that are used for information interchange.

Note

Mandatory parameters will be marked with an asterisk (*) in the subsequent pages.

Message Type Description

Request All mandatory parameters MUST be included in each API call.
All other parameters are optional, unless stated otherwise.

Response Indicates which parameters/elements are always returned.
The “Response” Content-Type is specified in the Header (e.g., application/json.
A “Response” resulting in an ’error condition’ will include an accompanying responseCode.
Partners are expected to verify and handle each Response Code as necessary.
All response values are NOT not case-sensitive.
Data elements that contain null or ’empty’ values are automatically excluded from the response body.
The ‘POS’ terminal may use the response elements to display/print information for the customer.

Message Type	Description
Request	All mandatory parameters MUST be included in each API call. All other parameters are optional, unless stated otherwise.
Response	Indicates which parameters/elements are always returned. The “Response” `Content-Type` is specified in the Header (e.g., `application/json`. A “Response” resulting in an ’error condition’ will include an accompanying `responseCode`. Partners are expected to verify and handle each Response Code as necessary. All response values are NOT not case-sensitive. Data elements that contain `null` or ’empty’ values are automatically excluded from the response body. The ‘POS’ terminal may use the response elements to display/print information for the customer.

Status codes

Status Code	Description
`200`	The transaction was successful.
`401`	The Collector account is not active.
`408`	The transaction timed out.
`401`	The Collector number is invalid.
`400`	A mistake was made when submitting the request. Please correct the error and try again.
`503`	The system is unavailable due to scheduled maintenance. No requests can be sent.
`500`	An unknown error occurred
none	No valid Bearer token present. Please generate a valid Bearer token and submit to continue.