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
  1. authorization
  • 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
      POST
    • Calculate reversed authorization amount
      POST
  • 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. authorization

Calculate reversed authorization amount

POST
https://api.zen.com/v1/authorization/calculate/reversed
authorization
Authorization parameter is used in a couple of processes in ZEN. In this case for authorization fee process (allows to charging of transaction costs to the customer) and DCC (dynamic currency change) process.
To use authorizationfee parameter Merchant has to have feature activated. Then, it is possible to display the commission amount on the checkout, which will be charged to the customer for processing the transaction. The amount charged to the customer (added to the base transaction amount) will be returned to the Merchant. The parameter authorizationfee does not exclude charging the fee to the Merchant for processing the transaction.
It is possible to set authorizationfee parameter for one, some or all payment channels.

Request

Header Params
request-id
string 
required
A unique identifier generated by requesting client
>= 38 characters<= 1024 characters
Example:
|us04oqdnzFQVr0rITD9/c9OvDRE2sXVfwerv.
Match pattern:
^[a-zA-Z0-9?&:_|\-\/=+.,#\s]+$
Body Params application/json
optional
One of
sessionId
string 
required
<= 128 characters
authorizationAmount
string 
required
currency
string 
required
authorizationCurrency
string 
required
transactionType
string 
optional
Transaction types
Default:
TRT_PURCHASE
Example:
TRT_PURCHASE
Match pattern:
^TRT(_[A-Z0-9]+)+$
ip
optional
data
array [object {5}] 
required
Example
{
    "sessionId": "string",
    "authorizationAmount": "string",
    "currency": "string",
    "authorizationCurrency": "string",
    "transactionType": "TRT_PURCHASE",
    "ip": "127.0.0.1",
    "data": [
        {
            "paymentMethod": "PME_CARD",
            "paymentChannel": "PCL_CARD",
            "cardOrganization": "COR_VISA",
            "cardBin": "string",
            "cardId": "f16ba382-eb42-481a-b08f-c57bdc9aae24"
        }
    ]
}

Request 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/authorization/calculate/reversed' \
--header 'request-id;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "sessionId": "string",
    "authorizationAmount": "string",
    "currency": "string",
    "authorizationCurrency": "string",
    "transactionType": "TRT_PURCHASE",
    "ip": "127.0.0.1",
    "data": [
        {
            "paymentMethod": "PME_CARD",
            "paymentChannel": "PCL_CARD",
            "cardOrganization": "COR_VISA",
            "cardBin": "string",
            "cardId": "f16ba382-eb42-481a-b08f-c57bdc9aae24"
        }
    ]
}'

Responses

🟢200OK
application/json
OK
Body
sessionId
string 
optional
merchantTransactionId
string 
optional
data
array [object {3}] 
required
paymentMethod
string 
required
maxFee
string 
required
channels
array [object {5}] 
required
Example
{
    "sessionId": "string",
    "merchantTransactionId": "string",
    "data": [
        {
            "paymentMethod": "string",
            "maxFee": "string",
            "channels": [
                {
                    "paymentChannel": "string",
                    "cardOrganizations": [
                        {
                            "cardId": "string",
                            "amount": "string",
                            "currency": "string",
                            "organization": "string",
                            "authorization": {
                                "fee": "string",
                                "amount": "string",
                                "baseAmount": "string",
                                "currency": "string",
                                "rate": "string",
                                "rateExpireAt": "string"
                            }
                        }
                    ],
                    "amount": "string",
                    "currency": "string",
                    "authorization": {
                        "fee": "string",
                        "amount": "string",
                        "baseAmount": "string",
                        "currency": "string",
                        "rate": "string",
                        "rateExpireAt": "string"
                    }
                }
            ]
        }
    ]
}
🟠404Record Not Found
Modified at 2025-07-10 11:28:41
Previous
Calculate authorization amount
Next
Fetch subscription products list