Subwallet to Bank

Transfers funds from a user's SubWallet to a Nigerian bank account.

Note: Additional information may be required in meta_data depending on the payout currency and destination requirements.

Request

Method: POST

Endpoint:

{{base_url}}/api/v1/payout/wallet-bank

Authentication & Headers

Header	Type	Required	Description
`Authorization`	String	Yes	`Bearer <token>` — your activated authentication token.
`x-merchant-ref`	String	Yes	Your unique merchant reference.
`Content-Type`	String	Yes	Must be set to `application/json`.

Example Request

curl --location -g '{{base_url}}/api/v1/payout/wallet-bank' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'x-merchant-ref: MERCHANT-REF-001' \
--data '{
  "user_ref": "USER-REF-001",
  "currency": "NGN",
  "wallet_type": "SUB_WALLET",
  "txn_merchant_ref": "TXN-REF-001",
  "amount": 500,
  "account_no": "8064642044",
  "bank_code": "100004",
  "meta_data": {},
  "notification_url": "https://example.com/webhook"
}'

Request Body

{
  "user_ref": "USER-REF-001",
  "currency": "NGN",
  "wallet_type": "SUB_WALLET",
  "txn_merchant_ref": "TXN-REF-001",
  "amount": 500,
  "account_no": "8064642044",
  "bank_code": "100004",
  "meta_data": {},
  "notification_url": "https://example.com/webhook"
}

Request Fields

Field	Type	Required	Description
`user_ref`	String	Yes	Unique reference identifying the user whose SubWallet will be debited.
`currency`	String	Yes	Currency of the payout, e.g. `NGN`.
`wallet_type`	String	Yes	Specifies the source wallet. For SubWallet payouts, use `SUB_WALLET`.
`txn_merchant_ref`	String	Yes	Unique merchant reference for the payout transaction.
`amount`	Number	Yes	Amount to be transferred to the bank account.
`account_no`	String	Yes	Beneficiary's bank account number.
`bank_code`	String	Yes	Bank code identifying the beneficiary's bank.
`meta_data`	Object	Yes	Additional payout information. The required fields may vary depending on the currency and payout requirements.
`notification_url`	String	No	URL where LedgerBlock can send transaction status notifications.

Transfer Flow

User SubWallet → Select Bank → Provide Account Details → Authorize Transaction → Transfer Processing → Bank Account Credited

Before initiating the transfer, ensure that the bank_code and account_no correspond to the intended beneficiary account.

Updated 25 days ago

Did this page help you?