Руководство АПИ Расчет платежей

Описание методов API Расчета платежей

Способы вызова

Запросы к API выполняются с использованием протокола HTTPS
Для аутентификация пользователя используются следующие методы:

Заголовок Api-Key
Basic-аутентификация.

Результаты выполнения запросов выдаются в формате json в кодировке UTF-8

Запрос параметров расчета

GET /payments/api/payments/code?ondate=&origin_country=&customs_clearance_country=

Пример

/payments/api/payments/2402209000?customs_clearance_country=ru&customs_procedure_mode=%D0%98%D0%9C&origin_country=CN

Пример ответа

{
    "code": "2402209000",
    "ondate": "2022-11-09",
    "origin_country": "CN",
    "customs_clearance_country": "ru",
    "duty": [{
            "hash": "918c88d3ad3f8a5662f3c6851f133ba514393273",
            "hint": "2.00 EUR за 1000 ШТ",
            "units": [{
                    "code": "798",
                    "short_name": "1000 ШТ",
                    "name": "ТЫСЯЧА ШТУК"
                }
            ]
        }
    ],
    "additional_dues": [],
    "excise_dues": [{
            "hint": "2454.00 руб за 1000 ШТ, плюс 16.00% от расчетной стоимости, 
исчисляемой исходя из макс.розничной цены, но не менее 3333.00 руб за 1000 ШТ",
            "hash": "da0c8b156b6adbd9f846a69f6327562ffe76c159",
            "units": [{
                    "code": "798",
                    "short_name": "1000 ШТ",
                    "name": "ТЫСЯЧА ШТУК"
                }, {
                    "code": "r%643",
                    "short_name": "РУБ.",
                    "name": "РАСЧЕТНАЯ СТОИМОСТЬ(РУБ)"
                }
            ],
            "unit": {
                "code": "798",
                "short_name": "1000 ШТ",
                "name": "ТЫСЯЧА ШТУК"
            },
            "description": "сигареты с фильтром, сигареты без фильтра, папиросы"
        }, {
            "hint": "3813.00 руб за 1000 ШТ",
            "hash": "0f22c7123c5c49121af0b4f4fb6e33f609c2b524",
            "units": [{
                    "code": "798",
                    "short_name": "1000 ШТ",
                    "name": "ТЫСЯЧА ШТУК"
                }
            ],
            "unit": {
                "code": "798",
                "short_name": "1000 ШТ",
                "name": "ТЫСЯЧА ШТУК"
            },
            "description": "сигариллы (сигариты), биди, кретек"
        }, {
            "hint": "7538.00 руб за КГ",
            "hash": "07f264ed289e0106036d83e326ae6be424f907d7",
            "units": [{
                    "code": "166",
                    "short_name": "КГ",
                    "name": "КИЛОГРАММ"
                }
            ],
            "unit": {
                "code": "166",
                "short_name": "КГ",
                "name": "КИЛОГРАММ"
            },
            "description": "табак (табачные изделия), предназначенные для потребления путем нагревания"
        }
    ],
    "vat": [{
            "hash": "de7382a51fd38729e6645dc47e59012d2fd0343a",
            "hint": "20.00%",
            "description": "",
            "link": null
        }
    ],
    "pref": null,
    "export_duty": null,
    "customs_procedure_mode": "ИМ"
}

Расчет платежей

POST /payments/api/payments/calc

В массив единиц измерения обязательно передавать те единицы измерения, которые указаны в выбранных строках вариантах платежей.
В примере это штуки и 1000 шт.
Первоначально массив курсов валют передается пустым. В дальнейшем формируется на стороне сервера и при повторном вызове передаются обратно на сервер. (при использовании в расчетах откорректированных курсов валют, перед запросом необходимо установить параметр “признак редактирования курсов валют” в true)

Пример POST /payments/payments/api/payments/calc

{
    "goods_cost": "1000",
    "goods_cost_currency_code": "USD",
    "is_ed": true,
    "code": "2402209000",
    "origin_country": "CN",
    "customs_clearance_country": "ru",
    "is_currency_edit": false,
    "is_pref": true,
    "pref": null,
    "customs_procedure_mode": "ИМ",
    "currency_infos": [{
            "value": 60.9774,
            "name": "USD",
            "code": "840",
            "nominal": 1
        }, {
            "value": 60.8231,
            "name": "EUR",
            "code": "978",
            "nominal": 1
        }
    ],
    "duty_hash": "918c88d3ad3f8a5662f3c6851f133ba514393273",
    "additional_dues_hash": null,
    "vat_hash": "de7382a51fd38729e6645dc47e59012d2fd0343a",
    "excise_hash": "da0c8b156b6adbd9f846a69f6327562ffe76c159",
    "export_duty_hash": null,
    "units": [{
            "code": "798",
            "value": "1"
        }, {
            "code": "r%643",
            "value": "1"
        }
    ]
}

