curl --request POST \
--url https://api-prod.blaaiz.com/api/external/payout \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"wallet_id": "b18ed308-5ac5-4e9e-bb16-8c03ec2d3c01",
"customer_id": "9d4c4ec5-59ea-4130-bf8a-6a5edec401ee",
"method": "bank_transfer",
"from_amount": 5000,
"from_currency_id": "NGN",
"to_currency_id": "NGN",
"account_number": "0222500691",
"bank_id": "1"
}
'{
"message": "Payout Initiated Successfully.",
"transaction": {
"id": "f20199fd-bdaf-483b-8ff1-08f9ab12f4ca",
"business_id": "9d46461e-f991-423e-9f23-1dbff4079119",
"business_customer_id": "9d4c4ec5-59ea-4130-bf8a-6a5edec401ee",
"business_wallet_id": "9228327b-d448-43f4-a78a-0211edad4365",
"status": "SUCCESSFUL",
"reference": "ef5ba1ca-2a5f-4092-b19d-11f9f7ecbbac",
"external_reference": null,
"currency": "NGN",
"amount": 473,
"amount_without_fee": 473,
"fee": 0,
"rate": 1,
"date": "2024-10-18T11:38:17.000000Z",
"recipient": {
"id": "6c258e65-de94-4d9d-87fb-117480a9d0e7",
"account_number": "1234567890",
"account_name": "Tunde Balogun",
"amount": 473,
"currency": "NGN",
"bank_name": "Access Bank",
"bank_code": "044"
}
}
}Create a payout
Do not use
method: "crypto"with this endpoint. Use the Crypto API for wallet swaps and on-chain crypto payouts.
Use this endpoint to start a payout from a business wallet to a recipient with a supported fiat payout method.
Call the fees breakdown endpoint to get the current fees before you create a payout.
Blaaiz sends a webhook when the payout completes. For some currencies, such as CAD, Blaaiz also sends a webhook when processing starts. Required scope: payout:create.
curl --request POST \
--url https://api-prod.blaaiz.com/api/external/payout \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"wallet_id": "b18ed308-5ac5-4e9e-bb16-8c03ec2d3c01",
"customer_id": "9d4c4ec5-59ea-4130-bf8a-6a5edec401ee",
"method": "bank_transfer",
"from_amount": 5000,
"from_currency_id": "NGN",
"to_currency_id": "NGN",
"account_number": "0222500691",
"bank_id": "1"
}
'{
"message": "Payout Initiated Successfully.",
"transaction": {
"id": "f20199fd-bdaf-483b-8ff1-08f9ab12f4ca",
"business_id": "9d46461e-f991-423e-9f23-1dbff4079119",
"business_customer_id": "9d4c4ec5-59ea-4130-bf8a-6a5edec401ee",
"business_wallet_id": "9228327b-d448-43f4-a78a-0211edad4365",
"status": "SUCCESSFUL",
"reference": "ef5ba1ca-2a5f-4092-b19d-11f9f7ecbbac",
"external_reference": null,
"currency": "NGN",
"amount": 473,
"amount_without_fee": 473,
"fee": 0,
"rate": 1,
"date": "2024-10-18T11:38:17.000000Z",
"recipient": {
"id": "6c258e65-de94-4d9d-87fb-117480a9d0e7",
"account_number": "1234567890",
"account_name": "Tunde Balogun",
"amount": 473,
"currency": "NGN",
"bank_name": "Access Bank",
"bank_code": "044"
}
}
}Authorizations
Use your OAuth client credentials to obtain a short-lived Bearer token from POST /oauth/token.
Body
- NGN — Bank Transfer
- GBP — Bank Transfer
- USD — ACH
- USD — Wire
- EUR — Bank Transfer
- CAD — Interac
- Specify amount to send (from_amount)
- Specify amount recipient receives (to_amount)
Business wallet ID
Customer receiving the payout. The customer must belong to your business and have verification_status=VERIFIED. Both type=individual (verified through the legacy KYC flow) and type=business (verified through the KYB flow) are accepted.
Payout method
bank_transfer, interac, wire, ach Currency the business pays with (ID or code)
Currency the recipient gets (ID or code)
Amount being sent (omit if using to_amount)
Exact amount the recipient should receive
Required if method is ach/wire
individual, business Required for interac
Required for interac
Required for interac
Required when method=bank_transfer and currency=NGN
Required for bank_transfer/ach/wire when currency not EUR/CAD
Required for bank_transfer/ach/wire when currency is USD/GBP/EUR
Required for ach/wire when currency=USD
checking, savings Required for ach/wire when currency=USD
Required for ach/wire when currency=USD
Required for wire when currency=USD
Required for bank_transfer when currency=GBP
Required for bank_transfer when currency=EUR
Required for bank_transfer when currency=EUR
Required for bank_transfer/ach/wire when currency is USD/EUR/GBP
Required for ach/wire when currency=USD
Required for bank_transfer/ach/wire when currency is USD/EUR/GBP
Required for bank_transfer/ach/wire when currency is USD/EUR/GBP
Required for bank_transfer/ach/wire when currency is USD/EUR/GBP
Optional country helper
Narration; defaults to business name if empty
Your own reference for this payout. Blaaiz stores the value and returns it on the transaction endpoints and the webhooks. Each value must be unique for your business. Maximum 255 characters.
255Was this page helpful?