API Reference
Go to zen.comGo to myZEN.com
Documentation
  • Sandbox
  • Plugin integration
  • Checkout integration
  • API business
  • Merchant panel
  • Brandbook
  • API transfers
Go to zen.comGo to myZEN.com
Documentation
  • Sandbox
  • Plugin integration
  • Checkout integration
  • API business
  • Merchant panel
  • Brandbook
  • API transfers
  1. purchase
  • Introduction
  • Authentication & authorization
  • Environments
  • Transaction statuses
  • Notifications
  • Response codes
  • Error codes
  • purchase
    • Create transaction
      POST
    • Capture transaction
      POST
    • Transaction details using ZEN id
      GET
    • Transaction details using merchantTransactionId
      GET
    • Cancel transaction
      POST
    • Renew authorization
      POST
    • Validate ApplePay session
      POST
    • Calculate cashback
      POST
  • 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
    • Add customer payout card
    • Fetch saved payout card V3
    • Initialize widget payout card process
    • Removes customer saved payout card V3
    • Fetch saved payout card list V3
    • Fetch blik paymentTokens list
    • Remove Blik paymentToken
    • Fetch Blik paymentToken
    • Add paynow recipient
    • Remove paynow profile
    • 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
  • 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
  1. purchase

Calculate cashback

POST
https://api.zen.com/v1/cashback/calculate
Service validates whether cashback should be displayed for the customer in specific transaction on checkout. It determines the amount of cashback also.
The cashback amount is deducted from the Merchant's ZEN account

Request

Header Params

Body Params application/jsonRequired

Example
{
    "amount": "string",
    "currency": "string",
    "transactionType": "TRT_PURCHASE",
    "data": [
        {
            "paymentMethod": "PME_CARD",
            "paymentChannel": "PCL_CARD",
            "cardOrganization": "COR_VISA"
        }
    ]
}

Request Code Samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://api.zen.com/v1/cashback/calculate' \
--header 'request-id;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "amount": "string",
    "currency": "string",
    "transactionType": "TRT_PURCHASE",
    "data": [
        {
            "paymentMethod": "PME_CARD",
            "paymentChannel": "PCL_CARD",
            "cardOrganization": "COR_VISA"
        }
    ]
}'

Responses

🟢200OK
application/json
OK
Body

Example
[
    {
        "paymentMethod": "string",
        "maxCashback": "string",
        "channels": [
            {
                "paymentChannel": "string",
                "cardOrganizations": [
                    {
                        "organization": "string",
                        "cashback": {
                            "amount": "string",
                            "currency": "string"
                        }
                    }
                ],
                "cashback": {
                    "amount": "string",
                    "currency": "string"
                }
            }
        ]
    }
]
🟠404Record Not Found
Modified at 2025-11-10 07:13:37
Previous
Validate ApplePay session
Next
Create transaction