Ответ

{
    "goods_cost": 1000.0,
    "goods_cost_currency_code": "USD",
    "is_ed": true,
    "code": "2402209000",
    "ondate": "2022-11-09",
    "origin_country": "CN",
    "customs_clearance_country": "ru",
    "duty_hash": "918c88d3ad3f8a5662f3c6851f133ba514393273",
    "additional_dues_hash": null,
    "vat_hash": "de7382a51fd38729e6645dc47e59012d2fd0343a",
    "excise_hash": "da0c8b156b6adbd9f846a69f6327562ffe76c159",
    "units": [{
            "code": "798",
            "value": "1"
        }, {
            "code": "r%643",
            "value": "1"
        }
    ],
    "duty_desc": [{
            "type": "customs_duty",
            "name": "Таможенный сбор",
            "basis": 60977.4,
            "rate": "",
            "sum": 775.0
        }, {
            "type": "duty",
            "name": "Импортная пошлина",
            "basis": 1.0,
            "rate": "2.00 EUR за 1000 ШТ",
            "sum": 121.65
        }, {
            "type": "excise",
            "name": "Акциз",
            "basis": 1.0,
            "rate": "2454.00 руб за 1000 ШТ, плюс 16.00% от расчетной стоимости, 
исчисляемой исходя из макс.розничной цены, но не менее 3333.00 руб за 1000 ШТ",
            "sum": 3333.0
        }, {
            "type": "vat",
            "name": "НДС",
            "basis": 64432.05,
            "rate": 20.0,
            "sum": 12886.41
        }
    ],
    "currency_infos": [{
            "value": 60.9774,
            "name": "USD",
            "code": "840",
            "nominal": 1
        }, {
            "value": 60.8231,
            "name": "EUR",
            "code": "978",
            "nominal": 1
        }
    ],
    "is_currency_edit": false,
    "customs_procedure_mode": "ИМ",
    "export_duty_hash": null,
    "pref": null,
    "is_pref": true,
    "customs_payment": 17116.06,
    "currency_date": "2022-11-09",
    "goods_cost_rur": 60977.4
}



Пример (ЭК):
POST https://api.qborder.ru/payments/api/payments/calc
{
    additional_dues_hash: null
    code: "4407119300"
    currency_infos:[ 
        {value: 71.6797, name: "USD", code: "840", nominal: 1}
        {value: 87.3274, name: "EUR", code: "978", nominal: 1}
    ],
    customs_clearance_country: "ru"
    customs_procedure_mode: "ЭК"
    duty_hash: null
    excise_hash: null
    export_duty_hash: "17e923111660b7fa46a930fe9fa475e089680dd2"
    goods_cost: "1000"
    goods_cost_currency_code: "USD"
    is_currency_edit: false
    is_ed: true
    ondate: "2021-07-01"
    origin_country: "CN"
    units: [
        {
            code: "113", 
            value: "1"
        }
    ]
    vat_hash: null
}
Ответ:
{
    "goods_cost":1000.0,
    "goods_cost_currency_code":"USD",
    "is_ed":true,"code":"4407119300",
    "ondate":"2021-07-01",
    "origin_country":"CN",
    "customs_clearance_country":"ru",
    "duty_hash":null,
    "additional_dues_hash":null,
    "vat_hash":null,
    "excise_hash":null,
    "units":[
        {
            "code":"113",
            "value":"1"
        }
    ],
    "currency_infos":[
        {
            "value":71.6797,
            "name":"USD","code":
            "840","nominal":1
        },
        {
            "value":87.3274,
            "name":"EUR",
            "code":"978",
            "nominal":1
        }
    ],
    "is_currency_edit":false,
    "customs_procedure_mode":"ЭК",
    "export_duty_hash":"17e923111660b7fa46a930fe9fa475e089680dd2",
    "customs_payment":7942.97,
    "duty_desc":[
        {
            "type":"customs_duty",
            "name":"Таможенный сбор",
            "basis":71679.7,
            "rate":"",
            "sum":775.0
        },
        {
            "type":"duty",
            "name":"Экспортная пошлина",
            "basis":71679.7,
            "rate":"10.00%, но не менее 13.00EUR за М3",
            "sum":7167.97
        }
    ],
    "currency_date":"2021-06-12",
    "goods_cost_rur":71679.7
}