Перейти к содержанию

Токенизация карты получателя

Транзакция используется для токенизации банковской карты получателя средств и проведения 3-D Secure проверки.

Зачисления средств не происходит. Используйте полученный токен, чтобы провести выплату средств.

Запрос

Отправьте POST запрос на https://gateway.overpay.io/transactions/recipient_tokenizations со следующими параметрами:

Note

Тело запроса должно быть обёрнуто в корневой объект request{}.
description
 string (255)
Описание транзакции.
tracking_id
 string (255)
Ваш внутренний ID транзакции. Пожалуйста, используйте уникальное значение для того, чтобы при запросе статуса транзакции получить актуальную информацию. В противном случае вы получите массив данных по 10 последним транзакциям, найденным по указанному tracking_id. В параметре может быть отправлено несколько значений, разделенных символом ;. Например: "cbe59142-90af-4aea-b5a5-5bf3f66cf3da;f7883cb9-0e26-43a7-beb7-4027cb55d1a6;4a6a89d5-6950-400f". Если в запросе было передано более одного значения tracking_id, поиск транзакции в личном кабинете может быть осуществлен по любому из них.
object
Узнайте у службы поддержки, должны ли вы отправлять эти данные.
first_name
условно обязательный
 string (30)
Имя владельца карты.
last_name
условно обязательный
 string (30)
Фамилия владельца карты.
country
условно обязательный
 string
Страна владельца карты в формате ISO 3166-1 alpha-2.
city
условно обязательный
 string (60)
Город владельца карты.
state
условно обязательный
 string
Двухбуквенная аббревиатура штата, если страна владельца карты IN, US или CA.
zip
условно обязательный
 string
Почтовый индекс владельца карты. Для country=US, формат почтового индекса должен иметь вид NNNNN или NNNNN-NNNN.
address
условно обязательный
 string (255)
Адрес владельца карты.
phone
условно обязательный
 string (100)
Номер телефона владельца карты.
object
number
обязательный
 string (19)
Номер карты.
holder
условно обязательный
 string (35)
Имя владельца карты. Максимальная длина: 35 символов. Параметр опционален в системе Overpay, но может требоваться банком-эквайером.
exp_month
 string (2)
Месяц окончания срока действия карты, представленный одной или двумя цифрами (например, 01).
exp_year
 string (4)
Год окончания срока действия карты, представленный четырьмя цифрами (например, 2027).
object
Узнайте у службы поддержки, должны ли вы отправлять эти данные.
ip
 string
IP-адрес покупателя, запросившего транзакцию токенизации.
email
 string
email покупателя, запросившего транзакцию токенизации
device_id
 string
ID устройства покупателя, запросившего транзакцию токенизации.
birth_date
 string
Дата рождения покупателя в формате ISO 8601 YYYY-MM-DD.
external_id
 string (255)
Идентификатор покупателя в системе торговца.
object
Секция, содержащая дополнительную информацию о транзакции.
referer
 string
URL ресурса, с которого осуществляется запрос на проведение транзакции.
Пример запроса 
{
  "request": {
    "description": "Test transaction",
    "tracking_id": "your_uniq_number",
    "recipient_billing_address": {
      "first_name": "John",
      "last_name": "Doe",
      "country": "US",
      "city": "Denver",
      "state": "CO",
      "zip": "96002",
      "address": "1st Street"
    },
    "recipient_credit_card": {
      "number": "4200000000000000",
      "holder": "John Doe",
      "exp_month": "05",
      "exp_year": "2027"
    },
    "recipient": {
      "ip": "127.0.0.1",
      "email": "john@example.com"
    },
    "additional_data": {
        "referer": "https://example.com/server/cs_post/post.php?order_id=5304380&security=949247&currency=USD"
    }
  }
}
Ответ

Ответ будет содержать те же параметры, что и запрос, а также дополнительные параметры:
object
uid
обязательный
 string
UID обработанной транзакции.
status
обязательный
 string
Статус обработанной транзакции.
type
обязательный
 string
Тип транзакции.
payment_method_type
обязательный
 string
Способ оплаты, используется для завершения транзакции:

credit_card
tracking_id
 string
Значение параметра tracking_id из запроса.
message
обязательный
 string
Сообщение с результатом запроса.
created_at
обязательный
 string
Дата создания транзакции.
updated_at
обязательный
 string
Дата обновления транзакции. Например, обновление статуса.
object
holder
 string
Имя владельца карты.
stamp
обязательный
 string
Хэш карты. Постоянная величина, даже если дата окончания действия карты или владелец изменены.
token
обязательный
 string
Токен карты. Позволяет сохранять данные покупателей и производить оплату, когда они делают покупку или вы возобновляете свои услуги.
brand
обязательный
 string
Определенный бренд карты.
last_4
обязательный
 string
Последние 4 цифры карты.
first_1
обязательный
 string
Первая цифра карты.
bin
обязательный
 string (6)
Шестизначный банковский идентификационный номер. Первые 6 цифр номера карты.
bin_8
обязательный
 string (8)
Восьмизначный банковский идентификационный номер. Первые 8 цифр номера карты. Значение возвращается для карт Visa, Mastercard, Maestro, Halva, БЕЛКАРТ, МИР и соответствующих кобрендинговых карт. Для брендов других платежных карт значение параметра – null.
issuer_country
обязательный
 string (2)
Страна банка, выпустившего карту в формате ISO 3166-1 alpha-2.
issuer_name
обязательный
 string
Название банка, выпустившего карту.
product
обязательный
 string
Код типа карточного продукта.
exp_month
обязательный
 integer
Месяц окончания срока действия карты.
exp_year
обязательный
 integer
Год окончания срока действия карты.
token_provider
обязательный
 string
В данной транзакции не используется. Всегда null.
id
обязательный
 string
UID обработанной транзакции.
object
Секция, содержащая дополнительную информацию о транзакции.
referer
 string
URL ресурса, с которого осуществляется запрос на проведение транзакции.
Пример ответа 
{
  "transaction": {
    "uid": "0775f4fe-c4ac-4b55-83c2-d89ef948d84a",
    "status": "successful",
    "description": "Test transaction",
    "type": "recipient_tokenization",
    "payment_method_type": "credit_card",
    "tracking_id": "your_uniq_number",
    "message": "Successfully processed",
    "created_at": "2024-04-02T15:52:51.606Z",
    "updated_at": "2024-04-02T15:52:51.687Z",
    "recipient": {
      "ip": "127.0.0.1",
      "email": "john@example.com",
      "device_id": null,
      "birth_date": null
    },
    "recipient_credit_card": {
      "holder": "John Doe",
      "stamp": "b3839d334ba40e89168d60cd9f9d1390aee3fe67dd4d5c41adbf3998043eaef8",
      "brand": "visa",
      "last_4": "0000",
      "first_1": "4",
      "bin": "420000",
      "bin_8": "42000000",
      "issuer_country": "US",
      "issuer_name": "VISA Demo Bank",
      "product": "F",
      "exp_month": 5,
      "exp_year": 2027,
      "token_provider": null,
      "token": "39799863-240f-417e-9f12-5ca713118069"
    },
    "recipient_billing_address": {
      "first_name": "John",
      "last_name": "Doe",
      "address": "1st Street",
      "country": "US",
      "city": "Denver",
      "zip": "96002",
      "state": "CO",
      "phone": null
    },
    "status_code": null,
    "id": "0775f4fe-c4ac-4b55-83c2-d89ef948d84a",
    "additional_data": {            
      "referer": "https://example.com/server/cs_post/post.php?order_id=5304380&security=949247&currency=USD"
    }
  }
}