API Reference

Verify merchant's customer payout recipient card

POST

https://api.zen.com/v3/customers/{merchantCustomerId}/payouts/recipients/pme_card/verify

customershosted-payout-page

Request

Path Params

merchantCustomerId

string

required

An unique merchant customer external identifier

>= 1 characters<= 128 characters

Query Params

currency

string

required

Currency

>= 3 characters<= 3 characters

Example:

PLN

Match pattern:

^[A-Z]+$

amount

string

required

Amount

Example:

123.04

Match pattern:

^(?=.*[0-9])\d{1,16}(?:\.\d{1,12})?$

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]+$

customer-ip

required

A customer IP address for feature use

Any of

string<ipv4>

string<ipv6>

<= 15 characters

Example:

127.0.0.1

Body Params application/json

phoneNumber

string

required

>= 2 characters<= 64 characters

Example:

48664778234

Match pattern:

^[0-9\+]+$

cardNumber

string <pan>

required

>= 12 characters<= 19 characters

Example:

4111111111111111

recipientFirstName

string

required

>= 1 characters<= 128 characters

recipientLastName

string

required

>= 1 characters<= 128 characters

alias

string | null

required

>= 1 characters<= 128 characters

Example

{
    "phoneNumber": "48664778234",
    "cardNumber": 4111111111111111,
    "recipientFirstName": "string",
    "recipientLastName": "string",
    "alias": "string"
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://api.zen.com/v3/customers//payouts/recipients/pme_card/verify?currency&amount' \
--header 'request-id;' \
--header 'customer-ip;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "phoneNumber": "48664778234",
    "cardNumber": 4111111111111111,
    "recipientFirstName": "string",
    "recipientLastName": "string",
    "alias": "string"
}'

Responses

🟢200OK

application/json

Body

string <uuid>

required

merchantCustomerId

string

required

alias

string

optional

last4

string

required

organization

string

required

paymentMethod

string

required

paymentChannel

string

required

organizationLogoUrl

string

optional

createdAt

string

required

Example

{
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "merchantCustomerId": "string",
    "alias": "string",
    "last4": "string",
    "organization": "string",
    "paymentMethod": "string",
    "paymentChannel": "string",
    "organizationLogoUrl": "string",
    "createdAt": "string"
}

Modified at 2025-07-10 11:28:41

Fetch saved merchant customer payout recipient list V3

Fetch saved merchant customer's payout card V3