Skip to main content
POST
cURL

Add Payout Bank Account

Part of the payout-only onboarding flow. See the payout-only onboarding guide for the order of calls and the fields each country requires.

Authorizations

X-API-KEY
string
header
required

API Key for authentication

X-TIMESTAMP
string
header
required

Current timestamp in seconds since epoch

X-SIGNATURE
string
header
required

HMAC SHA256 signature of the request encoded in Base64

Body

application/json
customer_id
string<uuid>
required

Customer from Create Payout Customer

Example:

"84737c7d-7b62-4204-80d6-80f6ecb3ceb4"

identifiers
object
required

Method-specific fields, e.g. {br_cpf} for PIX, {account_holder_name, account_number (IBAN), swift_code} for SEPA.

Example:
bank_account_type
string

Payout method for the country, e.g. PIX, SEPA, WIRE, SPEI, ACH_PUSH. Defaults to the country's default method.

Example:

"PIX"

transfer_purpose
enum<string>

Purpose of transfer (partner-routed countries). Defaults to TRANSFER_TO_OWN_ACCOUNT.

Available options:
TRANSFER_TO_OWN_ACCOUNT,
FAMILY_MAINTENANCE,
EDUCATION,
MEDICAL_TREATMENT,
HOTEL,
TRAVEL,
REPAYMENT_OF_LOANS,
TAX_PAYMENT,
PURCHASE_PROPERTY,
PROPERTY_RENTAL,
INSURANCE_PREMIUM,
PRODUCT_INDEMNITY_INSURANCE,
INSURANCE_CLAIMS,
MUTUAL_FUND_INVESTMENT,
INVESTMENT_SHARES,
DONATIONS,
SALARY,
INFO_SERVICE,
ADVERTISING,
ROYALTY_FEES,
BROKER_FEES,
ADVISOR_FEES,
REPRESENTATIVE_EXPENSES,
CONSTRUCTION,
TRANSPORTATION,
EXPORTED_GOODS,
DELIVERY_FEES,
GENERAL_GOODS_OFFLINE
Example:

"FAMILY_MAINTENANCE"

is_self_transfer
boolean

Whether the beneficiary is the sender (partner-routed countries). Defaults to true.

Example:

false

Response

Success

status
boolean
Example:

true

message
string
Example:

"Success"

data
object