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

    Environments

    Introduction to integration [Bright].png
    ZEN.COM supports both PROD and TEST environments, where:
    https://api.zen.com/... (e.g. https://api.zen.com/v1/transactions) is for PROD environment
    https://api.zen-test.com/... (e.g. https://api.zen-test.com/v1/transactions) if for TEST environment
    Main rules:
    Production environment
    Test environment
    1.
    You need to be fully onboarded to get access to API and Merchant panel
    2.
    Available Payment methods depend on your subscription plan and agreement.
    3.
    All endpoints you will find listed in our API Reference documentation.
    To get access to test Credentials you need to log in to your my.zen.com panel, then select the Store settings and go to Settings page to check your individual Credentials.
    In the control panel you have possibility to track your Transaction, create Refunds, manage you Shop settings etc… You can find there as well Credentials to your Shop / Terminal API.
    Modified at 2025-07-10 11:31:36
    Previous
    Authentication & authorization
    Next
    Transaction statuses