API docs by Redocly

API для интеграции торговцев (1.0.0)

Download OpenAPI specification:Download

payments

Платежи

Состояния платежа

Запрос состояния платежа

Authorizations:
bearerAuth
path Parameters
id
required
string <uuid>
Example: 449128d0-d867-4883-a8c7-e94571ef28e3

ID платежа

Responses

Response samples

Content type
application/json
{
  • "request_id": "ccb1bca3-e607-4114-b9bc-7de74fd01782",
  • "id": "449128d0-d867-4883-a8c7-e94571ef28e3",
  • "shop_order_id": "12345",
  • "description": "string",
  • "created_at": "2020-01-01 00:00:00.999999 +0000 UTC",
  • "expires_at": "2020-01-02 00:00:00.999999 +0000 UTC",
  • "last_operation_type": "refund",
  • "last_operation_status": "decline",
  • "last_operation_error_code": 0,
  • "last_operation_error_code_description": "string",
  • "last_operation_external_transaction_id": "8c2018e3-4b1c-4c44-86a7-79e702ef690f",
  • "last_operation_completed_at": "2020-01-01 00:00:01.999999 +0000 UTC",
  • "authentication_data": {
    },
  • "recurrent_data": {
    },
  • "operations": [
    ]
}

Состояния платежа

Запрос состояния платежа по ID заказа в системе магазина

Authorizations:
bearerAuth
path Parameters
id
required
string <= 64 characters
Example: 12345

ID заказа в системе магазина

Responses

Response samples

Content type
application/json
{
  • "request_id": "ccb1bca3-e607-4114-b9bc-7de74fd01782",
  • "id": "449128d0-d867-4883-a8c7-e94571ef28e3",
  • "shop_order_id": "12345",
  • "description": "string",
  • "created_at": "2020-01-01 00:00:00.999999 +0000 UTC",
  • "expires_at": "2020-01-02 00:00:00.999999 +0000 UTC",
  • "last_operation_type": "refund",
  • "last_operation_status": "decline",
  • "last_operation_error_code": 0,
  • "last_operation_error_code_description": "string",
  • "last_operation_external_transaction_id": "8c2018e3-4b1c-4c44-86a7-79e702ef690f",
  • "last_operation_completed_at": "2020-01-01 00:00:01.999999 +0000 UTC",
  • "authentication_data": {
    },
  • "recurrent_data": {
    },
  • "operations": [
    ]
}

Список комиссий по группам платежных методов

Запрос списка комиссий по группам платежных методов для магазина. В JWT claims должна быть структура amount

Authorizations:
bearerAuthWithAmount

Responses

Response samples

Content type
application/json
{
  • "request_id": "ccb1bca3-e607-4114-b9bc-7de74fd01782",
  • "fees": {
    }
}

Список комиссий карточных платежных методов

Запрос списка комиссий карточных платежных методов для магазина. В JWT claims должна быть структура amount

Authorizations:
bearerAuthWithAmount

Responses

Response samples

Content type
application/json
{
  • "request_id": "ccb1bca3-e607-4114-b9bc-7de74fd01782",
  • "fees": [
    ]
}

Sale. Платеж через Gate

Создание платежа. Одностадийное списание. Синхронный сценарий взаимодействия

Authorizations:
bearerAuthWithAmount
Request Body schema: application/json

В JWT claims должна быть структура amount

shop_order_id
string (shop_order_id) <= 64 characters

ID заказа в системе магазина

required
object (amount)

Сумма

object (payment_method_request_sale)

Обязательно для магазинов, использующих свою форму оплаты для банковских карт. Магазины, передающие данные банковских карт, должны соответствовать требованиям стандарта PCI DSS

description
string (description) <= 200 characters

Описание

object (customer_data)

Данные плательщика

object (notification_data)

Настройки уведомлений

object (recurrent_data)

Данные, необходимые для создания инициирующего платежа

Responses

Request samples

Content type
application/json
{
  • "shop_order_id": "12345",
  • "amount": {
    },
  • "payment_method": {
    },
  • "description": "string",
  • "customer_data": {
    },
  • "notification_data": {
    },
  • "recurrent_data": {
    }
}

Response samples

Content type
application/json
{
  • "request_id": "ccb1bca3-e607-4114-b9bc-7de74fd01782",
  • "id": "449128d0-d867-4883-a8c7-e94571ef28e3",
  • "shop_order_id": "12345",
  • "description": "string",
  • "created_at": "2020-01-01 00:00:00.999999 +0000 UTC",
  • "last_operation_type": "sale",
  • "last_operation_status": "3ds_redirect",
  • "last_operation_error_code": 0,
  • "last_operation_error_code_description": "string",
  • "last_operation_external_transaction_id": "8c2018e3-4b1c-4c44-86a7-79e702ef690f",
  • "last_operation_completed_at": "2020-01-01 00:00:01.999999 +0000 UTC",
  • "authentication_data": {
    },
  • "recurrent_data": {
    },
  • "operations": [
    ]
}

Sale. Платеж через форму

Создание платежа. Одностадийное списание. Асинхронный сценарий взаимодействия

