API Reference
Go to zen.comGo to myZEN.com
Documentation
  • Plugin integration
  • Checkout integration
  • API business
  • Merchant panel
Brandbook
Go to zen.comGo to myZEN.com
Documentation
  • Plugin integration
  • Checkout integration
  • API business
  • Merchant panel
Brandbook
  1. customers
  • Introduction
  • Authentication & authorization
  • Environments
  • Transaction statuses
  • Notifications
  • Response codes
  • Error codes
  • purchase
    • Create transaction
    • Capture transaction
    • Transaction details using ZEN id
    • Transaction details using merchantTransactionId
    • Cancel transaction
    • Renew authorization
    • Validate ApplePay session
    • Calculate cashback
  • refund
    • Create transaction
  • payout
    • Create transaction
    • Transaction details using ZEN id
    • Transaction details using merchantTransactionId
    • Capture transaction
    • Cancel transaction
    • Renew transaction
    • Transaction details using ZEN id
    • Refresh transaction offers
    • Select transaction offer
  • payment-methods
    • Returns information about payment methods
    • Returns information about payment methods
  • payment-links
    • Create payment link
    • Fetch payment links list
    • Fetch payment link
    • Update payment link
  • customers
    • Create customer
      POST
    • Remove customer
      DELETE
    • Add customer recipient
      POST
    • Add payout card
      POST
    • Remove payout card
      DELETE
    • Fetch payout card list
      GET
    • Update payout card details
      PATCH
    • Fetch saved subscription customer list V3
      GET
    • Fetch customer
      GET
    • Update a customer
      PATCH
    • Fetch card
      GET
    • Update card details
      PATCH
    • Remove card
      DELETE
    • Fetch card list
      GET
    • Fetch customer recipient list
      GET
    • Fetch customer recipient
      GET
    • Update customer details recipient
      PATCH
    • Remove customer recipient
      DELETE
    • Fetch saved merchant customer payout recipient list V3
      GET
    • Verify merchant's customer payout recipient card
      POST
    • Fetch saved merchant customer's payout card V3
      GET
    • Initialize widget payout card process
      POST
    • Update merchant payout card alias
      PATCH
    • Fetch saved payout card list V3
      GET
    • Removes merchant customer payout card.
      DELETE
    • Add customer payout card
      POST
    • Fetch saved payout card V3
      GET
    • Removes customer saved payout card V3
      DELETE
    • Add paynow recipient
      POST
    • Remove paynow profile
      DELETE
  • authorization
    • Calculate authorization amount
    • Calculate reversed authorization amount
  • subscriptions
    • Fetch subscription products list
    • Add new subscription product
    • Fetch subscription product
    • Update subscription product
    • Removes subscription product
    • Fetch subscription plan list
    • Add new subscription plan
    • Fetch subscription plan
    • Removes subscription plan
    • Activate subscription plan
    • Deactivate subscription plan
    • Fetch subscriptions list
    • Fetch subscription
    • Removes subscription
    • Cancel subscription
  • reports
    • Download report file
  1. customers

Fetch saved payout card list V3

GET
https://api.zen.com/v3/customers/{merchantCustomerId}/payouts/card
customers
Fetch saved payout card list of all cards belonging to the customer. It is possible to fetch card list of one customer at a time.

Request

Path Params
merchantCustomerId
string 
required
An unique customer external identifier
>= 1 characters<= 128 characters
Query Params
itemsPerPage
string 
optional
Limit of results
Default:
10
Match pattern:
^[1-9][0-9]*$
page
string 
optional
Page of results
Default:
1
Match pattern:
^[1-9][0-9]*$
direction
enum<string> 
optional
Direction of order
Allowed values:
ascdesc
Default:
asc
sortBy
enum<string> 
optional
column sorting
Allowed value:
createdAt
Default:
createdAt
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]+$

Request samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET 'https://api.zen.com/v3/customers//payouts/card' \
--header 'request-id;'

Responses

🟢200OK
application/json
Body
data
array[object (CustomerPayoutCardOutputV3) {6}] 
required
id
string <uuid>
required
customerId
string <uuid>
optional
<= 64 characters
cardName
string 
optional
<= 128 characters
last4
string 
required
>= 1 characters<= 4 characters
organization
string 
optional
>= 1 characters<= 32 characters
createdAt
string <date-time>
required
meta
object 
Meta
required
itemsPerPage
string 
optional
Default:
10
Match pattern:
^[1-9][0-9]*$
page
string 
optional
Default:
1
Match pattern:
^[1-9][0-9]*$
direction
enum<string> 
optional
Allowed values:
ascdesc
Default:
asc
sortBy
enum<string> 
optional
Allowed value:
createdAt
Default:
createdAt
Example
{
    "data": [
        {
            "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
            "customerId": "87d8e330-2878-4742-a86f-dbbb3bf522ac",
            "cardName": "string",
            "last4": "stri",
            "organization": "string",
            "createdAt": "2019-08-24T14:15:22Z"
        }
    ],
    "meta": {
        "itemsPerPage": "10",
        "page": "1",
        "direction": "asc",
        "sortBy": "createdAt"
    }
}
🟠404Not Found
Modified at 2025-01-15 13:21:34
Previous
Update merchant payout card alias
Next
Removes merchant customer payout card.