Add customer recipient - API Reference

Request

Path Params

merchantCustomerId

string <uuid>

required

An unique customer external identifier

Example:

3fa85f64-5717-4562-b3fc-2c963f66afa6

Header Params

request-id

string

required

A unique identifier generated by requesting client

>= 38 characters<= 1024 characters

Example:

|us04oqdnzFQVr0rITD9/c9OvDRE2sXVfwerv.

Match pattern:

^[a-zA-Z0-9?&:_|\-\/=+.,#\s]+$

Body Params application/json

merchantId

string

optional

>= 1 characters<= 32 characters

customerId

string <uuid>

optional

>= 1 characters<= 64 characters

firstTransactionId

string <uuid>

optional

walletAddress

string

required

>= 1 characters<= 512 characters

walletCurrency

string

required

>= 1 characters<= 16 characters

walletAlias

string | null

required

>= 1 characters<= 128 characters

verificationStatus

string | null

optional

<= 32 characters

verificationDate

string | null

optional

walletAddressMemo

string | null

optional

>= 4 characters<= 1024 characters

Match pattern:

^[0-9]*$

status

enum<string> | enum<null>

optional

<= 32 characters

Allowed values:

verifiedunverifiedexpiredinvalidpending

travelRuleData

optional

One of

New individual travel rule data

New business travel rule data

Travel rule data for individual profile

entityType

enum<string>

required

Allowed value:

individual

vaspName

string

required

<= 255 characters

firstName

string

required

<= 255 characters

lastName

string

required

<= 255 characters

address

string

required

<= 255 characters

dateOfBirth

string <date>

required

Example

{
    "merchantId": "string",
    "customerId": "87d8e330-2878-4742-a86f-dbbb3bf522ac",
    "firstTransactionId": "03056aca-c5f2-4f6b-a174-27e4af663155",
    "walletAddress": "string",
    "walletCurrency": "string",
    "walletAlias": "string",
    "verificationStatus": "string",
    "verificationDate": "string",
    "walletAddressMemo": "string",
    "status": "verified",
    "travelRuleData": {
        "entityType": "individual",
        "vaspName": "string",
        "firstName": "string",
        "lastName": "string",
        "address": "string",
        "dateOfBirth": "2019-08-24"
    }
}

Request samples

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request POST 'https://api.zen.com/v3/customers//withdrawals/dragon' \
--header 'request-id;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "merchantId": "string",
    "customerId": "87d8e330-2878-4742-a86f-dbbb3bf522ac",
    "firstTransactionId": "03056aca-c5f2-4f6b-a174-27e4af663155",
    "walletAddress": "string",
    "walletCurrency": "string",
    "walletAlias": "string",
    "verificationStatus": "string",
    "verificationDate": "string",
    "walletAddressMemo": "string",
    "status": "verified",
    "travelRuleData": {
        "entityType": "individual",
        "vaspName": "string",
        "firstName": "string",
        "lastName": "string",
        "address": "string",
        "dateOfBirth": "2019-08-24"
    }
}'

Responses

🟢200OK

application/json

OK

Body

id

string <uuid>

required

customerId

string <uuid>

required

>= 1 characters<= 64 characters

transactionType

string

required

<= 16 characters

firstTransactionId

string <uuid>

optional

walletAddress

string

required

>= 1 characters<= 512 characters

walletCurrency

string

required

>= 1 characters<= 16 characters

walletAlias

string

required

>= 1 characters<= 128 characters

verificationStatus

string

optional

<= 32 characters

verificationDate

string

optional

walletAddressMemo

string

optional

>= 4 characters<= 1024 characters

status

enum<string>

required

<= 32 characters

Allowed values:

verifiedunverifiedexpiredinvalidpending

createdAt

string <date-time>

required

Example

{
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "customerId": "87d8e330-2878-4742-a86f-dbbb3bf522ac",
    "transactionType": "string",
    "firstTransactionId": "03056aca-c5f2-4f6b-a174-27e4af663155",
    "walletAddress": "string",
    "walletCurrency": "string",
    "walletAlias": "string",
    "verificationStatus": "string",
    "verificationDate": "string",
    "walletAddressMemo": "string",
    "status": "verified",
    "createdAt": "2019-08-24T14:15:22Z"
}

🟠404Record Not Found