Create a payout

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", "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

Authorization

string

header

required

Use your OAuth client credentials to obtain a short-lived Bearer token from POST /oauth/token.

Body

application/json

NGN — Bank Transfer
GBP — Bank Transfer
USD — ACH
USD — Wire
EUR — Bank Transfer
CAD — Interac
Crypto — USDT on Ethereum
Specify amount to send (from_amount)
Specify amount recipient receives (to_amount)

wallet_id

string

required

Business wallet ID

customer_id

string

required

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.

method

enum<string>

required

Payout method

Available options:

bank_transfer,

interac,

crypto,

wire,

ach

from_currency_id

string

required

Currency the business pays with (ID or code)

to_currency_id

string

required

Currency the recipient gets (ID or code)

from_amount

number

Amount being sent (omit if using to_amount)

to_amount

number

Exact amount the recipient should receive

type

enum<string>

Required if method is ach/wire

Available options:

individual,

business

phone_number

string

Required for interac

interac_first_name

string

Required for interac

interac_last_name

string

Required for interac

bank_id

string

Required when method=bank_transfer and currency=NGN

account_number

string

Required for bank_transfer/ach/wire when currency not EUR/CAD

account_name

string

Required for bank_transfer/ach/wire when currency is USD/GBP/EUR

account_type

enum<string>

Required for ach/wire when currency=USD

Available options:

checking,

savings

bank_name

string

Required for ach/wire when currency=USD

routing_number

string

Required for ach/wire when currency=USD

swift_code

string

Required for wire when currency=USD

sort_code

string

Required for bank_transfer when currency=GBP

iban

string

Required for bank_transfer when currency=EUR

bic_code

string

Required for bank_transfer when currency=EUR

country

string

Required for bank_transfer/ach/wire when currency is USD/EUR/GBP

state

string

Required for ach/wire when currency=USD

street

string

Required for bank_transfer/ach/wire when currency is USD/EUR/GBP

city

string

Required for bank_transfer/ach/wire when currency is USD/EUR/GBP

zip_code

string

Required for bank_transfer/ach/wire when currency is USD/EUR/GBP

country_id

string

Optional country helper

wallet_address

string

Required for crypto

wallet_token

enum<string>

Required for crypto

Available options:

USDT,

USDC

wallet_network

enum<string>

Required for crypto

Available options:

BSC_MAINNET,

ETHEREUM_MAINNET,

TRON_MAINNET,

MATIC_MAINNET

note

string

Narration; defaults to business name if empty

Response

Payout initiated successfully

message

string

required

transaction

object

required

Show child attributes

Blaaiz Platform API

Authentication

Virtual Bank Account

Bank

Payout

Fees

Rate

Currency

Wallet

Collection

Refund

Swap

File

Transaction

Customer

Webhook

Create a payout

Authorizations

Body

Response