API Reference
Go to zen.comGo to myZEN.com
Documentation
  • Sandbox
  • Plugin integration
  • Checkout integration
  • API business
  • Merchant panel
  • Brandbook
  • API transfers
Go to zen.comGo to myZEN.com
Documentation
  • Sandbox
  • Plugin integration
  • Checkout integration
  • API business
  • Merchant panel
  • Brandbook
  • API transfers
  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
    • Add customer payout card
      POST
    • Fetch saved payout card V3
      GET
    • Initialize widget payout card process
      POST
    • Removes customer saved payout card V3
      DELETE
    • Fetch saved payout card list V3
      GET
    • Fetch blik paymentTokens list
      GET
    • Remove Blik paymentToken
      DELETE
    • Fetch Blik paymentToken
      GET
    • Add paynow recipient
      POST
    • Remove paynow profile
      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
    • Update merchant payout card alias
      PATCH
    • Removes merchant customer payout card.
      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

Add paynow recipient

POST
https://api.zen.com/v3/customers/{merchantCustomerId}/withdrawals/paynow
Adds customer's paynow recipient. It is possible to add wallet supported by ZEN only (not supported wallets will be not visible). It is possible to add one recipient at a time.

Request

Path Params

Header Params

Body Params application/json

Example
{
    "verificationStatus": "string",
    "verificationDate": "string",
    "status": "verified",
    "name": "string",
    "entityType": "individual",
    "currency": "str",
    "proxyType": "mobile_number",
    "proxyValue": "string"
}

Request Code 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 POST 'https://api.zen.com/v3/customers//withdrawals/paynow' \
--header 'request-id;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "verificationStatus": "string",
    "verificationDate": "string",
    "status": "verified",
    "name": "string",
    "entityType": "individual",
    "currency": "str",
    "proxyType": "mobile_number",
    "proxyValue": "string"
}'

Responses

🟢200OK
application/json
Body

Example
{
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "merchantId": "string",
    "shopId": "string",
    "terminalId": "string",
    "customerId": "87d8e330-2878-4742-a86f-dbbb3bf522ac",
    "transactionType": "string",
    "externalId": "string",
    "name": "string",
    "currency": "str",
    "verificationStatus": "string",
    "verificationDate": "string",
    "status": "verified",
    "entityType": "individual",
    "proxyType": "mobile_number",
    "proxyValue": "string",
    "tenantId": "101",
    "createdAt": "2019-08-24T14:15:22Z",
    "updatedAt": "2019-08-24T14:15:22Z",
    "deletedAt": "string"
}
🟠404Not Found
Modified at 2025-01-15 13:21:34
Previous
Fetch Blik paymentToken
Next
Remove paynow profile