Add payout card - API Reference

Request

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

external-customer-id

string

required

A customer identifier from merchant system

Body Params application/json

card

object

required

number

string <pan>

required

>= 12 characters<= 19 characters

Example:

4111111111111111

expiryDate

string

optional

Example:

0620

Match pattern:

^(0[1-9]|1[012])[0-9]{2}$

cvv

string

optional

Cvv on credit card

>= 3 characters<= 3 characters

Example:

123

Match pattern:

^[0-9]+$

recipientFirstName

string

required

>= 1 characters<= 128 characters

recipientLastName

string

required

>= 1 characters<= 128 characters

cardAlias

string

optional

<= 128 characters

Example

{
    "card": {
        "number": 4111111111111111,
        "expiryDate": "0620",
        "cvv": 123
    },
    "recipientFirstName": "string",
    "recipientLastName": "string",
    "cardAlias": "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/v2/payout-profiles/card' \
--header 'request-id;' \
--header 'external-customer-id;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "card": {
        "number": 4111111111111111,
        "expiryDate": "0620",
        "cvv": 123
    },
    "recipientFirstName": "string",
    "recipientLastName": "string",
    "cardAlias": "string"
}'

Responses

🟢200OK

application/json

OK

Body

organization

string

optional

>= 1 characters<= 32 characters

id

string <uuid>

required

customerId

string <uuid>

optional

<= 64 characters

cardName

string

optional

>= 1 characters<= 128 characters

recipientFirstName

string

optional

>= 1 characters<= 128 characters

recipientLastName

string

optional

>= 1 characters<= 128 characters

last4

string

required

>= 1 characters<= 4 characters

fundsAvailability

string

optional

<= 255 characters

createdAt

string <date-time>

required

updatedAt

string <date-time>

required

Example

{
    "organization": "string",
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "customerId": "87d8e330-2878-4742-a86f-dbbb3bf522ac",
    "cardName": "string",
    "recipientFirstName": "string",
    "recipientLastName": "string",
    "last4": "stri",
    "fundsAvailability": "string",
    "createdAt": "2019-08-24T14:15:22Z",
    "updatedAt": "2019-08-24T14:15:22Z"
}

🟠404Record Not Found