Calculate authorization amount

POST/v1/authorization/calculate

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]+$

merchantTransactionId

string

required

amount

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]+)+$

optional

Any of

string<ipv4>

string<ipv6>

<= 15 characters

Example:

127.0.0.1

data

array [object {5}]

required

paymentMethod

string

required

Payment method name from dictionary PME_PAYMENT_METHOD

Example:

PME_CARD

paymentChannel

string

required

Payment method channel name from dictionary PCL_PAYMENT_CHANNEL

Example:

PCL_CARD

cardOrganization

string

optional

Organization name from dictionary COR_VISA (Required if paymentChannel = PCL_CARD)

Example:

COR_VISA

cardBin

string

optional

Match pattern:

^[0-9]{6,11}$

cardId

string <uuid>

optional

{
  "merchantTransactionId": "string",
  "amount": "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

Responses

OK(200)

Not Found(404)

HTTP Code: 200

Content Type : JSONapplication/json

array of:

paymentMethod

string

required

maxFee

string

required

channels

array [object {3}]

required

paymentChannel

string

required

cardOrganizations

array [object {2}]

optional

authorization

object

optional

[
  {
    "paymentMethod": "string",
    "maxFee": "string",
    "channels": [
      {
        "paymentChannel": "string",
        "cardOrganizations": [
          {
            "organization": "string",
            "authorization": {
              "fee": "string",
              "amount": "string",
              "baseAmount": "string",
              "currency": "string",
              "rate": "string",
              "rateExpireAt": "string"
            }
          }
        ],
        "authorization": {
          "fee": "string",
          "amount": "string",
          "baseAmount": "string",
          "currency": "string",
          "rate": "string",
          "rateExpireAt": "string"
        }
      }
    ]
  }
]

Modified at 10 days ago