ZEN API documentation
Go to zen.comGo to myZEN.com
Documentation
  • Plugin integration
  • Checkout integration
  • API reference
  • Merchant panel
  • Brandbook
Go to zen.comGo to myZEN.com
Documentation
  • Plugin integration
  • Checkout integration
  • API reference
  • Merchant panel
  • Brandbook
  1. Integration
  • About ZEN
    • First steps with ZEN
    • Who we are
    • What we provide
    • How we provide
  • Introduction
    • Definitions
    • About API integration
    • Revenue strams
    • Environments
    • Authorization & Authentication
    • Payment methods
    • Payment process
    • Currencies
    • Languages
  • Account registration & configuration
    • Before you begin
    • Registration
    • Configuration
    • Merchant's panel
    • Payments setup
    • Locating Transactions in my.zen.com
    • Finding settlements
  • Features
    • Available features
    • 3-Domain Secure (3DS)
    • Account Funding Transactions (AFT)
    • Address Verification Service
    • Authorization fee
    • Card widget
    • Cashback
    • Currency Conversion Service
    • Fraud collector (fingerPrintId)
    • Instant Payment Notification (IPN)
    • Payment Link
    • Shop logo on ZEN.COM checkout
    • Reports
  • Integration
    • Response codes
    • Error codes
    • Prepare the communication
    • Available Payment methods
    • Purchase Transaction
    • Refund Transaction
    • Payout Transaction
    • Transaction status check
    • Saving and tokenizing cards
    • One-click card Payments
    • One-click Google Pay Payments
    • One-click Apple Pay Payments
    • Customers and cards management
  1. Integration

Available Payment methods

