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

Update customer details recipient

PATCH
https://api.zen.com/v3/customers/{merchantCustomerId}/withdrawals/dragon/{id}
customers
Updates customer's cryptocurrency recipient (one customer each time). It is possible to update wallets supported by ZEN only. Customer has to initiate the cryptocurrency recipient updating process. It is possible to update: wallet address, wallet currency and wallet alias.

Request

Path Params
merchantCustomerId
string <uuid>
required
An unique customer external identifier
Example:
3fa85f64-5717-4562-b3fc-2c963f66afa6
id
string <uuid>
required
An unique 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
merchantId
string 
optional
>= 1 characters<= 32 characters
customerId
string <uuid>
optional
>= 1 characters<= 64 characters
firstTransactionId
string <uuid>
optional
walletAddress
string 
required
>= 1 characters<= 512 characters
walletCurrency
string 
required
>= 1 characters<= 16 characters
walletAlias
string  | null 
required
>= 1 characters<= 128 characters
verificationStatus
string  | null 
optional
<= 32 characters
verificationDate
string  | null 
optional
walletAddressMemo
string  | null 
optional
>= 4 characters<= 1024 characters
Match pattern:
^[0-9]*$
status
enum<string>  | enum<null> 
optional
<= 32 characters
Allowed values:
verifiedunverifiedexpiredinvalidpending
travelRuleData
optional
One of
Travel rule data for individual profile
entityType
enum<string> 
required
Allowed value:
individual
vaspName
string 
required
<= 255 characters
firstName
string 
required
<= 255 characters
lastName
string 
required
<= 255 characters
address
string 
required
<= 255 characters
dateOfBirth
string <date>
required
Example
{
    "merchantId": "string",
    "customerId": "87d8e330-2878-4742-a86f-dbbb3bf522ac",
    "firstTransactionId": "03056aca-c5f2-4f6b-a174-27e4af663155",
    "walletAddress": "string",
    "walletCurrency": "string",
    "walletAlias": "string",
    "verificationStatus": "string",
    "verificationDate": "string",
    "walletAddressMemo": "string",
    "status": "verified",
    "travelRuleData": {
        "entityType": "individual",
        "vaspName": "string",
        "firstName": "string",
        "lastName": "string",
        "address": "string",
        "dateOfBirth": "2019-08-24"
    }
}

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 PATCH 'https://api.zen.com/v3/customers//withdrawals/dragon/' \
--header 'request-id;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "merchantId": "string",
    "customerId": "87d8e330-2878-4742-a86f-dbbb3bf522ac",
    "firstTransactionId": "03056aca-c5f2-4f6b-a174-27e4af663155",
    "walletAddress": "string",
    "walletCurrency": "string",
    "walletAlias": "string",
    "verificationStatus": "string",
    "verificationDate": "string",
    "walletAddressMemo": "string",
    "status": "verified",
    "travelRuleData": {
        "entityType": "individual",
        "vaspName": "string",
        "firstName": "string",
        "lastName": "string",
        "address": "string",
        "dateOfBirth": "2019-08-24"
    }
}'

Responses

🟢200OK
application/json
OK
Body
id
string <uuid>
required
customerId
string <uuid>
required
>= 1 characters<= 64 characters
transactionType
string 
required
<= 16 characters
firstTransactionId
string <uuid>
optional
walletAddress
string 
required
>= 1 characters<= 512 characters
walletCurrency
string 
required
>= 1 characters<= 16 characters
walletAlias
string 
required
>= 1 characters<= 128 characters
verificationStatus
string 
optional
<= 32 characters
verificationDate
string 
optional
walletAddressMemo
string 
optional
>= 4 characters<= 1024 characters
status
enum<string> 
required
<= 32 characters
Allowed values:
verifiedunverifiedexpiredinvalidpending
createdAt
string <date-time>
required
Example
{
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "customerId": "87d8e330-2878-4742-a86f-dbbb3bf522ac",
    "transactionType": "string",
    "firstTransactionId": "03056aca-c5f2-4f6b-a174-27e4af663155",
    "walletAddress": "string",
    "walletCurrency": "string",
    "walletAlias": "string",
    "verificationStatus": "string",
    "verificationDate": "string",
    "walletAddressMemo": "string",
    "status": "verified",
    "createdAt": "2019-08-24T14:15:22Z"
}
🟠404Record Not Found
Modified at 2025-07-10 11:28:41
Previous
Fetch customer recipient
Next
Remove customer recipient