Transaction Monitoring

The Transaction API helps you retrieve details of every transaction performed on behalf the merchant across all payment options. 

Prerequisites

  • Head over to our ALATpay portal. to create an account if you don’t already have one.

  • Add your business under the settings tab on the merchant portal.

  • Select Bank Transfer as a payment option.

  • Provide your callback URL – it is important for your business to be duly notified of transaction statuses.

  • Take note of the assigned business ID to your newly created business.

Get All/Filter Transactions

This GET endpoint allows the retrieval of a list of all transaction records performed on behalf of the merchant. However, optional parameters can be provided to filter the output based on the requirement(s) at the time of query. Query parameters include: 

  • Page

  • Limit 

  • MerchantId 

  • BusinessId 

  • PaymentMethod 

  • Status 

  • Amount 

  • StartAt 

  • EndAt 

Get Single Transaction 

This GET endpoint allows the retrieval of the details of a given transaction. This endpoint accepts a single required query parameter, transactionId.

https://alatpay.azure-api.net/transaction/api/v1/transactions/{id} - HTTPGET METHOD

{

"data":

{

"amount": 7500,

"orderId": "testorderid1234567",

"description": "Test v. account",

"paymentMethodId": 2,

"sessionId": "23487663567848734898947567346737846346",

"merchantName": null,

"settlementId": "23232acb-f256-44d0-81da-34fe547d740f",

"customer":

{

"id": "0dab3f4b-7d1b-4431-7e3a-08db3420a246",

"transactionId": "23232acb-f256-44d0-81da-34fe547d740f",

"createdAt": "2023-04-04T14:35:44.4623963",

"email": "danielibanga@gmail.com",

"phone": "2347037805351",

"firstName": "Daniel",

"lastName": "Ibanga",

"metadata": "null"

},

"id": "23232acb-f256-44d0-81da-34fe547d740f",

"merchantId": "036e625e-a25d-4c67-e0f0-08d9f221745e",

"businessId": "cca1e068-2220-49a9-4181-08dafc0c53a0",

"channel": "Bank Transfer",

"callbackUrl": "webhook url",

"feeAmount": 37.5,

"businessName": "FORTRAN INNOVATIONS",

"businessBankAccountNumber": "0242601320",

"businessBankCode": "035",

"currency": "NGN",

"status": "completed",

"statusReason": null,

"settlementType": "Manual",

"createdAt": "2023-04-04T14:35:44.46224",

"updatedAt": "2023-04-04T14:52:34.3293184",

"settledAt": "0001-01-01T00:00:00"

},

"status": true,

"message": "Success"

}

Next Step:

Setup CallbackURL.