Skip to main content
POST
cURL

Save Payout EDD

Error Codes and Messages

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

Zapyd customer ID (UUID) returned by Create Customer.

Example:

"2e104290-07c8-49f1-a5ca-0d27f0078f8a"

source_of_income
enum<string>
required

Customer's main source of income.

Available options:
SALARY,
BUSINESS_INCOME,
OTHERS
Example:

"SALARY"

bank_statement_url
array
required

URLs of bank statement PDFs. At least one.

Example:
declaration
boolean
required

Consent to declaration

Example:

true

bank_statement_passwords
array

Optional. Passwords for the bank statement PDFs, in the same order. Use an empty string for no password.

Example:
tax_document_url
string<uri>[]

Optional. URLs of tax documents (for India, ITR reports).

Example:
tax_document_passwords
string[]

Optional. Passwords for the tax document PDFs, in the same order. Use an empty string for no password.

Example:
country_specific_documents
object

Optional. Extra documents your country requires, keyed by document type: {"<doc_type>": [""]}.

Response

Payout EDD submitted successfully

status
boolean
Example:

true

message
string
Example:

"Success"

data
object