Колбэк по заявке на ввод

Метод

POST

URL Запроса

${MERCHANT_CALLBACK_URL}

Headers

Название

Значение

Content-Type

application/json

X-Signature

<Подпись>

Параметры запроса

Название

Формат

Описание

int

Идентификатор транзакции

extId

string(1,255)

Идентификатор транзакции клиента

orderId

string(1,255)

Идентификатор ордера

amount

decimal

Сумма транзакции

currency

string(3,4)

Код валюты ISO 4217 (RUB, UZS и т.д.)

currencyRate

decimal

Курс валюты

type

string(1,255)

Тип транзакции, DEPOSIT или WITHDRAWAL

status

string(1,255)

Статус транзакции (DENIED, SUCCESSFUL)

Пример запроса колбэка для мерчанта Данный пример демонстрирует, какой запрос ваш сервер должен принимать в качестве колбэка.

curl --request POST \
  --url ${MERCHANT_CALLBACK_URL} \
  --header 'Content-Type: application/json' \
  --header 'X-Signature: {{sign}}' \
  -d '{
  "id": 1000,
  "extId": "06bc2b0a-c0ba-4938-b46e-4079d56905b4",
  "amount": 100,
  "currency": "RUB",
  "currencyRate": 100.56,
  "type": "DEPOSIT",
  "status" : "SUCCESSFUL",
  "orderId" : "1816d25d-f164-43e8-b148-060900f859e5"
}'

$client = new \GuzzleHttp\Client();
$response = $client->post('${MERCHANT_CALLBACK_URL}', [
    'headers' => [
        'Content-Type'  => 'application/json',
        'Authorization' => 'Bearer {{your_api_token}}',
        'X-Signature'   => '{{sign}}'
    ],
    'body' => json_encode([
        "id" => 1000,
        "extId" => "06bc2b0a-c0ba-4938-b46e-4079d56905b4",
        "amount" => 100,
        "currency" => "RUB",
        "currencyRate" => 100.56,
        "type" => "DEPOSIT",
        "status" => "DENIED",
        "maxAmountIncrement" => 5,
        "bank" => "СберБанк",
        "callbackUrl" => "https://webhook.site/#!/view/151a4e3c"
    ])
]);

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

Название

Формат

Описание

status

string(1,255)

Статус обработки коллбека (SUCCESS/FAILURE)

error (опционально)

string(1,255)

Сообщение об ошибке в случае неполадок

Код ответа HTTP: 200

Пример успешного ответа:

{
   "status" : "SUCCESS"
}

Примечания:

Понимая, что интернет не всегда обеспечивает стабильную связь и могут возникать временные неполадки с вашей стороны, мы предусмотрели механизм повторных попыток отправки колбэка. В случае, если от вас не поступит успешный ответ, мы будем повторно отправлять вебхук до 10-х раз.

Успешным ответом считается ответ с HTTP статусом 200 и телом сообщения со статусомSUCCESS. Обратите внимание, что это слово должно быть написано только заглавными буквами, без пробелов, кавычек или дополнительных символов.

Внимание!!! Статус SUCCESS подтверждает, что вы получили и успешно обработали информацию, и что нет необходимости повторной отправки данных. Если вы отправите ответ, который не соответствует этому формату, система не сможет его распознать как успешный, что приведет к дополнительным попыткам отправки колбэка и увеличит нагрузку на обе системы.

Настройки в Личном кабинете (ЛК)

Для того чтобы принимать колбэки необходимо настроить конфигурации в личном кабинете.

На панели вкладок выберите "Конфигурация"

Затем можно будет увидеть следующую форму

Заполните необходимые поля Callback Url - это url колбэка для транзакций Callbacks are enabled - включение и отключение отправки колбэков по заданным url

ВНИМАНИЕ!!! Если Callbacks are enabled отключён, то мы не будем отправлять колбэки по заданным url

PreviousОтмена заявки на ввод NextЗаявки на вывод

Last updated 3 months ago

curl --request POST \ --url ${MERCHANT_CALLBACK_URL} \ --header 'Content-Type: application/json' \ --header 'X-Signature: {{sign}}' \ -d '{ "id": 1000, "extId": "06bc2b0a-c0ba-4938-b46e-4079d56905b4", "amount": 100, "currency": "RUB", "currencyRate": 100.56, "type": "DEPOSIT", "status" : "SUCCESSFUL", "orderId" : "1816d25d-f164-43e8-b148-060900f859e5" }'

$client = new \GuzzleHttp\Client(); $response = $client->post('${MERCHANT_CALLBACK_URL}', [ 'headers' => [ 'Content-Type' => 'application/json', 'Authorization' => 'Bearer {{your_api_token}}', 'X-Signature' => '{{sign}}' ], 'body' => json_encode([ "id" => 1000, "extId" => "06bc2b0a-c0ba-4938-b46e-4079d56905b4", "amount" => 100, "currency" => "RUB", "currencyRate" => 100.56, "type" => "DEPOSIT", "status" => "DENIED", "maxAmountIncrement" => 5, "bank" => "СберБанк", "callbackUrl" => "https://webhook.site/#!/view/151a4e3c" ]) ]);