Authorizations:
bearerAuthWithAmount
Request Body schema: application/json

В JWT claims должна быть структура amount

shop_order_id
string (shop_order_id) <= 64 characters

ID заказа в системе магазина

required
object (amount)

Сумма

object
description
string (description) <= 200 characters

Описание

object (customer_data)

Данные плательщика

object (redirect_data)

Настройки перенаправлений плательщика. Если не задано, то берется из настроек магазина. Для магазинов, не использующих свою форму оплаты

object (notification_data)

Настройки уведомлений

lifetime_sec
integer (lifetime_sec) [ 60 .. 32767 ]

Для магазинов, использующих платежную форму Системы

object (recurrent_data)

Данные, необходимые для создания инициирующего платежа

Responses

Request samples

Content type
application/json
{
  • "shop_order_id": "12345",
  • "amount": {
    },
  • "payment_method": {
    },
  • "description": "string",
  • "customer_data": {
    },
  • "redirect_data": {},
  • "notification_data": {
    },
  • "lifetime_sec": "3600",
  • "recurrent_data": {
    }
}

Response samples

Content type
application/json
{
  • "request_id": "ccb1bca3-e607-4114-b9bc-7de74fd01782",
  • "id": "449128d0-d867-4883-a8c7-e94571ef28e3",
  • "shop_order_id": "12345",
  • "description": "string",
  • "created_at": "2020-01-01 00:00:00.999999 +0000 UTC",
  • "expires_at": "2020-01-02 00:00:00.999999 +0000 UTC",
  • "form_url": "http://payment-page-url",
  • "last_operation_type": "sale",
  • "last_operation_status": "created",
  • "last_operation_error_code": 0,
  • "last_operation_error_code_description": "string",
  • "last_operation_completed_at": "2020-01-01 00:00:01.999999 +0000 UTC",
  • "recurrent_data": {
    },
  • "operations": [
    ]
}

PreAuth. Предавторизация средств. Платеж через Gate

Создание платежа. Двухстадийное списание. Первый шаг двухстадийного списания, в результате которого блокируются (холдируются) средства. Синхронный сценарий взаимодействия

Authorizations:
bearerAuthWithAmount
Request Body schema: application/json

В JWT claims должна быть структура amount

shop_order_id
string (shop_order_id) <= 64 characters

ID заказа в системе магазина

required
object (amount_preauth)

Сумма

object (payment_method_request_preauth)

Обязательно для магазинов, использующих свою форму оплаты для банковских карт. Магазины, передающие данные банковских карт, должны соответствовать требованиям стандарта PCI DSS

description
string (description) <= 200 characters

Описание

object (customer_data)

Данные плательщика

object (notification_data)

Настройки уведомлений

object (recurrent_data)

Данные, необходимые для создания инициирующего платежа

Responses

Request samples

Content type
application/json
{
  • "shop_order_id": "12345",
  • "amount": {
    },
  • "payment_method": {
    },
  • "description": "string",
  • "customer_data": {
    },
  • "notification_data": {
    },
  • "recurrent_data": {
    }
}

Response samples

Content type
application/json
{
  • "request_id": "ccb1bca3-e607-4114-b9bc-7de74fd01782",
  • "id": "449128d0-d867-4883-a8c7-e94571ef28e3",
  • "shop_order_id": "12345",
  • "description": "string",
  • "created_at": "2020-01-01 00:00:00.999999 +0000 UTC",
  • "last_operation_type": "preauth",
  • "last_operation_status": "3ds_redirect",
  • "last_operation_error_code": 0,
  • "last_operation_error_code_description": "string",
  • "last_operation_external_transaction_id": "8c2018e3-4b1c-4c44-86a7-79e702ef690f",
  • "last_operation_completed_at": "2020-01-01 00:00:01.999999 +0000 UTC",
  • "authentication_data": {
    },
  • "recurrent_data": {
    },
  • "operations": [
    ]
}

PreAuth. Предавторизация средств. Платеж через форму

Создание платежа. Двухстадийное списание. Первый шаг двухстадийного списания, в результате которого блокируются (холдируются) средства. Асинхронный сценарий взаимодействия

Authorizations:
bearerAuthWithAmount
Request Body schema: application/json

В JWT claims должна быть структура amount

shop_order_id
string (shop_order_id) <= 64 characters

ID заказа в системе магазина

required
object (amount_preauth)

Сумма

object
description
string (description) <= 200 characters

Описание

object (customer_data)

Данные плательщика

object (redirect_data)

Настройки перенаправлений плательщика. Если не задано, то берется из настроек магазина. Для магазинов, не использующих свою форму оплаты

object (notification_data)

Настройки уведомлений

lifetime_sec
integer (lifetime_sec) [ 60 .. 32767 ]

Для магазинов, использующих платежную форму Системы

object (recurrent_data)

Данные, необходимые для создания инициирующего платежа

Responses

Request samples

Content type
application/json
{
  • "shop_order_id": "12345",
  • "amount": {
    },
  • "payment_method": {
    },
  • "description": "string",
  • "customer_data": {
    },
  • "redirect_data": {},
  • "notification_data": {
    },
  • "lifetime_sec": "3600",
  • "recurrent_data": {
    }
}

