> ## Documentation Index
> Fetch the complete documentation index at: https://docs.dollarpe.xyz/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 with country-specific identifiers.
Integrate the Zapyd Add Payout Bank Account endpoint into my application.
Endpoint: POST /bank/payout/create
Base URL: [https://sandbox.zapyd.com/cms/api/v1](https://sandbox.zapyd.com/cms/api/v1) (sandbox) | [https://api.zapyd.com/cms/api/v1](https://api.zapyd.com/cms/api/v1) (production)
Full URL (sandbox): POST [https://sandbox.zapyd.com/cms/api/v1/bank/payout/create](https://sandbox.zapyd.com/cms/api/v1/bank/payout/create)
Auth headers required on every request:
* X-API-KEY: your API key
* X-TIMESTAMP: current Unix time in seconds
* X-SIGNATURE: Base64(HMAC-SHA256(key=apiSecret, data=X-API-KEY + "|" + X-TIMESTAMP + "|" + canonicalBody))
canonicalBody = request JSON with keys sorted at every nesting level, no whitespace (separators "," and ":"), non-ASCII escaped as lowercase \uXXXX. GET requests always sign "{}" (query params are not signed). Send the exact canonicalBody string as the request body. Timestamp must be within 300s of server time.
Task: Write a typed function that:
1. Accepts customer\_id, bank\_account\_type (payout method, optional), identifiers for that method, transfer\_purpose and is\_self\_transfer
2. Builds the signed auth headers
3. Calls POST /bank/payout/create
4. Returns the bank account id to use as bank\_id in the payout quotation
5. Handles 400 (unsupported method, missing identifiers, invalid IBAN/SWIFT/CLABE/routing number, missing beneficiary\_identifiers) and 500 errors
Language: TypeScript
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](/api-reference-exchange/integration-guides/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 (partner-routed countries). 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 (partner-routed
countries). 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. The same keys are also
flattened onto the top level of this object.
example:
account_number: '7627389201'
ifsc: SBIN0001829
account_number:
type: string
description: Flattened from identifiers (ACCOUNT_DETAILS)
example: '7627389201'
ifsc:
type: string
description: Flattened from identifiers (ACCOUNT_DETAILS)
example: 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
````