Charge By Transfer

{{URL}}/api/cps/v1/initiateBankTransfer

ACCOUNT PAYMENT METHOD

The ACCOUNT payment method allows users to make payments by initiating a bank transfer. The following steps outline the process:

  • 1
    The ACCOUNT payment method allows users to make payments by initiating a bank transfer. The following steps outline the process:
  • 2
    Call the Create Payment endpoint to initiate a payment transaction.
  • 3
    Call the Pay with Transfer endpoint with the necessary details to obtain the account number for the bank transfer.
  • 4
    Make a transfer to the account number received from the response.
  • 5
    If a callbackUrl is provided in the create payment payload, you will receive transaction notifications.
  • 6
    Call the Get Transaction Status endpoint to check the status of the transaction.

AUTHORIZATION

UsernamePassword
Username{{USERNAME}}
Password{{SECRETKEY}}

BODY PARAMS

{
  "customerName": "customername",
  "reference": "rexpaydoc2",
  "amount": "100",
  "customerId": "yourcustomermail@gmail.com"
}

Request Parameters

NameTypeDescriptionOptional Mandatory
amountNumberTransaction Amounttrue
transactionReferenceStringTransaction reference idtrue
accountNumberNumberTransaction account numbertrue
accountNameStringName of recipienttrue
bankNameStringName of recipient's banktrue
responseCodeNumberStatus code of requesttrue
responseDescriptionNumberStatus description of requesttrue

Example Request

{
  "amount": "101.50",
  "transactionReference": "rexpaydoc2",
  "accountNumber": "8767949853",
  "accountName": "John Doe",
  "bankName": "WEMA",
  "responseCode": "00",
  "responseDescription": "Success"
}

Response Parameters

NameTypeDescriptionOptional Mandatory
amountNumberTransaction Amounttrue
transactionReferenceStringTransaction reference idtrue
accountNumberNumberTransaction account numbertrue
accountNameStringName of recipienttrue
bankNameStringName of recipient's banktrue
responseCodeNumberStatus code of requesttrue
responseDescriptionNumberStatus description of requesttrue

Example Response

{
  "amount": "101.50",
  "transactionReference": "rexpaydoc2",
  "accountNumber": "8767949853",
  "accountName": "John Doe",
  "bankName": "WEMA",
  "responseCode": "00",
  "responseDescription": "Success"
}

Did you find this page helpful?