Sign in

v1

latestOpenAPI 3.0.12026-07-2679100267.2 KB
Transfers

Perform bank account transfer from the parent account

You can use this endpoint to perform bank account transfer.

post/v2/transfers/bank

Headers

accountIdstring uuid required
Example:890022ce-bae0-45c1-9b9d-ee7872e6ca27

The parent accountId of the business.

Request body

amountnumber double required

The amount to be transferred.

accountNumberstring required

The destination bank account number.

accountNamestring required

The name on the account.

bankCodestring required

The code of the recipient bank.

merchantTxRefstring required

Unique reference used to track a transaction from an external process.

This is an idempotency key and must be unique per transaction.

senderNamestring

Sender name

narrationstring

The payment narration

Example request

{
  "amount": 3500,
  "accountNumber": "0554772814",
  "accountName": "M.A Animashaun",
  "bankCode": "058",
  "merchantTxRef": "UNQ_123abGGhh5546",
  "senderName": "Nightly Post",
  "narration": "Testing Payment"
}

Response

OK - your request was successful.

codestring required

Response Code

description'SUCCESS' | 'PROCESSING' | 'FAILED' | 'BAD_REQUEST' | 'INSUFFICIENT_BALANCE' | 'ACCOUNT_NOT_FOUND' | 'INVALID_TRANSACTION' | 'WALLET_NOT_FOUND' | 'BLACKLISTED' required

Response description

messagestring

Returned response message

statusboolean

Response status

Example response

{
  "code": "200",
  "description": "SUCCESS",
  "message": "Success",
  "data": {
    "amount": "1.0",
    "source": "api",
    "sourceUserId": "11ec45a1-1fe5-44f5-8baf-cxxxxxxxxxx",
    "customerBillerId": "010784xxxx",
    "productId": "058",
    "meta": {
      "api_rrn": "2309081xxxxxx",
      "narration": "Testing",
      "recipientName": "John doe",
      "sender_name": "Nightly Post",
      "merchantTxRef": "3JVW2xJCjj443oannREBuTaXDdji",
      "api_client_id": "6a7bed88-7c93-4a1c-a445-f88edbca6489",
      "currency": "NGN",
      "hooksEligible": "true",
      "banking_entity_id": "842f2b4320f",
      "banking_entity_user_id": "01a10aeb-d989-460a-bbde-9842f2b4320f",
      "banking_entity_type": "9842f2b4320f",
      "self_transaction": "true",
      "transactionCategory": "128735648",
      "accountNumber": "0127667384",
      "bankName": "GTbank",
      "bankCode": "058",
      "user_referral_code": "HABI76745",
      "amount_charged": "21.0",
      "paymentVendor": "Wallet",
      "wallet_balance": "5.38",
      "wallet_currency": "NGN",
      "paymentVendorReference": "01a10aeb-d989-460a-bbde-9840f",
      "agent_commission": "0.0",
      "useV2Fulfilment": "true"
    },
    "fee": 50,
    "timeCreated": "2026-03-08T14:17:13.634Z",
    "id": "API-TRANSFER-C24AD-a6443bf0-011c-4bc2-b739-4a2e33e2a27b",
    "type": "transfer",
    "status": "SUCCESS"
  }
}