Picture

Payments with Bank Details

The Pay with Account Details API is used by customers who want to make payment using their Wema Bank account numbers. Upon approval, a direct debit request would be made to the customer’s account. 

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.

Step 1: Initiate Request and SendOtp 

The endpoint allows the customer to initiate the debit request. Upon a successful call, a one-time-password (OTP) would be sent to the customer’s phone number.

The value of the bankCode parameter should be maintained as "035".

/api/v1/accountNumber/sendOtp


{
  "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": "+23480000000001",
      "firstName": "Jane",
      "lastName": "+23480000000001",
      "metadata": "string"
    },
    "accountNumber": "string",
    "bankCode": "035"
}

A transactionId would be returned in the response object. This would be used in the call to validate the transaction. 

Step 2: Validate Request

This endpoint allows the customer to authorize the debit request. Customers are expected to provide the OTP sent to their phone number. The endpoint requires the OTP and transactionId. 

/api/v1/accountNumber/validateAndPay

{

"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,

"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"

},

"otp": {

"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": ""

},

"accountNumber": "string",

"bankCode": "035",

"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

"otp": "string",

"transactionId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

"phoneNumber": "string",

"trackingId": "string",

"otpResponseMessage": "string",

"createdAt": "yyyy-MM-dd HH:mm:ss,fff. Using ISO-8601 standard"

}

}

}

Next Step:

Setup Transaction Monitoring.