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
    • 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
      • 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

    Authentication & authorization

    Introduction to integration [Bright].png
    To ensure the highest level of security, ZEN.COM API uses API key to authenticate all requests. All API requests have to be made using the HTTPS protocol and properly authenticated - otherwise, they will be rejected by ZEN.COM.
    Merchants using the my.zen.com application can view and manage API key settings from within the app's panel.
    To get your credentials:
    1.
    Log in to your my.zen.com.
    2.
    Select the Store settings option from the main menu.
    3.
    Go to the Settings page to check your individual Credentials.
    INFO
    For a multiple-Terminal setup, please make sure to select the desired Terminal from the dropdown list.
    Types of Credentials you'll need to integrate with ZEN.COM Payment system:
    NameAPI IntegrationCheckout integrationPlugins integration
    IPN Secretyesnoyes
    Checkout Secretnoyesyes
    Terminal API Keyyesnoyes
    Terminal UUIDnoyesyes
    DANGER
    API keys have special permissions that allow access to certain functionalities or data. It's important to keep them secure because they carry the ability to perform actions or access information that regular users might not have the rights to do.
    We recommend never share your API keys publicly, include them as part of your code, or pass them to unauthorized persons. If you suspect that your API keys have been exposed publicly or have fallen into the wrong hands, please contact ZEN.COM to generate new authentication data.
    Modified at 2025-07-10 11:30:18
    Previous
    Introduction
    Next
    Environments