Endpoints
Query transactions
Queries EFT transactions across the caller's merchants. All filter fields are optional. The date window defaults to the last 7 days and is capped server-side at 31 days; when a wider range is requested it is narrowed and a notice is returned. Supply merchantid to restrict to a single merchant in your scope.
Authorization
bearerAuth AuthorizationBearer <token>
A partner API token issued to a Master Account. Send Authorization: Bearer <token> on every request. Tokens are issued and revoked by a SuperAdmin in the backoffice, not through this API.
In: header
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
{
"items": [
{
"id": 0,
"merchantid": 0,
"paymentstatus": 0,
"paymentsubstatus": 0,
"paymentdescription": "string",
"amount": 0,
"currency": "string",
"merchantreference": "string",
"statementreference": "string",
"paymentreference": "string",
"bankreference": "string",
"startdts": "2019-08-24T14:15:22Z",
"enddts": "2019-08-24T14:15:22Z",
"transactiondts": "2019-08-24T14:15:22Z",
"tobank": "string",
"frombank": "string",
"subaccountid": "string",
"subaccountname": "string"
}
],
"count": 0,
"fromdate": "2019-08-24T14:15:22Z",
"todate": "2019-08-24T14:15:22Z",
"notice": "string"
}{
"error": {
"code": "validation_failed",
"message": "MINIMUM_EFT_AMOUNT must be numeric.",
"requestid": "8f3c1a9b2d7e4f60"
}
}{
"error": {
"code": "unauthorized",
"message": "A valid bearer token is required.",
"requestid": "8f3c1a9b2d7e4f60"
}
}{
"error": {
"code": "rate_limited",
"message": "Too many requests. Retry after the period indicated.",
"requestid": "8f3c1a9b2d7e4f60"
}
}