Response samples

Content type
application/json
{
  • "request_id": "ccb1bca3-e607-4114-b9bc-7de74fd01782",
  • "id": "449128d0-d867-4883-a8c7-e94571ef28e3",
  • "shop_order_id": "12345",
  • "description": "string",
  • "created_at": "2020-01-01 00:00:00.999999 +0000 UTC",
  • "expires_at": "2020-01-02 00:00:00.999999 +0000 UTC",
  • "form_url": "http://payment-page-url",
  • "last_operation_type": "preauth",
  • "last_operation_status": "created",
  • "last_operation_error_code": 0,
  • "last_operation_error_code_description": "string",
  • "last_operation_completed_at": "2020-01-01 00:00:01.999999 +0000 UTC",
  • "recurrent_data": {
    },
  • "operations": [
    ]
}

Complete. Завершение процесса аутентификации

Завершение процесса аутентификации для списания или предавторизации. Новая операция не создается. Завершение производится на операции c типом sale или preauth. Доступен для магазинов, соответствующим требованиям PCI DSS

Authorizations:
bearerAuth
Request Body schema: application/json
payment_id
required
string <uuid> (payment_id)

ID платежа

required
object

Responses

Request samples

Content type
application/json
{
  • "payment_id": "449128d0-d867-4883-a8c7-e94571ef28e3",
  • "tds_1": {
    }
}

Response samples

Content type
application/json
{
  • "request_id": "ccb1bca3-e607-4114-b9bc-7de74fd01782",
  • "id": "449128d0-d867-4883-a8c7-e94571ef28e3",
  • "shop_order_id": "12345",
  • "description": "string",
  • "created_at": "2020-01-01 00:00:00.999999 +0000 UTC",
  • "last_operation_type": "sale",
  • "last_operation_status": "approve",
  • "last_operation_error_code": 0,
  • "last_operation_error_code_description": "string",
  • "last_operation_completed_at": "2020-01-01 00:00:01.999999 +0000 UTC",
  • "operations": [
    ]
}

Reversal. Отмена предавторизации

Разблокировка предавторизованных (захолдированных) средств по операции PreAuth. Дальнейшее списание средств по данному платежу невозможно

Authorizations:
bearerAuth
Request Body schema: application/json
payment_id
required
string <uuid> (payment_id)

ID платежа

object (notification_data)

Настройки уведомлений

Responses

Request samples

Content type
application/json
{
  • "payment_id": "449128d0-d867-4883-a8c7-e94571ef28e3",
  • "notification_data": {
    }
}

Response samples

Content type
application/json
{
  • "request_id": "ccb1bca3-e607-4114-b9bc-7de74fd01782",
  • "id": "449128d0-d867-4883-a8c7-e94571ef28e3",
  • "shop_order_id": "12345",
  • "description": "string",
  • "created_at": "2020-01-01 00:00:00.999999 +0000 UTC",
  • "last_operation_type": "reversal",
  • "last_operation_status": "approve",
  • "last_operation_error_code": 0,
  • "last_operation_error_code_description": "string",
  • "last_operation_completed_at": "2020-01-01 00:00:01.999999 +0000 UTC",
  • "operations": [
    ]
}

Capture. Списание предавторизованных средств

Списание предавторизованных (захолдированных) средств по операции PreAuth

Authorizations:
bearerAuthWithAmount
Request Body schema: application/json

В JWT claims должна быть структура amount

payment_id
required
string <uuid> (payment_id)

ID платежа

required
object

Возможность проведения Capture с суммой, отличающейся от суммы предавторизации (PreAuth), необходимо уточнять у менеджера

object (notification_data)

Настройки уведомлений

Responses

Request samples

Content type
application/json
{
  • "payment_id": "449128d0-d867-4883-a8c7-e94571ef28e3",
  • "amount": {
    },
  • "notification_data": {
    }
}

Response samples

Content type
application/json
{
  • "request_id": "ccb1bca3-e607-4114-b9bc-7de74fd01782",
  • "id": "449128d0-d867-4883-a8c7-e94571ef28e3",
  • "shop_order_id": "12345",
  • "description": "string",
  • "created_at": "2020-01-01 00:00:00.999999 +0000 UTC",
  • "last_operation_type": "capture",
  • "last_operation_status": "approve",
  • "last_operation_error_code": 0,
  • "last_operation_error_code_description": "string",
  • "last_operation_completed_at": "2020-01-01 00:00:01.999999 +0000 UTC",
  • "operations": [
    ]
}

Refund. Возврат

Возврат ранее списанных средств по операциям Sale и Capture

Authorizations:
bearerAuthWithAmount
Request Body schema: application/json

Если в теле запроса передается amount, то в JWT claims должна быть структура amount

payment_id
required
string <uuid> (payment_id)

ID платежа

object

Если не указан, то производится возврат на полную сумму списания

object (notification_data)

Настройки уведомлений

Responses

Request samples

Content type
application/json
{
  • "payment_id": "449128d0-d867-4883-a8c7-e94571ef28e3",
  • "amount": {
    },
  • "notification_data": {
    }
}

