API Reference

Initialize widget payout card process

POST

https://api.zen.com/v3/customers/{merchantCustomerId}/payouts/card/widget-init

customers

Request

Path Params

merchantCustomerId

string

required

An unique customer external identifier

>= 1 characters<= 128 characters

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

isSingleUse

boolean

required

Example

{
    "isSingleUse": true
}

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/card/widget-init' \
--header 'request-id;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "isSingleUse": true
}'

Responses

🟢200OK

application/json

Body

processId

string <uuid>

required

Example

{
    "processId": "9e0ad09b-5150-48c0-aded-707587048fd9"
}

🟠404Not Found

Modified at 2025-01-15 13:21:34

Fetch saved merchant customer's payout card V3

Update merchant payout card alias