Calculate cashback - API Reference

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

amount

string

required

currency

string

required

transactionType

string

optional

Transaction types

Default:

TRT_PURCHASE

Example:

TRT_PURCHASE

Match pattern:

^TRT(_[A-Z0-9]+)+$

data

array [object {3}]

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

Example

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

Request samples

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

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

array of:

paymentMethod

string

required

maxCashback

string

optional

channels

array [object {3}]

required

paymentChannel

string

required

cardOrganizations

array [object {2}]

optional

cashback

object

optional

Example

[
    {
        "paymentMethod": "string",
        "maxCashback": "string",
        "channels": [
            {
                "paymentChannel": "string",
                "cardOrganizations": [
                    {
                        "organization": "string",
                        "cashback": {
                            "amount": "string",
                            "currency": "string"
                        }
                    }
                ],
                "cashback": {
                    "amount": "string",
                    "currency": "string"
                }
            }
        ]
    }
]

🟠404Record Not Found