Response samples

Content type
application/json
{
  • "request_id": "ccb1bca3-e607-4114-b9bc-7de74fd01782",
  • "id": "449128d0-d867-4883-a8c7-e94571ef28e3",
  • "shop_order_id": "12345",
  • "description": "string",
  • "created_at": "2020-01-01 00:00:00.999999 +0000 UTC",
  • "last_operation_type": "refund",
  • "last_operation_status": "approve",
  • "last_operation_error_code": 0,
  • "last_operation_error_code_description": "string",
  • "last_operation_completed_at": "2020-01-01 00:00:01.999999 +0000 UTC",
  • "operations": [
    ]
}

Recurrent. Выполнение рекуррентного платежа

Выполнение рекуррентного платежа, созданного по операции Sale или Preauth

Authorizations:
bearerAuthWithAmount
Request Body schema: application/json

В JWT claims должна быть структура amount

original_payment_id
required
string <uuid> (original_payment_id)

ID инициализирующего рекуррентного платежа

shop_order_id
required
string (shop_order_id) <= 64 characters

ID заказа в системе магазина

required
object (amount)

Сумма

description
string (description) <= 200 characters

Описание

object (customer_data)

Данные плательщика

object (notification_data)

Настройки уведомлений

Responses

Request samples

Content type
application/json
{
  • "original_payment_id": "449128d0-d867-4883-a8c7-e94571ef28e3",
  • "shop_order_id": "12345",
  • "amount": {
    },
  • "description": "string",
  • "customer_data": {
    },
  • "notification_data": {
    }
}

Response samples

Content type
application/json
{
  • "request_id": "ccb1bca3-e607-4114-b9bc-7de74fd01782",
  • "id": "449128d0-d867-4883-a8c7-e94571ef28e3",
  • "shop_order_id": "12345",
  • "description": "string",
  • "created_at": "2020-01-01 00:00:00.999999 +0000 UTC",
  • "last_operation_type": "recurrent",
  • "last_operation_status": "3ds_redirect",
  • "last_operation_error_code": 0,
  • "last_operation_error_code_description": "string",
  • "last_operation_completed_at": "2020-01-01 00:00:01.999999 +0000 UTC",
  • "operations": [
    ]
}

External Recurrent. Выполнение внешнего рекуррентного платежа

Выполнение рекуррентного платежа, который был инициализирован в стороннем сервисе

Authorizations:
bearerAuthExtRecurrent
Request Body schema: application/json

В JWT claims должна быть структура amount

shop_order_id
string (shop_order_id) <= 64 characters

ID заказа в системе магазина

required
object (amount)

Сумма

required
object (payment_method_request_ext_recurrent)

Магазины, передающие данные банковских карт, должны соответствовать требованиям стандарта PCI DSS

description
string (description) <= 200 characters

Описание

object (customer_data)

Данные плательщика

object (notification_data)

Настройки уведомлений

Responses

Request samples

Content type
application/json
{
  • "shop_order_id": "12345",
  • "amount": {
    },
  • "payment_method": {
    },
  • "description": "string",
  • "customer_data": {
    },
  • "notification_data": {
    }
}

Response samples

Content type
application/json
{
  • "request_id": "ccb1bca3-e607-4114-b9bc-7de74fd01782",
  • "id": "449128d0-d867-4883-a8c7-e94571ef28e3",
  • "shop_order_id": "12345",
  • "description": "string",
  • "created_at": "2020-01-01 00:00:00.999999 +0000 UTC",
  • "last_operation_type": "ext_recurrent",
  • "last_operation_status": "3ds_redirect",
  • "last_operation_error_code": 0,
  • "last_operation_error_code_description": "string",
  • "last_operation_completed_at": "2020-01-01 00:00:01.999999 +0000 UTC",
  • "operations": [
    ]
}

payouts

Выплаты.

Публичный ключ для шифрования sender_data_encrypted и recipient_data_encrypted:

-----BEGIN PUBLIC KEY-----
MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAoTFyDDasDeAfkSxQeuBW
/N2YJ5HMPGbP4dNKduG3Tcl14489tvSF/xl4A5fTnTPjttq9EjO8yGOmHKhwu/13
ChPay+pMf3DlDg4TS0jxPjGeanY5pzFcaDaFZYgyQyinceFX5Kp7CAsr4quFCSxN
++y8lqK8A9svMPTh0gQg8oKWxV/o9FPIR1iZw8saQy2Op8+aqqOMOCqYxFQ9QHgA
NJGcmE45hP72sNfO4cfPkBN96WiWLhGtAMbSmGymolPXiR8I0isYk8zuaFYyO+Gv
u+/ar0ogMbddep43CCKQheRzFP8gwqJZe/wdrBwwrWfMu/Y1c87csU3jeqslVubo
yQIDAQAB
-----END PUBLIC KEY-----

Состояние выплаты

Запрос состояния выплаты

Authorizations:
bearerAuth
path Parameters
id
required
string <uuid>
Example: 449128d0-d867-4883-a8c7-e94571ef28e3

