Initiate Bank Transfer

The Initiate Bank Transfer endpoint allows you to start a bank transfer by providing the necessary details, such as the recipient’s bank account information and the amount to be transferred.

Step 1: Set Up Request Headers

Include the following headers in your request:

Step 2: Generate Signature

To generate the HMAC 512 signature, use your encryption key as the hashing key and the request payload as the message.

const crypto = require('crypto');
 
const secretKey = 'YOUR_SECRET_KEY';
const payload = JSON.stringify({
    account_number: "0123456789",
    account_name: "John",
    bank_code: "000013",
    amount: "100",
    currency: "NGN",
    sender_name: "John",
    narration: "John",
    reference: "x01234yz"
});
 
const signature = crypto.createHmac('sha512', secretKey).update(payload).digest('hex');
console.log(signature);

<?php
 
$secretKey = 'YOUR_SECRET_KEY';
$payload = json_encode([
    'account_number' => '0123456789',
    'account_name' => 'John',
    'bank_code' => '000013',
    'amount' => '100',
    'currency' => 'NGN',
    'sender_name' => 'John',
    'narration' => 'John',
    'reference' => 'x01234yz'
]);
 
$signature = hash_hmac('sha512', $payload, $secretKey);
echo $signature;

Step 3: Prepare Request Body

Include the following parameters in your request body:

Step 4: Sample Request

Here is an example of how your request body should look:

{
    "account_number": "0123456789",
    "account_name": "John",
    "bank_code": "000013",
    "amount": "100",
    "currency": "NGN",
    "sender_name": "John",
    "narration": "John",
    "reference": "x01234yz"
}

Step 5: Sample cURL Request

Use the following cURL command to initiate the transfer:

curl -X POST https://mainapi.cashonrails.com/api/v1/bank_transfer \
-H "Content-Type: application/json" \
-H "Authorization: Bearer YOUR_SECRET_KEY" \
-H "Signature: YOUR_HMAC_SIGNATURE" \
-d '{
  "account_number": "0123456789",
  "account_name": "John",
  "bank_code": "000013",
  "amount": "100",
  "currency": "NGN",
  "sender_name": "John",
  "narration": "John",
  "reference": "x01234yz"
}'

Step 6: Sample Response

Here is an example of a successful response:

{
    "success": true,
    "status": "00",
    "message": "Transfer Initiated Successfully",
    "data": {
        "transfer_id": "12345",
        "reference": "x01234yz",
        "status": "pending"
    }
}

Response Fields

Use this endpoint to initiate a bank transfer, ensuring that all necessary details are provided for a successful transaction.