Skip to main content
POST
cURL

Save Payin EDD

Payin EDD results apply to both payins and payouts. This means that doing Payin EDD is enough to suffice for both payin and payout EDD requirements.

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:
purpose
string
required

Why the customer needs higher limits. Free text; the values below are the ones the widget offers.

Examples:

"Investment"

"Trading"

"Payments"

"Lending / Repayments"

"Gifting"

"Donations / Charity"

"Remittance"

"Legal Settlements"

account_operator
enum<string>
required

Who operates the account.

Available options:
SELF,
FAMILY,
THIRD PARTY
Example:

"FAMILY"

account_operator_name
string
required

Name of the person who operates the account.

Example:

"John Doe"

p2p_trading_status
boolean
required

Is customer involved in P2P trading?

Example:

false

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>": [""]}.

supporting_purpose_doc_url
array

Optional. URLs of documents that support the purpose.

Example:
relation_with_account_operator
string

Required when account_operator is not SELF. The customer's relation to the operator.

Example:

"brother"

Response

Payin EDD submitted successfully

status
boolean
Example:

true

message
string
Example:

"Success"

data
object