ID выплаты

Responses

Response samples

Content type
application/json
{
  • "id": "449128d0-d867-4883-a8c7-e94571ef28e3",
  • "shop_order_id": "12345",
  • "description": "string",
  • "created_at": "2020-01-01 00:00:00.999999 +0000 UTC",
  • "last_operation_type": "credit",
  • "last_operation_status": "decline",
  • "last_operation_error_code": 0,
  • "last_operation_error_code_description": "string",
  • "last_operation_completed_at": "2020-01-01 00:00:01.999999 +0000 UTC",
  • "operations": [
    ]
}

Состояние выплаты

Запрос состояния выплаты по ID заказа в системе магазина

Authorizations:
bearerAuth
path Parameters
id
required
string <= 64 characters
Example: 12345

ID заказа в системе магазина

Responses

Response samples

Content type
application/json
{
  • "id": "449128d0-d867-4883-a8c7-e94571ef28e3",
  • "shop_order_id": "12345",
  • "description": "string",
  • "created_at": "2020-01-01 00:00:00.999999 +0000 UTC",
  • "last_operation_type": "credit",
  • "last_operation_status": "decline",
  • "last_operation_error_code": 0,
  • "last_operation_error_code_description": "string",
  • "last_operation_completed_at": "2020-01-01 00:00:01.999999 +0000 UTC",
  • "operations": [
    ]
}

Credit. Выплата

Создание выплаты

Authorizations:
bearerAuthWithAmountAndPayoutMethod
Request Body schema: application/json

В JWT claims должны быть структуры amount и payout_method

shop_order_id
string (shop_order_id) <= 64 characters

ID заказа в системе магазина

required
object (amount)

Сумма

required
object (payout_method_request)

Метод выплаты

description
string (description) <= 200 characters

Описание

required
object (credit_recipient_data)

Данные получателя

object (notification_data)

Настройки уведомлений

Responses

Request samples

Content type
application/json
{
  • "shop_order_id": "12345",
  • "amount": {
    },
  • "payout_method": {
    },
  • "description": "string",
  • "recipient_data": {
    },
  • "notification_data": {
    }
}

Response samples

Content type
application/json
{
  • "id": "449128d0-d867-4883-a8c7-e94571ef28e3",
  • "shop_order_id": "12345",
  • "description": "string",
  • "created_at": "2020-01-01 00:00:00.999999 +0000 UTC",
  • "last_operation_type": "credit",
  • "last_operation_status": "pending",
  • "last_operation_completed_at": "2020-01-01 00:00:01.999999 +0000 UTC",
  • "operations": [
    ]
}

SBPParticipants. Получение списка банков участников СБП

Получение списка банков участников СБП, предоставляющих возможность получения денежных средств при операции выплаты

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
{
  • "request_id": "ccb1bca3-e607-4114-b9bc-7de74fd01782",
  • "participants": [
    ]
}

Запрос проверки возможности выплаты СБП

Данный запрос порождает только начало выплаты СБП. Время между запросом СБП на возможность совершить выплату и самой выплатой ограничено = 180 сек. Т.е. после запроса /payouts/sbp/check сразу (<180cек) должен идти /payouts/sbp/confirm. Если это невозможно обеспечить, то нужно пользоваться методом Credit (выплата за один запрос).

Authorizations:
bearerAuthWithAmount
Request Body schema: application/json

В JWT claims должна быть структура amount

shop_order_id
string (shop_order_id) <= 64 characters

ID заказа в системе магазина

required
object (amount)

Сумма

bank_member_id
required
string (bank_member_id)

ID банка участника СБП, на счет клиента которого будет выполнятся выплата

phone
required
string (recipient_phone) [ 9 .. 15 ] characters

Номер телефона для получения выплаты

description
string (description) <= 200 characters

Описание

object (recipient_data)

Данные получателя

object (notification_data)

Настройки уведомлений

Responses

Request samples

Content type
application/json
{
  • "shop_order_id": "12345",
  • "amount": {
    },
  • "bank_member_id": "500000000005",
  • "phone": "71234567890",
  • "description": "string",
  • "recipient_data": {
    },
  • "notification_data": {
    }
}

Response samples

Content type
application/json
{
  • "request_id": "ccb1bca3-e607-4114-b9bc-7de74fd01782",
  • "payout_id": "449128d0-d867-4883-a8c7-e94571ef28e3",
  • "client_name": "И Иван Иванович"
}

Выплата СБП после запроса на возможность выплаты

Создание выплаты СБП после запроса на возможность выплаты

Authorizations:
bearerAuth
Request Body schema: application/json
payout_id
required
string <uuid> (payout_id)

ID выплаты

Responses

Request samples

Content type
application/json
{
  • "payout_id": "449128d0-d867-4883-a8c7-e94571ef28e3"
}

Response samples

Content type
application/json
{
  • "id": "449128d0-d867-4883-a8c7-e94571ef28e3",
  • "shop_order_id": "12345",
  • "description": "string",
  • "created_at": "2020-01-01 00:00:00.999999 +0000 UTC",
  • "last_operation_type": "credit",
  • "last_operation_status": "pending",
  • "last_operation_completed_at": "2020-01-01 00:00:01.999999 +0000 UTC",
  • "operations": [
    ]
}

