Transfer API(s)
Initiate Transfer
Send funds to a specified bank account. This initiates the transfer process and sends a confirmation PIN to finalize.
POST
string
Identifier of the transfer provider (e.g., Flutterwave, Paystack, etc.).
number
The amount to transfer (in the smallest currency unit if required).
string
The transaction currency (e.g., NGN).
string
The ID used to identify the connected merchant or user.
string
The recipient’s bank account number.
string
The bank code of the recipient’s bank (e.g., 057 for Zenith Bank).
string
The full name of the account holder.
string
A note or description for the transfer (e.g., “Salary Payment”).
Response
string
Message indicating result of the request.
boolean
Indicates whether the transfer was successfully initiated.
string
A unique reference for the initiated transfer.
boolean
If
true, a second step is required to finalize the transfer using a PIN.Notes
- You must store the
transferReferencefor use in the/finalize_transferstep. - The
shouldFinalizeflag indicates whether an OTP or PIN confirmation is required.
Best Practices
✅ Always validate recipient bank details before initiating the transfer.✅ Store and track
transferReference values.✅ Listen for webhooks or poll status if supported.
✅ Always handle
shouldFinalize = true logic by prompting for PIN and finalizing transfer.