Picture

Setup Callback URL

Upon the completion and fulfillment of payment request performed using the ALATpay payment engine, a callback is made to notify the merchant of the transaction status.

Merchants are required to provide a callback URL on the merchant portal for each business they setup.

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.

The details of the callback model can be found below. This would guide you in developing your callback URL.

{
  "status": true,
  "message": "Success",
  "data": {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "merchantId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "businessId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "channel": "string",
    "callbackUrl": "https://callback...",
    "feeAmount": 0,
    "businessName": "JohnJoe Store",
    "businessBankAccountNumber": "2010000000",
    "businessBankCode": "035",
    "currency": "NGN",
    "status": "string",
    "statusReason": "string",
    "settlementType": "string",
    "createdAt": "yyyy-MM-dd HH:mm:ss,fff. Using ISO-8601 standard",
    "updatedAt": "yyyy-MM-dd HH:mm:ss,fff. Using ISO-8601 standard",
    "amount": 1000,
    "orderId": "string",
    "description": "ALATpay Checkout Payment",
    "paymentMethodId": 0,
    "sessionId": "string",
    "nipTransaction": {
      "originatoraccountnumber": "string",
      "originatorname": "string",
      "bankname": "string",
      "bankcode": "string",
      "amount": 0,
      "narration": "string",
      "craccountname": "string",
      "craccount": "string",
      "paymentreference": "string",
      "sessionid": "string",
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "requestdate": "string",
      "nibssresponse": "string",
      "sendstatus": "string",
      "sendresponse": "string",
      "transactionId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "transactionStatus": "string",
      "log": "string",
      "createdAt": "yyyy-MM-dd HH:mm:ss,fff. Using ISO-8601 standard"    },
    "virtualAccount": {
      "businessId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "businessName": "",
      "amount": 1000,
      "currency": "NGN",
      "orderId": "",
      "description": "ALATpay Checkout Payment",
      "channel": "string",
      "customer": {
        "email": "jane.joe@email.com",
        "phone": "+2348000000001",
        "firstName": "Jane",
        "lastName": "Joe",
        "metadata": ""      
},
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "merchantId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "virtualBankCode": "035",
      "virtualBankAccountNumber": "2010000000",
      "businessBankAccountNumber": "2010000000",
      "businessBankCode": "035",
      "transactionId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "status": "open",
      "expiredAt": "2022-10-03T08:07:17.245Z",
      "settlementType": "string",
      "createdAt": "yyyy-MM-dd HH:mm:ss,fff. Using ISO-8601 standard"    
},
    "customer": {
      "email": "jane.joe@email.com",
      "phone": "+2348000000001",
      "firstName": "Jane",
      "lastName": "Joe",
      "metadata": "",
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "transactionId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "createdAt": "yyyy-MM-dd HH:mm:ss,fff. Using ISO-8601 standard"
}
}
}

Next Step:

Provide Callback URL on merchant portal.