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

    Introduction

    Introduction to integration [Bright].png
    Welcome to the ZEN.COM API reference documentation
    Whether you run an online store, accept payments for goods or services, taxes, or you are a developer of applications that require payment processing - you need payment solutions that meet your expectations. That's exactly what ZEN.COM offers – providing effortless payments.
    We have prepared this documentation organized around REST to convey the most important information allowing for the effective implementation of ZEN.COM payments wherever you need it. Here you will find a detailed set of endpoints, request and response examples, which will significantly facilitate the integration process with our payment solutions. This way, you can easily and quickly create, capture, cancel, and retrieve orders, conduct payouts, and access detailed payment-related reports.
    TIP
    Before starting your development, we recommend reviewing the business documentation of the ZEN.COM API.
    INFO
    At ZEN.COM, two models of integration are available:
    Basic integration with redirection to the ZEN.COM checkout (checkout integration)
    Advanced integration (API reference - this documentation)
    Plugin integration (only for dedicated e-commerce platforms such as Woocommerce, Prestashop, Magento)
    Allowed HTTPs requests:
    POST: To create a resource
    PUT: To update a resource
    GET: To get a resource or a list of resources
    DELETE: To delete a resource
    Modified at 2025-03-05 10:07:41
    Next
    Authentication & authorization