Использование токенов
Токен — это идентификатор, представляющий собой уникальную строку из 64 символов и связанный с определенной банковской картой и пользователем. Токен не содержит конфиденциальной информации и может храниться в вашей системе, не создавая угрозы нарушения стандартов безопасности по хранению данных банковских карт.
Через Gate вы можете создавать токены (автоматически или по запросу), а также производить по имеющимся токенам оплаты и выплаты.
Статусы токенов
Статус токена определяет возможность его использования для проведения оплат и выплат.
Статус | Описание |
---|---|
active | Действительный токен, по которому могут проводиться оплаты и выплаты |
revoke | Токен был отозван, проведение операций по токену невозможно |
expiry | Срок действия токена истек, проведение операций по токену невозможно |
Создание токена по запросу
Для создания токена банковской карты через Gate:
- Отправьте запрос с нужными параметрами и подписью на рабочий URL-адрес платежной платформы Rocketpay.
- Примите от платежной платформы оповещение (callback) с информацией о созданном токене и с самим токеном.
Запрос на создание токена
Далее представлена информация, необходимая для составления и отправки запроса на создание токена платежной карты.
HTTP-метод запроса | POST |
Формат тела запроса | JSON |
Конечная точка |
|
Полная спецификация конечной точки |
|
||||
---|---|---|---|---|
Объекты | Параметры | Описание | ||
customer |
id |
Идентификатор пользователя, уникальный в рамках проекта. Пример: |
||
ip_address |
IP-адрес устройства пользователя. Пример: |
|||
project_id |
Идентификатор проекта, полученный от Rocketpay при интеграции. Пример: |
|||
signature |
Подпись запроса, составленная после определения всех параметров запроса. Подробнее о составлении подписи см. Использование подписи к данным. | |||
card |
pan |
Номер карты. Пример: |
||
year |
Год окончания срока действия карты. Пример: |
|||
month |
Месяц окончания срока действия карты. Пример: |
|||
card_holder |
Имя держателя карты (как указано на карте). Пример: |
|||
При необходимости добавьте в запрос необязательные параметры, указанные в спецификации Gate: API Reference. |
Рис.: Пример запроса на создание токена
{ "customer": { "id": "customer_123", "ip_address": "198.51.100.47", "project_id": 123, "signature": "LLmhbDKdNhNLT+Qkr2SzbLbFYNxC9s...GucWQVZ2WM3v5N709w==" }, "card": { "pan": "1122334455667788", "year": 2025, "month": 8, "card_holder": "JOHN DOE" } }
Оповещение (callback)
Уведомление о создании токена платежная платформа возвращает в оповещении. Подробнее о структуре оповещений см. Оповещения (callbacks) в Gate. Подробнее о параметрах оповещений, касающихся токенов, см. Параметры оповещений о создании или отзыве токена.
Вот пример тела оповещения с информацией о том, что в рамках проекта 123
был создан токен карты пользователя customer_123
, а также вновь созданный токен.
Рис.: Пример тела оповещения о создании токена
{ "project_id": 123, "customer": { "id": "customer_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" }
Автоматическое создание токена
Токены могут создаваться автоматически при проведении первой успешной оплаты или выплаты по банковской карте, а также при успешной блокировке средств.
Платежная платформа вернет вам оповещение (callback) с токеном, а также информацией о времени его создания. Подробнее о параметрах оповещений, касающихся токенов, см. Параметры оповещений о создании или отзыве токена.
Оплата по токену
Gate позволяет пользователям осуществлять быстрые платежи с банковской карты, используя ранее созданный токен.
При проведении оплаты по банковской карте, для которой уже существует токен, новый токен не создается. Если пользователь укажет дату окончания срока действия карты, отличную от указанной при создании токена, то токен не создается заново, а срок действия токена обновляется до указанной даты.
Дополнительные сведения об оплате с использованием токена см. в разделе Разовая оплата.
Выплата по токену
Gate позволяет осуществлять выплату средств на банковскую карту пользователя, используя ранее созданный токен. Дополнительные сведения о выплатах с использованием токена см. в разделе Выплата по токену.
Получение данных карты по токену
Gate позволяет вам получить данные карты по токену. Для этого вы должны, отправить в платежную платформу соответствующий запрос. Далее представлена информация, необходимая для создания и отправки такого запроса.
HTTP-метод запроса | POST |
Формат тела запроса | JSON |
Конечная точка |
|
Полная спецификация конечной точки |
|
||||
---|---|---|---|---|
Объекты и параметры | Описание | |||
customer |
id |
Идентификатор пользователя, уникальный в рамках проекта. Пример: |
||
project_id |
Идентификатор проекта, полученный от Rocketpay при интеграции. Пример: |
|||
signature |
Подпись запроса, составленная после определения всех параметров запроса. Подробнее о составлении подписи см. Использование подписи к данным. | |||
token |
Токен банковской карты пользователя. Токен представляет собой уникальную строку из 64 символов, связанную с банковской картой. Пример: Подробнее см. Использование токенов |
|||
При необходимости добавьте в запрос необязательные параметры, указанные в спецификации Gate: API Reference. |
Рис.: Пример запроса на получение данных карты по токену
{ "customer": { "project_id": 123, "id":"customer_123", "signature":"2tlMuYxLW9Yu6RE...teg5lPk96Q==" }, "token":"959c664ad64b8caa54bb7836ddc737fd1a3e6c7045679d71d89caff6c242a039" }
В оповещении вы получите данные банковской карты и ее номер в маскированном виде.
Рис.: Пример тела оповещения с информацией о платежной карте
{
"account": {
"id": 2932,
"number": "112233******7788",
"type": "card",
"additional": {
"country": "GB",
"phone": "4487775556776",
"email": "johndoe@example.com",
"card": {
"expiry": "08/25",
"holder": "JOHN DOE",
"type": "visa"
}
},
"recurring_enable": false
},
"token": "959c664ad64b8caa54bb7836ddc777fd1a3e6c704b59bd71d89caff6c242a039"
},
"signature": "62kPxuCGqN4KDrxqqsuWnv0LOjdvUydWCxDmN+AVW7/5UtLlmVL+SIyfbxot/Nf+47DEsAuW76DIgBg=="
}
Проверка карты по токену
Gate позволяет проверить действительность платежной карты пользователя, используя ранее созданный токен. Подробнее о проверке карты по ее токену см. Проверка платежной карты.
Отзыв токена
Токен отзывается в следующих случаях:
- у связанной с токеном банковской карты заканчивается срок действия;
- вы отправляете в платежную платформу запрос на отзыв токена.
Запрос на отзыв токена
Далее представлена информация, необходимая для составления и отправки запроса на отзыв токена платежной карты.
HTTP-метод запроса | POST |
Формат тела запроса | JSON |
Конечная точка |
|
Полная спецификация конечной точки |
|
||||
---|---|---|---|---|
Объекты и параметры | Описание | |||
customer |
id |
Идентификатор пользователя, уникальный в рамках проекта. Пример: |
||
project_id |
Идентификатор проекта, полученный от Rocketpay при интеграции. Пример: |
|||
signature |
Подпись запроса, составленная после определения всех параметров запроса. Подробнее о составлении подписи см. Использование подписи к данным. | |||
token |
Токен банковской карты пользователя. Токен представляет собой уникальную строку из 64 символов, связанную с банковской картой. Пример: Подробнее см. Использование токенов |
|||
При необходимости добавьте в запрос необязательные параметры, указанные в спецификации Gate: API Reference. |
Рис.: Пример запроса на отзыв токена
{ "customer": { "project_id": 123, "id":"customer_123", "signature":"2tlMuYxLW9Yu6RE...teg5lPk96Q==" }, "token":"959c664ad64b8caa54bb7836ddc737fd1a3e6c7045679d71d89caff6c242a039" }
После окончания обработки запроса вам придет оповещение с результатом отзыва токена. Подробнее о параметрах оповещений, касающихся токенов, см. Параметры оповещений о создании или отзыве токена.