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. payment-links
  • 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
      POST
    • Fetch payment links list
      GET
    • Fetch payment link
      GET
    • Update payment link
      PATCH
  • 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
    • Add customer payout card
    • Fetch saved payout card V3
    • Initialize widget payout card process
    • Removes customer saved payout card V3
    • Fetch saved payout card list V3
    • Fetch blik paymentTokens list
    • Remove Blik paymentToken
    • Fetch Blik paymentToken
    • Add paynow recipient
    • Remove paynow profile
    • Fetch saved merchant customer payout recipient list V3
    • Verify merchant's customer payout recipient card
    • Fetch saved merchant customer's payout card V3
    • Update merchant payout card alias
    • Removes merchant customer payout card.
  • 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. payment-links

Fetch payment links list

GET
https://api.zen.com/v1/payment-links
It enables fetching a list of available PBLs (not all payment methods) where the ID represents a specific PBL from the list previously added by the Merchant.
Fetching the list of available PBLs can be used, for example, to present them on the Merchant's website for the user.

Request

Query Params

Header Params

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 GET 'https://api.zen.com/v1/payment-links' \
--header 'request-id;'

Responses

🟢200OK
application/json
OK
Body

Example
{
    "data": [
        {
            "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
            "url": "http://example.com",
            "amount": {
                "currency": "string",
                "value": 0
            },
            "customer": {
                "firstName": "string",
                "lastName": "string",
                "email": "string"
            },
            "items": [
                {
                    "name": "string",
                    "price": 0,
                    "quantity": 0
                }
            ],
            "merchant": {
                "uuid": "string",
                "shopUuid": "string",
                "terminalUuid": "string",
                "transactionId": "string",
                "terminalId": "string"
            },
            "expirationDate": "2019-08-24T14:15:22Z",
            "status": "string",
            "createdAt": "string",
            "hidden": true
        }
    ],
    "meta": {
        "itemsPerPage": "10",
        "page": "1",
        "direction": "asc",
        "sortBy": "createdAt"
    }
}
Modified at 2025-11-10 07:13:37
Previous
Create payment link
Next
Fetch payment link