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

Данная операция списывает средства, раннее зарезервированные операцией авторизации, и деньги поступают на ваш расчётный счёт в сроки, оговоренные в вашем договоре на приём платежа.

Запрос

Для списания средств отправьте POST запрос на https://api-ecom-gateway.2can.ru/beyag/transactions/captures с параметрами из таблиц ниже.

Параметры заголовка запроса


Content-Type обязательный	`application/json`
Accept обязательный	`application/json`
X-API-Version	Возможные значения: `2`, `3`. По умолчанию, `3`. Подробнее здесь
RequestID	Ключ идемпотентности. Подробнее здесь.

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

object

parent_uid обязательный	string UID родительской транзакции.
amount	integer Сумма списания в минимальных денежных единицах, например 1000 для $10.00.
currency	string Валюта транзакции в формате ISO-4217 alpha-3 code. Например, `USD`.

Warning

Если интеграция поддерживает несколько частичных списаний для одной транзакции авторизации, каждый запрос на списание рассматривается как отдельная транзакция.

Если после отправки запроса получен ответ 5xx или произошла сетевая ошибка, рекомендуется проверить статус транзакции по tracking_id. Если транзакция не найдена, повторите исходный запрос с тем же ключом идемпотентности.

Повторный запрос без ключа идемпотентности или с новым ключом идемпотентноти может привести к созданию дополнительного списания.

Пример запроса

{
  "request":{
    "parent_uid":"1-310b0da80b",
    "amount":50
  }
}

Ответ

object

uid

обязательный

string
UID обработанной транзакции.

parent_uid

обязательный

string
UID родительской транзакции.

type

обязательный

string
Тип транзакции.

status

обязательный

string
Статус обработанной транзакции.

amount

обязательный

integer
Стоимость в минимальных денежных единицах.

currency

обязательный

string
Валюта транзакции в формате ISO-4217 alpha-3 code. Например, USD.

description

обязательный

string
Описание заказа.

created_at

обязательный

string
Время создания транзакции в ISO 8601 формате.

updated_at

обязательный

string
Время обновления транзакции в ISO 8601 формате.

message

string
Сообщение с результатом запроса

amount

integer
Сумма списания.

tracking_id

string
ID транзакции или заказа в вашей системе. В параметре может быть отправлено несколько значений, разделенных символом ;. Например: "cbe59142-90af-4aea-b5a5-5bf3f66cf3da;f7883cb9-0e26-43a7-beb7-4027cb55d1a6;4a6a89d5-6950-400f". Если в запросе было передано более одного значения tracking_id, поиск транзакции в личном кабинете может быть осуществлен по любому из них.

test

boolean
true или false. Транзакция будет тестовой при true

language

string
Значение параметра language из запроса.

paid_at

string
Дата проведения транзакции.

method_type

обязательный

string
Название платёжного метода, через которую списали заблокированные деньги.

receipt_url

обязательный

string
Ссылка на квитанцию обработанной транзакции.

object

status обязательный	string Статус обработанной транзакции.
ref_id обязательный	string Номер операции в платёжной системе.
message обязательный	string Сообщение от провайдера способа оплаты.

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

{
  "transaction": {
    "uid": "2-310b0da80b",
    "parent_uid": "1-310b0da80b",
    "type": "capture",
    "status": "successful",
    "message": "The operation was successfully processed",
    "created_at": "2014-06-11T12:04:59+03:00",
    "updated_at": "2014-06-11T12:04:59+03:00",
    "amount": 50,
    "currency": "USD",
    "test": false,
    "method_type": ":method_name",
    "receipt_url": "https://ecom-backoffice.2can.ru/customer/transactions/2-310b0da80b/11443f39ae75aa1f955a9c9283cd5045bfb0413b65d666f834a9da4e7d3926b5",
    "capture": {
      "message": "The operation was successfully processed",
      "ref_id": "8889999",
      "status": "successful"
    }
  }
}