API Reference

Response Schema:

{
  "status": boolean,
  "message": string,
  "data": {
    "transactions": [
      {
        "id": string,
        "reference": string,
        "amount": string,
        "stampDuty": string | null,
        "fee": string | null,
        "settlementAmount": string | null,
        "type": "card-payment" | "transfer",
        "status": "successful" | "failed",
        "datetime": date-time,
        "message": string,
        "cardPayment": {
          "pan": string,
          "stan": string,
          "rrn": string,
          "responseCode": string | null,
          "responseMessage": string | null
        } | null,
        "transfer": {
          "sender": string | null,
          "description": string,
          "sessionId": string | null
        } | null,
        "terminal": {
          "id": string,
          "name": string,
          "address": string | null,
          "phone": string | null,
          "serialNumber": string,
          "model": string | null,
          "assignedAt": date-time,
          "settlementAccountId": string | null,
          "accountDetails": {
            "accountName": string,
            "accountNumber": string,
            "bankName": string,
          } | null,
          "status": "assigned" | "unassigned",
          "unassignedAt": date-time | null
        },
        "settlementStatus": "pending" | "successful" | "failed" | null
      }
    ],
    "meta": {
      "total": number,
      "pageCount": number,
      "perPage": number,
      "currentPage": number
    }
  }
}
Language
Credentials
Header
Click Try It! to start a request and see the response here!