Параметры оповещений о создании или отзыве токена

После выполнения запроса на создание или отзыв токена, отправленного в конечную точку /v2/customer/card/tokenize, платежная платформа возвращает оповещение (callback) с информацией о результате выполнения запроса. В следующей таблице приведен набор параметров, которые могут содержатся в таком оповещении.

Подробнее о структуре оповещений см. Как выглядит оповещение в Rocketpay.

Табл. 1. Объекты и параметры оповещения (callback) о создании или отзыве токена
Параметр Описание  

project_id
string

Уникальный идентификатор проекта.

Пример: 123

10

customer
object

Объект к данными пользователя 20

id
string

Уникальный идентификатор пользователя в проекте.

Пример: customer_123

20-120

request
object

Объект с данными исходного запроса 30

id
integer

Уникальный идентификатор запроса.

Пример: 3718000054

30-130

action
string

Тип запроса. Возможны следующие варианты:

  • tokenize — запрос на создание токена;
  • token_revoke — запрос на отзыв токена
  • параметр отсутствует — это означает, что токен отозван по истечении срока своего действия. Оповещение с отсутствующим параметром action платежная платформа присылает не в ответ на запрос, а автоматически, по истечении срока действия токена.

Пример: tokenize

30-230

status
string

Статус запроса. Возможны следующие варианты:
  • success — запрос успешно выполнен;
  • error — во время выполнения запроса возникли ошибки. В этом случае в оповещение добавляется массив errors с подробной информацией об ошибках.

Пример: success

30-330

errors
array

Массив объектов с информацией об ошибках. Присутствует в оповещении, только если в процессе обработки запроса возникли ошибки 30-430

ErrorItem
object

Объект с информацией об одной отдельно взятой ошибке 30-4-130-4

code
string

Код ошибки.

Пример: 10309

30-4-1-130-4-1

message
string

Сообщение, уточняющее причину ошибки.

Пример: Attempt to make a COF purchase without registered recurrent payments.

30-4-1-230-4-1

field
string

Параметр исходного запроса, в котором допущена ошибка, если этот параметр удалось локализовать

30-4-1-330-4-1

token
string

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

Пример: 2f0e75befacca30623354f9ffb0f44a80bee52982c39727b85039ef6f64309a1

40

token_created_at
string

Дата и время генерации токена. Токен генерируется автоматически при успешной оплате, если подключена соответствующая функциональность.

Пример: 2017-07-21T03:31:24+0000

50

token_status
string

Статус токена.

Пример: active

60

signature
string

Подпись оповещения 70

Рис.: Пример тела оповещения с токеном и информацией о его создании

{
"project_id": 12,
"customer": {
    "id": "cust_123"
    },
"request": {
    "id": "3c7f53fdbb5b8c96f9707457d75f",
    "action": "tokenize",
    "status": "success"
    },
"token": "2f0e75befacca30623354f9ffb0f44a80bee52982c39727b85039ef6f64309a1",
"token_created_at": "2017-11-28 13:30:57",
"token_status": "active",
"signature": "\/gmTHcy5wvrFD4ISuWEiV8+nOa3aqnLnyJ\/AupOYkl9S5eLJZ"
}