> ## Documentation Index
> Fetch the complete documentation index at: https://docs.zapyd.com/llms.txt
> Use this file to discover all available pages before exploring further.
# Add Payout Bank Account
> Adds a beneficiary bank account for a payout-only corridor. The identifiers depend on the country.
Add the Zapyd "Add Payout Bank Account" call (`POST /cms/api/v1/bank/payout/create`) to my backend. Adds a beneficiary bank account for a payout-only corridor. The identifiers depend on the country.
* Sandbox: `POST https://sandbox.zapyd.com/cms/api/v1/bank/payout/create`
* Production: `POST https://api.zapyd.com/cms/api/v1/bank/payout/create`
JSON body:
* `customer_id` (string, uuid, required): Customer from Create Payout Customer.
* `bank_account_type` (string, optional): Payout method for the country, e.g. PIX, SEPA, WIRE, SPEI, ACH\_PUSH. Defaults to the country's default method. Example: `PIX`.
* `identifiers` (object, required): Method-specific fields, e.g. `{br_cpf}` for PIX, `{account_holder_name, account_number (IBAN), swift_code}` for SEPA.
* `transfer_purpose` (string, optional): Purpose of transfer (every country except India). Defaults to TRANSFER\_TO\_OWN\_ACCOUNT. One of: `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`.
* `is_self_transfer` (boolean, optional): Whether the beneficiary is the sender (every country except India). Defaults to true. Example: `false`.
Success: HTTP 200, `{status: true, message, data}`. `data`: `id`, `customer_id`, `country`, `bank_account_type`, `identifiers` (Rail-specific identifiers. ACCOUNT\_DETAILS: account\_number and ifsc. UPI: vpa), `bank_account_status`, `beneficiary_name` (Account holder name returned by bank verification), `bank_name`, `failure_reason` (Set when bank\_account\_status is FAILED).
Every endpoint can also return 401 `AUTH_*` (signature, timestamp or key: fix, don't retry), and 429 or 5xx (retry with backoff).
Rules:
* Payout-only onboarding, step 4: after `POST /kyc/payout/add-sender-kyc-data`. Payout-only onboarding must be enabled for your organization and for the beneficiary's country.
* `bank_account_type` is the payout method; `identifiers` must hold every key that method needs:
* United Arab Emirates (ARE, AED): `BANK-TRANSFER` (default): `account_holder_name`, `account_number`, `swift_code`
* Brazil (BRA, BRL): `PIX` (default): `br_cpf`
* China (CHN, CNY): `WIRE` (default): `account_holder_name`, `bank_name`, `account_number`, `swift_code`
* Colombia (COL, COP): `BANK-TRANSFER` (default): `bank_name`, `account_number`, `account_type` + beneficiary\_identifiers `beneficiary_id_doc_number`, `beneficiary_phone_number`; `NEQUI`: `phone_number` + beneficiary\_identifiers `beneficiary_id_doc_number`
* United Kingdom (GBR, GBP): `BANK-TRANSFER` (default): `account_holder_name`, `account_number`, `sort_code`
* Hong Kong (HKG, HKD): `CHATS` (default): `account_holder_name`, `bank_name`, `account_number`, `swift_code`, `bank_code`; `WIRE`: `account_holder_name`, `bank_name`, `account_number`, `swift_code`
* Nigeria (NGA, NGN): `BANK-TRANSFER` (default): `account_holder_name`, `bank_name`, `account_number`
* Philippines (PHL, PHP): `PESONET` (default), `INSTAPAY`: `account_holder_name`, `bank_name`, `account_number`
* Singapore (SGP, SGD): `BANK-TRANSFER` (default): `account_holder_name`, `bank_name`, `account_number`, `swift_code`
* Mexico (MEX, MXN): `SPEI` (default): `mx_clabe` + beneficiary\_identifiers `beneficiary_id_doc_number`, `beneficiary_dob`
* United States (USA, USD): `ACH_PUSH` (default), `RTP`, `DOMESTIC_WIRE`, `FEDWIRE`: `account_holder_name`, `bank_name`, `account_number`, `routing_number`; `WIRE`: `account_holder_name`, `bank_name`, `account_number`, `swift_code`
* SEPA countries (any SEPA alpha-3 such as DEU or FRA, EUR): `SEPA` (default): `account_holder_name`, `account_number`, `swift_code`; `WIRE`: `account_holder_name`, `bank_name`, `account_number`, `swift_code`
* `transfer_purpose` and `is_self_transfer` (every country except India) default to `TRANSFER_TO_OWN_ACCOUNT` and `true`. For money sent to another person, set a purpose such as `FAMILY_MAINTENANCE`, `EDUCATION` or `MEDICAL_TREATMENT`, and `is_self_transfer: false`.
* Save `data.id` as `bank_id`. The response always shows `bank_account_type: ACCOUNT_DETAILS`; use the method you sent as `payment_method` in the payout quotation.
Signing (every request):
* Headers: `X-API-KEY`, `X-TIMESTAMP` (Unix seconds, within 300 s of server time; generate per request) and `X-SIGNATURE`.
* `X-SIGNATURE` = Base64(HMAC-SHA256(key = API secret, message = apiKey + "|" + timestamp + "|" + canonicalBody)). Base64 of the raw digest, not hex.
* canonicalBody: the JSON body with keys sorted at every nesting level, no whitespace (separators `,` and `:`), and every non-ASCII character escaped as lowercase `\uXXXX` (Python `json.dumps(body, sort_keys=True, separators=(",", ":"))`). Requests with no body (GET, DELETE) sign `{}`. Query parameters are not signed.
* Send the exact canonicalBody string you signed as the request body, with `Content-Type: application/json`.
* Test vector: key `3f1b2c4d-5e6f-4a7b-8c9d-0e1f2a3b4c5d`, secret `test-secret-do-not-use`, timestamp `1735689600`. Signing `{}` gives `6sCtVSRQjU9+2/af8gdwUAvY1l6Ii6ENcbRfanPkhY0=`. Body `{"customer_id":"78c99d71-f28f-47a9-8302-93b286efbe0e","amount":100.5,"currency":"INR","meta":{"note":"Café","b":2,"a":1}}` gives `l+DvQrzlKbsOSxSYOdWoWHEehcFRZfDJPKlLDkm2cSI=`.
Deliver:
1. A typed `addPayoutBankAccount` function in this codebase's language and HTTP client. Reuse an existing Zapyd client and signer, or write one small shared client.
2. Config from `ZAPYD_API_KEY`, `ZAPYD_API_SECRET` and `ZAPYD_BASE_URL`. The secret stays on the server, never in a browser or app.
3. Return `data`. When `status` is false, throw an error with the HTTP status, `err_code`, `message` and `errors`. Don't show raw errors to end users.
4. Retry only 429 and 5xx: exponential backoff from 1 s, capped at 30 s, at most 5 attempts.
5. Amounts as strings. Types for every field above.
6. Tests: the signer against the test vector, and this call against sandbox.
Reference: `https://docs.zapyd.com/api-reference-exchange/endpoint/bank/payout-create.md`
Part of the payout-only onboarding flow. See the [payout-only onboarding guide](/guides/customers/payout-only-onboarding) for the order of calls and the fields each country requires.
## OpenAPI
````yaml POST /bank/payout/create
openapi: 3.1.0
info:
title: Zapyd API
description: API for Zapyd - Customer, Payout, and Webhook services
license:
name: MIT
version: 1.0.0
servers:
- url: https://sandbox.zapyd.com/pos/api/v1
description: Payout API Base URL
variables:
base_url:
default: https://sandbox.zapyd.com
- url: https://sandbox.zapyd.com/cms/api/v1
description: Customer API Base URL
variables:
base_url:
default: https://sandbox.zapyd.com
security:
- ApiKeyAuth: []
TimestampAuth: []
SignatureAuth: []
tags:
- name: Customer
description: Customer related operations
x-displayName: Customer
x-traitTag: true
- name: Payout
description: Payout related operations
- name: Webhooks
description: Webhook related operations
- name: Widget
description: Hosted buy/sell widget session initialization
paths:
/bank/payout/create:
post:
tags:
- Bank
description: >-
Add the beneficiary's bank account for a payout-only corridor.
bank_account_type selects the payout method for the country (defaults to
the country's default method); identifiers must contain that method's
required keys (see the guide). The returned bank_account_type is always
ACCOUNT_DETAILS. Part of the payout-only onboarding flow; see the
[payout-only onboarding
guide](/guides/customers/payout-only-onboarding). Requires payout-only
onboarding to be enabled for your organization and the customer's
country.
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
customer_id:
type: string
description: Customer from Create Payout Customer
example: 84737c7d-7b62-4204-80d6-80f6ecb3ceb4
format: uuid
bank_account_type:
type: string
description: >-
Payout method for the country, e.g. PIX, SEPA, WIRE, SPEI,
ACH_PUSH. Defaults to the country's default method.
example: PIX
identifiers:
type: object
description: >-
Method-specific fields, e.g. {br_cpf} for PIX,
{account_holder_name, account_number (IBAN), swift_code} for
SEPA.
example:
br_cpf: '12345678909'
transfer_purpose:
type: string
description: >-
Purpose of transfer (every country except India). Defaults
to TRANSFER_TO_OWN_ACCOUNT.
example: FAMILY_MAINTENANCE
enum:
- 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
is_self_transfer:
type: boolean
description: >-
Whether the beneficiary is the sender (every country except
India). Defaults to true.
example: false
required:
- customer_id
- identifiers
responses:
'200':
description: Success
content:
application/json:
schema:
type: object
properties:
status:
type: boolean
example: true
message:
type: string
example: Success
data:
type: object
properties:
id:
type: string
description: Bank account ID
example: 4e6f1b20-a73c-11ec-b909-0242ac120002
format: uuid
customer_id:
type: string
description: Customer ID
example: 550e8400-e29b-41d4-a716-446655440000
format: uuid
country:
type: string
description: Customer country (alpha-3)
example: IND
bank_account_type:
type: string
description: Payment rail
example: ACCOUNT_DETAILS
enum:
- ACCOUNT_DETAILS
- UPI
identifiers:
type: object
description: >-
Rail-specific identifiers. ACCOUNT_DETAILS:
account_number and ifsc. UPI: vpa.
example:
account_number: '7627389201'
ifsc: SBIN0001829
bank_account_status:
type: string
description: Verification status
example: VERIFIED
enum:
- PROCESSING
- VERIFIED
- FAILED
- MANUAL_REVIEW
beneficiary_name:
type: string
description: Account holder name returned by bank verification
example: JOHN DOE
bank_name:
type: string
description: Bank name
example: State Bank of India
failure_reason:
type:
- string
- 'null'
description: Set when bank_account_status is FAILED
example: null
'400':
description: Bad Request
content:
application/json:
schema:
type: object
properties:
status:
type: boolean
example: false
message:
type: string
example: Bad Request
data:
type: 'null'
errors:
type: object
example:
identifiers:
- '''br_cpf'' is required for BRA/PIX.'
err_code:
type: string
example: UNKNOWN_ERROR
'500':
description: Internal Server Error
content:
application/json:
schema:
type: object
properties:
status:
type: boolean
example: false
message:
type: string
example: Internal Server Error
data:
type: 'null'
errors:
type: object
example: {}
err_code:
type: string
example: SYS_INTERNAL_ERROR
servers:
- url: https://sandbox.zapyd.com/cms/api/v1
description: Customer API Base URL
components:
securitySchemes:
ApiKeyAuth:
type: apiKey
in: header
name: X-API-KEY
description: API Key for authentication
TimestampAuth:
type: apiKey
in: header
name: X-TIMESTAMP
description: Current timestamp in seconds since epoch
SignatureAuth:
type: apiKey
in: header
name: X-SIGNATURE
description: HMAC SHA256 signature of the request encoded in Base64
````
This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.