> ## 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.
# Create Payout Customer
> Creates a beneficiary customer for a payout-only corridor (India, SEPA, UK, UAE, Brazil and more).
Integrate the Zapyd Create Payout Customer endpoint into my application.
Endpoint: POST /customer/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/customer/payout/create](https://sandbox.zapyd.com/cms/api/v1/customer/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 client\_reference\_id (then full\_name, email and phone are optional) or full\_name plus email or phone, and alpha\_3\_country\_code (defaults to IND)
2. Builds the signed auth headers
3. Calls POST /customer/payout/create
4. Returns the customer id
5. Handles 400 (unsupported country, payout-only not enabled, invalid email or 10-digit phone) 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 /customer/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:
/customer/payout/create:
post:
tags:
- Customer
description: >-
Create a beneficiary customer for a payout-only corridor. Send
client_reference_id (then email, phone and full_name are optional;
full_name defaults to the reference), or omit it and send full_name plus
email or phone (the reference is then set to the email or phone).
alpha_3_country_code defaults to IND. 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:
client_reference_id:
type: string
description: Your unique ID for this beneficiary
example: beneficiary-001
full_name:
type: string
description: >-
Beneficiary name. Required when client_reference_id is not
sent.
example: Maria Silva
email:
type: string
description: Email
example: maria@example.com
format: email
phone:
type: string
description: Exactly 10 digits
example: '9876543210'
alpha_3_country_code:
type: string
description: >-
Beneficiary country, ISO alpha-3. Must be a supported
payout-only country; defaults to IND.
example: BRA
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
format: uuid
example: 550e8400-e29b-41d4-a716-446655440000
client_reference_id:
type: string
example: test123
full_name:
type: string
example: John Doe
email:
type: string
example: john.doe@example.com
phone:
type: string
example: '+1234567890'
country:
type: string
example: USA
type:
type: string
example: INDIVIDUAL
status:
type: string
example: UNVERIFIED
failure_reason:
type: string
example: null
document_type:
type: string
example: AADHAAR
'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:
alpha_3_country_code:
- Only payout flow does not support XYZ.
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
````