Initiate Transfer
Send funds to a specified bank account. This initiates the transfer process and sends a confirmation PIN to finalize.
Identifier of the transfer provider (e.g., Flutterwave, Paystack, etc.).
The amount to transfer (in the smallest currency unit if required).
The transaction currency (e.g., NGN).
The ID used to identify the connected merchant or user.
The recipient’s bank account number.
The bank code of the recipient’s bank (e.g., 057 for Zenith Bank).
The full name of the account holder.
A note or description for the transfer (e.g., “Salary Payment”).
Response
Message indicating result of the request.
Indicates whether the transfer was successfully initiated.
A unique reference for the initiated transfer.
If true
, a second step is required to finalize the transfer using a PIN.
Notes
- You must store the
transferReference
for use in the/finalize_transfer
step. - The
shouldFinalize
flag 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.