transfers

Переводы

Перевод через форму

Создание перевода. Асинхронный сценарий взаимодействия

Authorizations:
bearerAuthWithAmountAndPayoutMethod
Request Body schema: application/json

В JWT claims должны быть структуры amount и payout_method

shop_order_id
string (shop_order_id) <= 64 characters

ID заказа в системе магазина

required
object (amount)

Сумма

required
object (transfer_method_request)

Метод выплаты

description
string (description) <= 200 characters

Описание

object (recipient_data)

Данные получателя

object (customer_data)

Данные плательщика

object (redirect_data)

Настройки перенаправлений плательщика. Если не задано, то берется из настроек магазина. Для магазинов, не использующих свою форму оплаты

object (notification_data)

Настройки уведомлений

lifetime_sec
integer (lifetime_sec) [ 60 .. 32767 ]

Для магазинов, использующих платежную форму Системы

Responses

Request samples

Content type
application/json
{
  • "shop_order_id": "12345",
  • "amount": {
    },
  • "payout_method": {
    },
  • "description": "string",
  • "recipient_data": {
    },
  • "customer_data": {
    },
  • "redirect_data": {},
  • "notification_data": {
    },
  • "lifetime_sec": "3600"
}

Response samples

Content type
application/json
{
  • "request_id": "ccb1bca3-e607-4114-b9bc-7de74fd01782",
  • "id": "449128d0-d867-4883-a8c7-e94571ef28e3",
  • "status": "created",
  • "shop_order_id": "12345",
  • "description": "string",
  • "created_at": "2020-01-01 00:00:00.999999 +0000 UTC",
  • "expires_at": "2020-01-02 00:00:00.999999 +0000 UTC",
  • "form_url": "http://payment-page-url",
  • "operations": [
    ]
}

Перевод p2p через форму

Создание p2p перевода. Асинхронный сценарий взаимодействия

Authorizations:
bearerAuth
Request Body schema: application/json
shop_order_id
string (shop_order_id) <= 64 characters

ID заказа в системе магазина

description
string (description) <= 200 characters

Описание

object (recipient_data)

Данные получателя

object (customer_data)

Данные плательщика

object (redirect_data)

Настройки перенаправлений плательщика. Если не задано, то берется из настроек магазина. Для магазинов, не использующих свою форму оплаты

object (notification_data)

Настройки уведомлений

lifetime_sec
integer (lifetime_sec) [ 60 .. 32767 ]

Для магазинов, использующих платежную форму Системы

Responses

Request samples

Content type
application/json
{
  • "shop_order_id": "12345",
  • "description": "string",
  • "recipient_data": {
    },
  • "customer_data": {
    },
  • "redirect_data": {},
  • "notification_data": {
    },
  • "lifetime_sec": "3600"
}

Response samples

Content type
application/json
{}

Состояния перевода

Запрос состояния перевода

Authorizations:
bearerAuth
path Parameters
id
required
string <uuid>
Example: 449128d0-d867-4883-a8c7-e94571ef28e3

ID перевода

Responses

Response samples

Content type
application/json
{
  • "request_id": "ccb1bca3-e607-4114-b9bc-7de74fd01782",
  • "id": "449128d0-d867-4883-a8c7-e94571ef28e3",
  • "status": "decline",
  • "shop_order_id": "12345",
  • "description": "string",
  • "created_at": "2020-01-01 00:00:00.999999 +0000 UTC",
  • "expires_at": "2020-01-02 00:00:00.999999 +0000 UTC",
  • "operations": [
    ]
}

Состояния перевода

Запрос состояния перевода по ID заказа в системе магазина

Authorizations:
bearerAuth
path Parameters
id
required
string <= 64 characters
Example: 12345

ID заказа в системе магазина

Responses

Response samples

Content type
application/json
{
  • "request_id": "ccb1bca3-e607-4114-b9bc-7de74fd01782",
  • "id": "449128d0-d867-4883-a8c7-e94571ef28e3",
  • "status": "decline",
  • "shop_order_id": "12345",
  • "description": "string",
  • "created_at": "2020-01-01 00:00:00.999999 +0000 UTC",
  • "expires_at": "2020-01-02 00:00:00.999999 +0000 UTC",
  • "operations": [
    ]
}

notifications

Уведомления торговца

Уведомления

В каждом запросе присутствует заголовок:

Authorization: Bearer {JWT}

Вместо {JWT} будет JWT, сформированный Системой. Его нужно использовать для аутентификации, верифицируя публичным ключом, используя алгоритм ES256:

-----BEGIN PUBLIC KEY-----
MFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAEQkwi9gyTRzNh3Mr3qFqU5C+uaJEh
KKZXRASLJm/vJSARLzuQhulZopgoMM2fp4NMkmTcPhHrJxk+DfyKkir+Rw==
-----END PUBLIC KEY-----

