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
    • 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 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
      • Removes customer saved payout card V3
      • Fetch blik paymentTokens list
      • Remove Blik paymentToken
      • Fetch Blik paymentToken
      • 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
    • reports
      • Download report file

    Notifications

    Introduction to integration [Bright].png
    Instant Payment Notifications (IPN) inform you about transaction status updates, e.g., about changing the status from pending to rejected.
    Instant Payment Notification is enabled by default for all merchants within the ZEN.COM payment system and must be used as the primary method for receiving payment status updates.
    ZEN.COM sends you an Instant Payment Notification (IPN) after each transaction.
    IPN with status „ACCEPTED” is confirmation of successful transaction. Once you receive IPN with status „ACCEPTED” you can finalize the order.
    There are two ways to provide the IPN URL address to ZEN.COM:
    1.
    In the Credentials tab in the my.zen.com panel, you can provide the IPN URL address.
    2.
    If you are using the API integration or the Checkout Integration with each request, you can provide customIpnUrl for this request as an optional field. If you leave the field blank, the IPN URL address from pt. 1 will be used.
    To verify whether the IPN is sent by ZEN, you should use the IPN API Secret.
    Modified at 2026-02-26 14:34:49
    Previous
    Transaction statuses
    Next
    Response codes