Create Payout
This endpoint is used to initiate a payout from a business wallet to a recipient using the specified payout method.
Request Body
-
wallet_id(required): The ID of the business wallet associated with the payout. -
method(required): The payout method, which can be eitherbank_transferorinterac. -
from_amount(required): The amount being sent. -
to_amount(optional): The target amount for the payout. -
phone_number(optional): The recipient's phone number. -
from_currency_id(required): The currency used for the payout. -
to_currency_id(required): The currency to be received by the recipient. -
account_number(optional): The recipient's bank account number (required if the method isbank_transfer). -
bank_id(optional): The ID of the bank where the recipient holds an account (required if the payout method isbank_transferand the currency code is NGN). -
email(optional): The recipient's email address (required if the method isinterac). -
interac_first_name(required): The recipient's first name for Interac payouts (required if the method isinterac). -
interac_last_name(required): The recipient's last name for Interac payouts (required if the method isinterac).
Create Payout
This endpoint is used to initiate a payout from a business wallet to a recipient using the specified payout method.
We advise to call the "fees breakdown" endpoint to get up-to-date fees before proceeding with transaction
For payouts in all currencies, we deliver a webhook when the payment is completed. However, for some currencies i.e CAD, we deliver a webhook when the payment is initiated, and also when it is completed.