В JWT Claims указаны:

  1. payment_id, payout_id или transfer_id. Данное значение нужно сравнить с payment.id, payout.id или transfer.id, в зависимости от channel.
  2. amount. Сравнить с amount в теле запроса.
  3. merchant_id
  4. shop_id
  5. jti UUID JWT
  6. iat Время создания JWT, числовое значение unix time
  7. iss Издатель JWT
path Parameters
callback_url
any

URL для уведомлений. Должен начинаться с https. Отправка уведомления осуществляется только на стандартный порт 443. Указан в настройках магазина или передается при выполнении операций sale, preauth, credit в notification_data.callback_url

Request Body schema: application/json
action
string
Value: "notification"
channel
string
Enum: "payment" "payout" "transfer"
object

Если channel = payment

object

Если channel = payout

object

Если channel = transfer

Responses

Request samples

Content type
application/json
{
  • "action": "notification",
  • "channel": "payment",
  • "payment": {
    },
  • "payout": {
    },
  • "transfer": {
    }
}

balance

Состояние баланса

Запрос состояния баланса

Запрос текущего состояние баланса и размер доступного овердрафта

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
{
  • "shop_id": 55,
  • "balance": 850000.05,
  • "overdraft": 100000.3,
  • "request_id": "ccb1bca3-e607-4114-b9bc-7de74fd01782"
}

cards

Методы работы с картами

Список привязанных карт

Запрос на получение списка привязанных карт

Authorizations:
bearerAuth
path Parameters
id
required
string
Example: string

ID держателя карты

Responses

Response samples

Content type
application/json
{
  • "request_id": "ccb1bca3-e607-4114-b9bc-7de74fd01782",
  • "cards": [
    ]
}

Создание ссылки на форму для привязки карты

Создается ссылка на форму с привязкой карты для последующего использования в выплатах

Authorizations:
bearerAuth
Request Body schema: application/json
required
object
object

Настройки уведомлений

object

Настройки перенаправления

Responses

Request samples

Content type
application/json
{
  • "payout_method": {
    },
  • "notification_data": {
    },
  • "redirect_data": {
    }
}

Response samples

Content type
application/json
{}

Блокировка привязанной карты

Запрос на блокировку карты из списка привязанных

Authorizations:
bearerAuth
path Parameters
id
required
string <uuid>
Example: 569128d0-d867-4883-a8c7-e94571ef28e3

ID карты

Responses

Response samples

Content type
application/json
{
  • "request_id": "ccb1bca3-e607-4114-b9bc-7de74fd01782"
}

identifications

Упрощенная идентификация.

Публичный ключ для шифрования payload:

-----BEGIN PUBLIC KEY-----
MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAoTFyDDasDeAfkSxQeuBW
/N2YJ5HMPGbP4dNKduG3Tcl14489tvSF/xl4A5fTnTPjttq9EjO8yGOmHKhwu/13
ChPay+pMf3DlDg4TS0jxPjGeanY5pzFcaDaFZYgyQyinceFX5Kp7CAsr4quFCSxN
++y8lqK8A9svMPTh0gQg8oKWxV/o9FPIR1iZw8saQy2Op8+aqqOMOCqYxFQ9QHgA
NJGcmE45hP72sNfO4cfPkBN96WiWLhGtAMbSmGymolPXiR8I0isYk8zuaFYyO+Gv
u+/ar0ogMbddep43CCKQheRzFP8gwqJZe/wdrBwwrWfMu/Y1c87csU3jeqslVubo
yQIDAQAB
-----END PUBLIC KEY-----

Инициализация упрощенной идентификации

Метод инициализации упрощенной идентификации

Authorizations:
bearerAuthWithMerchantIDAndPubKeyID
Request Body schema: application/json
payload
required
string

Зашифрованные данные физического лица. Представлен в виде JSON

{
  "passport_series": "7866",
  "passport_number": "123456",
  "last_name": "Иванов",
  "first_name": "Иван",
  "middle_name": "Иванович",
  "has_middle_name": true,
  "birthdate": "1966-09-12",
  "gender": "Male",
  "inn": "520205004556",
  "snils": "027-733-198 62"
}
  • passport_series - Серия паспорта. Обязательно
  • passport_number - Номер паспорта. Обязательно
  • last_name - Фамилия. Обязательно
  • first_name - Имя. Обязательно
  • middle_name - Отчество. Обязательно при наличии
  • has_middle_name - Имеется ли отчество. Обязательно
  • birthdate - Дата рождения. Обязательно. Формат: "YYYY-MM-DD"
  • gender - Пол. Обязательно. Возможные значения: "Male" и "Female"
  • inn - ИНН
  • snils - СНИЛС. В формате xxx-xxx-xxx xx (x – символы десятичных цифр 0...9)

Обязательно для заполнения либо ИНН, либо СНИЛС.

Данный JSON шифруется на стороне торговца публичным ключом Системы и кодируется в base64.

callback_url
string

URL, на который будет отправлено уведомление при изменении статуса идентификации. Формат сообщения аналогичен формату ответа, получаемого при опросе статуса.

Responses

Request samples

Content type
application/json
{
  • "payload": "string",
  • "callback_url": "string"
}

Response samples