payment methods.jpg
Access to specific Payment methods and Payment channels depends on the type of Transaction, Transaction amount, Transaction currency, country, type of your subscription in ZEN.COM, and the Merchant's individual conditions.
The https://api.zen.com/v3/terminals endpoint returns all available Payment methods and Payment channels for a specific Terminal configured in ZEN.COM. Using this endpoint, you can also retrieve information about:
the code of the Payment method / channel in ZEN.COM,
the official name of the Payment method / channel,
the currencies available for the given Payment method / channel,
the minimum Transaction value for the Payment method / channel,
the maximum Transaction value for the Payment method / channel,
the active Authorization fee feature,
the active Cashback service,
the last use of the Payment method / channel.
Please note, you may have access to all of the Payment methods listed here, or you may have access to only selected Payment methods.
To get the information about all available Payment channels on particular Terminal using ZEN.COM API:
1
Create a GET request
CAUTION
Request header with Authorization parameter is obliged for all requests sent to ZEN.COM API. Authorization value is the Terminal API key parameter you can find in your my.zen.com Merchant portal.
Create a GET request as shown in Prepare the communication chapter.
CAUTION
Make sure to use all required parameters and objects listed below.
Required parameters:
Query:
FieldTypeDescription
transactionTypestringType of transaction e.g. TRT_PURCHASE, TRT_REFUND. TRT_AUTH is used for recurring.
Header:
FieldTypeDescription
request-idStringA unique identifier generated by requesting Merchant.
💡
Example CURL
https://api.zen.com/v3/terminals?transactionType=TRT_PURCHASE&amount=100.00&currency=EUR&limit=100
2
Send the request
Send the POST request to:
1.
test environment: https://api.zen-test.com/v3/terminals
2.
production environment: https://api.zen.com/v3/terminals
3
Receive the ZEN.COM response
Receive the ZEN.COM response.
💡
Example of JSON response
{
  "meta": {
      "limit": 100,
      "offset": 0,
      "direction": "asc",
      "hasMore": false,
      "currencies": [
          "EUR",
          "AED",
          "AUD",
          "BGN",
          "CAD",
          "CHF",
          "CNY",
          "CZK",
          "DKK",
          "GBP",
          "HKD",
          "HUF",
          "ILS",
          "JPY",
          "KES",
          "MXN",
          "NOK",
          "NZD",
          "PLN",
          "QAR",
          "RON",
          "SAR",
          "SEK",
          "SGD",
          "THB",
          "TRY",
          "UGX",
          "USD",
          "ZAR",
          "ISK"
      ]
  },
  "data": [
      {
          "paymentMethod": "PME_CARD",
          "paymentMethodName": "Card",
          "methodLogoUrl": "https://www.zen.com/hubfs/Assets/CheckoutPME/card.svg",
          "paymentChannels": [
              {
                  "paymentChannel": "PCL_APPLEPAY",
                  "paymentChannelName": "Apple Pay",
                  "currencies": [
                      "AED",
                      "AUD",
                      "BGN",
                      "CAD",
                      "CHF",
                      "CNY",
                      "CZK",
                      "DKK",
                      "EUR",
                      "GBP",
                      "HKD",
                      "HUF",
                      "ILS",
                      "JPY",
                      "KES",
                      "MXN",
                      "NOK",
                      "NZD",
                      "PLN",
                      "QAR",
                      "RON",
                      "SAR",
                      "SEK",
                      "SGD",
                      "THB",
                      "TRY",
                      "UGX",
                      "USD",
                      "ZAR"
                  ],
                  "cryptoCurrencies": [],
                  "cardOrganizations": [],
                  "channelLogoUrl": "https://www.zen.com/hubfs/Assets/CheckoutPME/applepay.svg",
                  "lastUsed": false,
                  "hasAuthorizationFee": false,
                  "hasCashback": false
              }
          ]
      },
      {
          "paymentMethod": "PME_CARD",
          "paymentMethodName": "Card",
          "methodLogoUrl": "https://www.zen.com/hubfs/Assets/CheckoutPME/card.svg",
          "paymentChannels": [
              {
                  "paymentChannel": "PCL_CARD",
                  "paymentChannelName": "Card",
                  "currencies": [
                      "AED",
                      "AUD",
                      "BGN",
                      "CAD",
                      "CHF",
                      "CNY",
                      "CZK",
                      "DKK",
                      "EUR",
                      "GBP",
                      "HKD",
                      "HUF",
                      "ILS",
                      "JPY",
                      "KES",
                      "MXN",
                      "NOK",
                      "NZD",
                      "PLN",
                      "QAR",
                      "RON",
                      "SAR",
                      "SEK",
                      "SGD",
                      "THB",
                      "TRY",
                      "UGX",
                      "USD",
                      "ZAR"
                  ],
                  "cryptoCurrencies": [],
                  "cardOrganizations": [
                      {
                          "organization": "COR_MASTERCARD",
                          "logoUrl": "https://www.zen.com/hubfs/Assets/CheckoutPME/mastercard.svg"
                      },
                      {
                          "organization": "COR_VISA",
                          "logoUrl": "https://www.zen.com/hubfs/Assets/CheckoutPME/Visa.svg"
                      }
                  ],
                  "lastUsed": false,
                  "hasAuthorizationFee": false,
                  "hasCashback": false
              }
          ]
      },
      {
          "paymentMethod": "PME_CARD",
          "paymentMethodName": "Card",
          "methodLogoUrl": "https://www.zen.com/hubfs/Assets/CheckoutPME/card.svg",
          "paymentChannels": [
              {
                  "paymentChannel": "PCL_GOOGLEPAY",
                  "paymentChannelName": "Google Pay",
                  "currencies": [
                      "AED",
                      "AUD",
                      "BGN",
                      "CAD",
                      "CHF",
                      "CNY",
                      "CZK",
                      "DKK",
                      "EUR",
                      "GBP",
                      "HKD",
                      "HUF",
                      "ILS",
                      "JPY",
                      "KES",
                      "MXN",
                      "NOK",
                      "NZD",
                      "PLN",
                      "QAR",
                      "RON",
                      "SAR",
                      "SEK",
                      "SGD",
                      "THB",
                      "TRY",
                      "UGX",
                      "USD",
                      "ZAR"
                  ],
                  "cryptoCurrencies": [],
                  "cardOrganizations": [],
                  "channelLogoUrl": "https://www.zen.com/hubfs/Assets/CheckoutPME/Gpay.svg",
                  "lastUsed": false,
                  "hasAuthorizationFee": false,
                  "hasCashback": false
              }
          ]
      },
      {
          "paymentMethod": "PME_BANCONTACT",
          "paymentMethodName": "Bancontact",
          "methodLogoUrl": "https://www.zen.com/hubfs/Assets/CheckoutPME/Bancontact.svg",
          "paymentChannels": [
              {
                  "paymentChannel": "PCL_BANCONTACT",
                  "paymentChannelName": "Bancontact",
                  "currencies": [
                      "EUR"
                  ],
                  "cryptoCurrencies": [],
                  "cardOrganizations": [],
                  "lastUsed": false,
                  "hasAuthorizationFee": false,
                  "hasCashback": false
              }
          ]
      },
      {
          "paymentMethod": "PME_BOACOMPRA",
          "paymentMethodName": "Boacompra",
          "methodLogoUrl": "https://www.zen.com/hubfs/Assets/CheckoutPME/latin%20america.svg",
          "paymentChannels": [
              {
                  "paymentChannel": "PCL_BOACOMPRA_MULTIBANCO",
                  "paymentChannelName": "Boacompra Multibanco",
                  "currencies": [
                      "EUR"
                  ],
                  "cryptoCurrencies": [],
                  "cardOrganizations": [],
                  "channelLogoUrl": "https://www.zen.com/hubfs/Assets/CheckoutPME/multibanco.svg",
                  "lastUsed": false,
                  "hasAuthorizationFee": false,
                  "hasCashback": false
              }
          ]
      },
      {
          "paymentMethod": "PME_DRAGON",
          "paymentMethodName": "Dragon",
          "methodLogoUrl": "https://www.zen.com/hubfs/Assets/CheckoutPME/digitalcurrency.svg",
          "paymentChannels": [
              {
                  "paymentChannel": "PCL_DRAGON",
                  "paymentChannelName": "Dragon",
                  "currencies": [
                      "EUR"
                  ],
                  "cryptoCurrencies": [
                      {
                          "walletCurrency": "BTC",
                          "currencyName": "Bitcoin",
                          "currencyCode": "BTC",
                          "currencyLogoUrl": "https://www.zen.com/hubfs/Assets/Top-up/bitcoin.png",
                          "network": "Bitcoin Network",
                          "networkLogoUrl": "https://www.zen.com/hubfs/Assets/Top-up/bitcoin.png",
                          "networkCode": "ERC20",
                          "minAmount": "100",
                          "maxAmount": "200000"
                      }
                  ],
                  "cardOrganizations": [],
                  "channelLogoUrl": "https://www.zen.com/hubfs/Assets/CheckoutPME/digitalcurrency.svg",
                  "lastUsed": false,
                  "hasAuthorizationFee": false,
                  "hasCashback": false
              }
          ]
      },
      {
          "paymentMethod": "PME_IDEAL",
          "paymentMethodName": "iDeal",
          "methodLogoUrl": "https://www.zen.com/hubfs/Assets/CheckoutPME/iDeal.svg",
          "paymentChannels": [
              {
                  "paymentChannel": "PCL_IDEAL",
                  "paymentChannelName": "iDeal",
                  "currencies": [
                      "EUR"
                  ],
                  "cryptoCurrencies": [],
                  "cardOrganizations": [],
                  "lastUsed": false,
                  "hasAuthorizationFee": false,
                  "hasCashback": false
              }
          ]
      },
      {
          "paymentMethod": "PME_NEOSURF",
          "paymentMethodName": "Neosurf",
          "methodLogoUrl": "https://www.zen.com/hubfs/Assets/CheckoutPME/neosurf.svg",
          "paymentChannels": [
              {
                  "paymentChannel": "PCL_NEOSURF",
                  "paymentChannelName": "Neosurf",
                  "currencies": [
                      "AUD",
                      "BGN",
                      "CAD",
                      "CHF",
                      "CNY",
                      "CZK",
                      "DKK",
                      "EUR",
                      "GBP",
                      "HKD",
                      "ILS",
                      "JPY",
                      "MXN",
                      "NOK",
                      "NZD",
                      "PLN",
                      "RON",
                      "SEK",
                      "SGD",
                      "THB",
                      "ZAR"
                  ],
                  "cryptoCurrencies": [],
                  "cardOrganizations": [],
                  "lastUsed": false,
                  "hasAuthorizationFee": false,
                  "hasCashback": false
              }
          ]
      },
      {
          "paymentMethod": "PME_NETELLER",
          "paymentMethodName": "Neteller",
          "methodLogoUrl": "https://www.zen.com/hubfs/Assets/CheckoutPME/neteller.svg",
          "paymentChannels": [
              {
                  "paymentChannel": "PCL_NETELLER_WALLET",
                  "paymentChannelName": "Neteller Wallet",
                  "currencies": [
                      "EUR"
                  ],
                  "cryptoCurrencies": [],
                  "cardOrganizations": [],
                  "lastUsed": false,
                  "hasAuthorizationFee": false,
                  "hasCashback": false
              }
          ]
      },
      {
          "paymentMethod": "PME_PBL_EE",
          "paymentMethodName": "Pay By Link Estonia",
          "methodLogoUrl": "https://www.zen.com/hubfs/Assets/CheckoutPME/bank.svg",
          "paymentChannels": [
              {
                  "paymentChannel": "PCL_PBL_CITADELE_EE",
                  "paymentChannelName": "AS Citadele Banka Estonia",
                  "currencies": [
                      "EUR"
                  ],
                  "cryptoCurrencies": [],
                  "cardOrganizations": [],
                  "channelLogoUrl": "https://www.zen.com/hubfs/Assets/CheckoutPME/PCL_PBL_CITADELE.svg",
                  "lastUsed": false,
                  "hasAuthorizationFee": false,
                  "hasCashback": false
              },
              {
                  "paymentChannel": "PCL_PBL_COOP_EE",
                  "paymentChannelName": "AS Coop Bank Estonia",
                  "currencies": [
                      "EUR"
                  ],
                  "cryptoCurrencies": [],
                  "cardOrganizations": [],
                  "channelLogoUrl": "https://www.zen.com/hubfs/Assets/CheckoutPME/PCL_PBL_COOP.svg",
                  "lastUsed": false,
                  "hasAuthorizationFee": false,
                  "hasCashback": false
              },
              {
                  "paymentChannel": "PCL_PBL_LHV_EE",
                  "paymentChannelName": "AS LHV Pank Estonia",
                  "currencies": [
                      "EUR"
                  ],
                  "cryptoCurrencies": [],
                  "cardOrganizations": [],
                  "channelLogoUrl": "https://www.zen.com/hubfs/Assets/CheckoutPME/PCL_PBL_LHV.svg",
                  "lastUsed": false,
                  "hasAuthorizationFee": false,
                  "hasCashback": false
              },
              {
                  "paymentChannel": "PCL_PBL_N26_EE",
                  "paymentChannelName": "N26 Bank Estonia",
                  "currencies": [
                      "EUR"
                  ],
                  "cryptoCurrencies": [],
                  "cardOrganizations": [],
                  "channelLogoUrl": "https://www.zen.com/hubfs/Assets/CheckoutPME/PCL_PBL_N26.svg",
                  "lastUsed": false,
                  "hasAuthorizationFee": false,
                  "hasCashback": false
              },
              {
                  "paymentChannel": "PCL_PBL_NORDEA_EE",
                  "paymentChannelName": "AB Nordea bank Estonia",
                  "currencies": [
                      "EUR"
                  ],
                  "cryptoCurrencies": [],
                  "cardOrganizations": [],
                  "channelLogoUrl": "https://www.zen.com/hubfs/Assets/CheckoutPME/PCL_PBL_NORDEA.svg",
                  "lastUsed": false,
                  "hasAuthorizationFee": false,
                  "hasCashback": false
              },
              {
                  "paymentChannel": "PCL_PBL_SEB_EE",
                  "paymentChannelName": "AB SEB bank Estonia",
                  "currencies": [
                      "EUR"
                  ],
                  "cryptoCurrencies": [],
                  "cardOrganizations": [],
                  "channelLogoUrl": "https://www.zen.com/hubfs/Assets/CheckoutPME/PCL_PBL_SEB.svg",
                  "lastUsed": false,
                  "hasAuthorizationFee": false,
                  "hasCashback": false
              },
              {
                  "paymentChannel": "PCL_PBL_SWEDBANK_EE",
                  "paymentChannelName": "Swedbank Estonia",
                  "currencies": [
                      "EUR"
                  ],
                  "cryptoCurrencies": [],
                  "cardOrganizations": [],
                  "channelLogoUrl": "https://www.zen.com/hubfs/Assets/CheckoutPME/PCL_PBL_SWEDBANK.svg",
                  "lastUsed": false,
                  "hasAuthorizationFee": false,
                  "hasCashback": false
              }
          ]
      },
      {
          "paymentMethod": "PME_PBZ",
          "paymentMethodName": "Pay By ZEN",
          "methodLogoUrl": "https://www.zen.com/hubfs/Assets/CheckoutPME/paybyzen.svg",
          "paymentChannels": [
              {
                  "paymentChannel": "PCL_PBZ",
                  "paymentChannelName": "PayByZEN",
                  "currencies": [
                      "USD",
                      "GBP",
                      "EUR",
                      "PLN"
                  ],
                  "cryptoCurrencies": [],
                  "cardOrganizations": [],
                  "lastUsed": false,
                  "hasAuthorizationFee": false,
                  "hasCashback": false
              }
          ]
      },
      {
          "paymentMethod": "PME_SKRILL",
          "paymentMethodName": "Skrill",
          "methodLogoUrl": "https://www.zen.com/hubfs/Assets/CheckoutPME/skrill.svg",
          "paymentChannels": [
              {
                  "paymentChannel": "PCL_SKRILL_RAPID",
                  "paymentChannelName": "Skrill Rapid",
                  "currencies": [
                      "EUR"
                  ],
                  "cryptoCurrencies": [],
                  "cardOrganizations": [],
                  "channelLogoUrl": "https://www.zen.com/hubfs/Assets/CheckoutPME/rapid_skrill.svg",
                  "lastUsed": false,
                  "hasAuthorizationFee": false,
                  "hasCashback": false
              },
              {
                  "paymentChannel": "PCL_SKRILL_WALLET",
                  "paymentChannelName": "Skrill Wallet",
                  "currencies": [
                      "EUR"
                  ],
                  "cryptoCurrencies": [],
                  "cardOrganizations": [],
                  "channelLogoUrl": "https://www.zen.com/hubfs/Assets/CheckoutPME/skrill.svg",
                  "lastUsed": false,
                  "hasAuthorizationFee": false,
                  "hasCashback": false
              }
          ]
      },
      {
          "paymentMethod": "PME_SOFORT",
          "paymentMethodName": "Sofort",
          "methodLogoUrl": "https://www.zen.com/hubfs/Assets/CheckoutPME/sofort.svg",
          "paymentChannels": [
              {
                  "paymentChannel": "PCL_SOFORT",
                  "paymentChannelName": "Sofort",
                  "currencies": [
                      "EUR"
                  ],
                  "cryptoCurrencies": [],
                  "cardOrganizations": [],
                  "channelLogoUrl": "https://www.zen.com/hubfs/Assets/CheckoutPME/sofort.svg",
                  "lastUsed": false,
                  "hasAuthorizationFee": false,
                  "hasCashback": false
              }
          ]
      },
      {
          "paymentMethod": "PME_UPI",
          "paymentMethodName": "UnionPay International",
          "methodLogoUrl": "https://www.zen.com/hubfs/Assets/CheckoutPME/UnionPay.svg",
          "paymentChannels": [
              {
                  "paymentChannel": "PCL_UPI",
                  "paymentChannelName": "UnionPay International",
                  "currencies": [
                      "BGN",
                      "CHF",
                      "CZK",
                      "DKK",
                      "EUR",
                      "GBP",
                      "HUF",
                      "ISK",
                      "NOK",
                      "PLN",
                      "RON",
                      "SEK"
                  ],
                  "cryptoCurrencies": [],
                  "cardOrganizations": [],
                  "lastUsed": false,
                  "hasAuthorizationFee": false,
                  "hasCashback": false
              }
          ]
      }
  ]
}
Modified at 2025-01-21 14:13:58
Previous
Prepare the communication
Next
Purchase Transaction