API Reference
Go to zen.comGo to myZEN.com
Documentation
Documentation
  • Sandbox
  • Plugin integration
  • Checkout integration
  • API business
  • Merchant panel
  • Brandbook
  • API transfers
Go to zen.comGo to myZEN.com
Documentation
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
  • Schemas
    • Schemas
      • Cardpayouts
      • Healthcheck
      • MetaVersionOutput
      • Meta
      • paymentChannel
      • transaction status
      • merchantTransactionId
      • terminalId
      • transactionType
      • cryptoCurrency
      • destinationCurrency
      • destinationAddress
      • comment
      • customIpnUrl
      • returnUrl
      • itemsUrl
      • redirectUrl
      • imageUrl
      • cardToken
      • locale
      • expiryDate
      • cardNumber
      • cardHolderName
      • cvv
      • paymentCustomOptions
      • payoutCustomOptions
      • detailed information about customer for payout
      • topupCustomOptions
      • amount
      • currency
      • lastOnly
      • lastOnlyParam
      • segment
      • Transaction fee
      • uuid
      • status
      • transactionId
      • returnVerifyUrl
      • saveCard
      • descriptor
      • Combined payment methods information
      • btcAmount
      • request-id
      • terminal-id
      • tenant-id
      • extended
      • customer-id
      • client-id
      • itemsPerPage
      • page
      • direction
      • sortBy
      • subscriptionSortBy
      • external-customer-id
      • payoutBtcAddress
      • feeOwner
      • RedirectMerchantAction
      • FingerprintMerchantAction
      • ImageMerchantAction
      • MerchantAction
      • Card operation output
      • FraudData
      • CardAdd
      • CardOneclick
      • Information object
      • Currency pairs information object
      • Method Information Object
      • Payment methods
      • Calculated fee
      • TopupMethod
      • Customer
      • ExternalCustomer
      • TopupCustomer
      • External details about transaction
      • Details about transaction
      • Details about refund transaction
      • PCL_CARDOneClick
      • PCL_CARDExternalPaymentToken
      • PCL_CARDUnscheduled
      • PCL_CARDRecurringToken
      • PCL_CARDRecurringFullData
      • PCL_CARDOneTime
      • PCL_CARDAuthCheck
      • PCL_CARDAuthCheckToken
      • PCL_HOSTED_CARD
      • PCL_GENERAL_PAYMENT
      • PCL_TRUSTLY
      • PCL_G2APAY
      • PCL_BITBAY_WITHDRAWAL
      • PCL_DRAGON
      • PCL_DRAGON_V2
      • PCL_BLIK
      • PCL_DRAGON_CAPTURE
      • PCL_DRAGON_USER_CAPTURE
      • PCL_G2APAY_TOPUP
      • PCL_DRAGON_USER
      • PCL_WEBMONEY_USER
      • itemsName
      • itemsAmount
      • TransactionItems
      • Card
      • Card Delete Output
      • Dragon Delete Output
      • Webmoney Delete Output
      • Dragon
      • Dragon
      • Product
      • Customer
      • Plan
      • Subscription
      • Webmoney
      • ThreeDsData
      • ThreeDsDataPA
      • CashbackInput
      • CashbackOutput
      • CashbackItem
      • CashbackItemType
    • RequestBodies
      • Calculate fee
      • Action refund object
      • Action topup refund object
      • Action cancel object
      • Action cancel user payout object
      • Action Renew Authorization object
      • Action renew object
      • Action renew user payout object
      • Action capture object
      • Action capture payment object
      • Action capture user payout object
      • Action payout fee
      • Action external fee
      • Action topup fee
      • UpdateCard
      • UpdateDragon
      • UpdateWebmoney
      • UpdateCustomer
      • NewDragon
      • SaveProduct
      • UpdateProduct
      • SavePlan
      • CancelSubscription
      • NewWebmoney
      • Action create payout object
      • Action create user payout object
      • Action create external sendout
Go to zen.comGo to myZEN.com
Documentation
Documentation
  • Sandbox
  • Plugin integration
  • Checkout integration
  • API business
  • Merchant panel
  • Brandbook
  • API transfers
Go to zen.comGo to myZEN.com
Documentation
Documentation
  • Sandbox
  • Plugin integration
  • Checkout integration
  • API business
  • Merchant panel
  • Brandbook
  • API transfers
  1. customers

Add payout card

POST
https://api.zen.com/v2/payout-profiles/card
Payout Profiles

Request

Header Params

Body Params application/jsonRequired

Example
{
    "card": {
        "number": 4111111111111111,
        "expiryDate": "0620",
        "cvv": 123
    },
    "recipientFirstName": "string",
    "recipientLastName": "string",
    "cardAlias": "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/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

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
Modified at 2025-11-10 07:13:37
Previous
Add customer recipient
Next
Remove payout card