Content type
application/json
{
  • "request_id": "ccb1bca3-e607-4114-b9bc-7de74fd01782",
  • "status": "valid"
}

Получение статуса упрощенной идентификации

Метод получения статуса упрощенной идентификации

Authorizations:
bearerAuthWithMerchantIDAndPubKeyID
path Parameters
requestID
required
string <uuid>
Example: ccb1bca3-e607-4114-b9bc-7de74fd01782

Идентификатор инициированного запроса на упрощенную идентификацию

Responses

Response samples

Content type
application/json
{
  • "request_id": "ccb1bca3-e607-4114-b9bc-7de74fd01782",
  • "status": "valid"
}

Список кодов ошибок

Код Описание
100 JWT error
101 Resource not found
102 Bad request JSON
103 Failed validation
104 idempotency_key is duplicated. Details contain id of the previous entity
105 shop_order_id is duplicated in previous request. Details contain id of the previous entity
106 Settings error
107 Payment (payout) method not found for such number
108 Unauthorized
109 Terminal not found
110 Error while writing JSON
111 Operation forbidden
112 Wrong HTTP request method
113 Recurring payment is not possible. The payment has been cancelled
114 Entity relation error
200 Decline by Anti-fraud
280 Insufficient funds on account
300 3DS authentication failed
301 APS not available
302 Card doesn't support 3DS
303 Invalid CRES
304 Bad CAVV
305 3DS authentication expired
306 QR code for the operation has expired
307 Full 3DS authentication required
400 Service provider technical error
401 Service provider technical error, try again
500 Internal server error
501 Seems to be a logical error in the code
502 Adapter error
503 Service unavailable
601 Refer to card issuer
602 Refer to card issuer, special condition
603 Invalid acquiring merchant
604 Pick-up card
605 Do not honor
606 Acquiring error
607 Pick-up card, special condition
608 Honour with identification
609 Acquiring request in process
610 Approved for partial amount
611 Approved VIP
612 Invalid transaction
613 Invalid amount
614 Invalid card number
615 No such issuer
616 Approved, update track 3
617 Customer cancellation
618 Customer dispute
619 Re-enter transaction
620 Invalid response
621 No action token
622 Suspected malfunction
623 Unacceptable transaction fee
624 File update not supported by receiver
625 No such record
626 Duplicate record update, old record replaced
627 File update field edit error
628 File locked out while update
629 File update error, contact acquirer
630 Format error
631 Issuer signed off
632 Completed partially
633 Expired card
634 Pick-up, suspected fraud
635 Pick-up, card acceptor contact acquirer
636 Pick-up, card restricted
637 Pick-up, call acquirer security
638 Allowable PIN tries exceeded
639 No credit account
640 Requested function not supported
641 Lost card
642 No universal account
643 Stolen card
644 No investment account
646 Closed account
651 Not sufficient funds
652 No chequing account
653 No savings account
654 Acquiring expired card
655 Incorrect personal identification
656 No card record
657 Transaction not permitted to cardholder
658 Transaction not permitted to terminal
659 Suspected fraud
660 Card acceptor contact acquirer
661 Exceeds withdrawal amount limit
662 Restricted card
663 Security violation
664 Original amount incorrect
665 Exceeds withdrawal frequency limit
666 Call acquirer security department
667 Card to be picked-up at ATM
668 Response received too late
670 Contact card issuer
675 Allowable number of PIN tries exceeded
676 Wrong PIN, tries exceeded
677 Wrong reference number
678 Invalid/nonexistent account specified
679 Already reversed
680 Network error
681 Foreign network PIN cryptographic
682 Time-out at issuer system / bad CVV (VISA)
683 Transaction failed
684 Pre-authorization timed out
685 Account verification required
686 Unable to verify PIN
688 Cryptographic failure
689 Authentication failure
690 Cutoff is in progress
691 Issuer or switch is inoperative
692 Financial institution or intermediate network facility cannot be found for routing
693 Transaction cannot be completed. Violation of law
694 Duplicate transmission
695 Reconcile error / Auth not found
696 System malfunction
698 Inactive card status
699 Aborted
720 Decline by external Anti-fraud
730 External MPI technical error
731 Decline by external MPI
760 Limit exceeded
761 Not permitted
763 Fraud - transaction canceled
764 Postponed
765 Strong customer authentication required
766 Need checker's confirmation
767 Original transaction not found
768 Corresponding account exhausted
769 External authentication required
770 Additional data required
771 External OTP requested
772 Blocked, first used or temporarily blocked
773 Transaction not supported
774 Withdrawal limit would be exceeded
775 Credit amount limit
777 Destination not available
779 Decline for CVV2 failure
801 SBP general error
802 SBP declined by recipient bank
803 More than one SBP recipient found
804 SBP recipient not found
805 Unable to credit SBP transfer amount to recipient's account
806 SBP recipient refused to receive funds
807 SBP recipient's account is blocked or closed
808 SBP recipient's account not found
809 SBP violation of law - the identification level of funds is insufficient
810 SBP suspected fraud
811 SBP incorrect format (phone)
812 SBP PAM doesn't match
813 SBP transfer not found
814 SBP check has expired