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. payout
  • 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
      POST
    • Transaction details using ZEN id
      GET
    • Transaction details using merchantTransactionId
      GET
    • Capture transaction
      POST
    • Cancel transaction
      POST
    • Renew transaction
      POST
    • Transaction details using ZEN id
      GET
    • Refresh transaction offers
      POST
    • Select transaction offer
      POST
  • 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
    • Remove customer
    • Add customer recipient
    • Add payout card
    • Remove payout card
    • Fetch payout card list
    • Update payout card details
    • Fetch saved subscription customer list V3
    • Fetch customer
    • Update a customer
    • Fetch card
    • Update card details
    • Remove card
    • Fetch card list
    • Fetch customer recipient list
    • Fetch customer recipient
    • Update customer details recipient
    • Remove customer recipient
    • Fetch saved merchant customer payout recipient list V3
    • Verify merchant's customer payout recipient card
    • Fetch saved merchant customer's payout card V3
    • Initialize widget payout card process
    • Update merchant payout card alias
    • Fetch saved payout card list V3
    • Removes merchant customer payout card.
    • Add customer payout card
    • Fetch saved payout card V3
    • Removes customer saved payout card V3
    • Add paynow recipient
    • Remove paynow profile
  • 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. payout

Transaction details using ZEN id

GET
https://api.zen.com/v1/payouts/{id}/offers
payout
Allows to get payout details using ZEN ID. Only one created payout can be get each time. It can be fetch all payout data including: ID, parent transaction ID, URL, amount, currency, customers, fees, authorization amount, status and many more.

Request

Path Params
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]+$

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/v1/payouts//offers' \
--header 'request-id;'

Responses

🟢200OK
application/json
OK
Body
array of:
pspId
string 
required
pspName
string 
required
pspLogo
string 
required
status
enum<string> 
required
Allowed values:
PENDINGEXPIREDREJECTEDACTIVESELECTED
termsUrl
string <uri>
required
termsUuid
string <uuid>
required
lastAttempt
object 
optional
attemptId
string <uuid>
required
attemptNo
number 
required
expirationDate
string <date-time>
required
pspData
object 
optional
Example
[
    {
        "pspId": "string",
        "pspName": "string",
        "pspLogo": "string",
        "status": "PENDING",
        "termsUrl": "http://example.com",
        "termsUuid": "ba53c8e9-f7fe-4655-b9d1-4dfe0565a908",
        "lastAttempt": {
            "attemptId": "ff88f33b-bb8d-4c28-947a-07ff3d628b10",
            "attemptNo": 0,
            "expirationDate": "2019-08-24T14:15:22Z",
            "pspData": {}
        }
    }
]
🟠404Record Not Found
Modified at 2025-07-10 11:28:41
Previous
Renew transaction
Next
Refresh transaction offers