Add paynow 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

verificationStatus

string | null

optional

<= 32 characters

verificationDate

string | null

optional

status

enum<string> | enum<null>

optional

<= 32 characters

Allowed values:

verifiedunverifiedexpiredinvalidpending

name

string

required

>= 1 characters<= 128 characters

entityType

enum<string>

required

Allowed values:

individualbusiness

currency

string

required

>= 1 characters<= 3 characters

proxyType

enum<string>

required

Allowed values:

mobile_numbernricuenvpa

proxyValue

string

required

Example

{
    "verificationStatus": "string",
    "verificationDate": "string",
    "status": "verified",
    "name": "string",
    "entityType": "individual",
    "currency": "str",
    "proxyType": "mobile_number",
    "proxyValue": "string"
}

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/paynow' \
--header 'request-id;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "verificationStatus": "string",
    "verificationDate": "string",
    "status": "verified",
    "name": "string",
    "entityType": "individual",
    "currency": "str",
    "proxyType": "mobile_number",
    "proxyValue": "string"
}'

Responses

🟢200OK

application/json

Body

id

string <uuid>

required

merchantId

string

required

>= 1 characters<= 32 characters

shopId

string

required

>= 1 characters<= 32 characters

terminalId

string

optional

<= 32 characters

customerId

string <uuid>

required

>= 1 characters<= 64 characters

transactionType

string

required

<= 16 characters

externalId

string

required

>= 1 characters<= 128 characters

name

string

required

>= 1 characters<= 128 characters

currency

string

required

>= 1 characters<= 3 characters

verificationStatus

string

optional

<= 32 characters

verificationDate

string

optional

status

enum<string>

required

<= 32 characters

Allowed values:

verifiedunverifiedexpiredinvalidpending

entityType

enum<string>

required

Allowed values:

individualbusiness

proxyType

enum<string>

required

Allowed values:

mobile_numbernricuenvpa

proxyValue

string

required

tenantId

string

optional

Id of the tenant (brand), such as G2A Pay, Zen.

>= 3 characters<= 3 characters

Default:

101

Example:

101

Match pattern:

[0-9]{3}

createdAt

string <date-time>

required

updatedAt

string <date-time>

required

deletedAt

string

optional

Match pattern:

\d{4}-[01]\d-[0-3]\dT[0-2]\d:[0-5]\d:[0-5]\d.\d+Z?

Example

{
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "merchantId": "string",
    "shopId": "string",
    "terminalId": "string",
    "customerId": "87d8e330-2878-4742-a86f-dbbb3bf522ac",
    "transactionType": "string",
    "externalId": "string",
    "name": "string",
    "currency": "str",
    "verificationStatus": "string",
    "verificationDate": "string",
    "status": "verified",
    "entityType": "individual",
    "proxyType": "mobile_number",
    "proxyValue": "string",
    "tenantId": "101",
    "createdAt": "2019-08-24T14:15:22Z",
    "updatedAt": "2019-08-24T14:15:22Z",
    "deletedAt": "string"
}

🟠404Not Found