v1

latestOpenAPI 3.1.02026-07-26290731.0 KB

Get Transactions

Search for transactions done over a period

get/paymentgateway/api/v1/transactions

Query parameters

merchantCodestring required

merchant code

responseCodestring

Response Code to filter by

transactionReferencestring

the transaction reference

merchantCustomerIdstring

the customer id for the transaction

bankCodestring

the bank code

statusstring

the transaction status: ALL, SUCCESS, FAILED, INCOMPLETE

startDatestring required

start date of the date range. Format: MM/dd/yyyy

endDatestring required

end date of the date range. Format: MM/dd/yyyy

pageSizeinteger required

pageNuminteger required

Headers

Authorizationstring

Set value to "Bearer <token>"

Content-Typestring

Set value to "application/json"

Response

200

countinteger

Example response

{
  "count": 101,
  "content": [
    {
      "id": 474489980,
      "payableId": 33597,
      "amount": 10000000,
      "transactionReference": "pay1685456807848",
      "responseCode": "Z0",
      "payableCode": "9405967",
      "payableName": "complete gateway",
      "merchantCode": "MX6072",
      "channel": "TRANSFER",
      "currencyCode": "566",
      "dateOfPayment": "1685460429590",
      "status": "Incomplete",
      "responseDescription": "Transaction not Completed",
      "feeType": "FEE_DETERMINED_AT_MERCHANT_X"
    }
  ]
}