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

Выплата средств

Операция выплаты денег на карту по ее номеру.

Info

Ваш банк-эквайер может устанавливать ограничения и лимиты на использование этого типа транзакции. Больше информации вы можете узнать у вашего менеджера.


Запрос

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

Параметр Тип Описание
amount * обязательный
integer Стоимость в минимальных денежных единицах. Например, $32.45 должна быть отправлена как 3245.
currency * обязательный
string Валюта в ISO-4217 формате, например USD.
description * обязательный
string (255) Описание выплаты.
tracking_id string Ваш внутренний ID операции. Максимальная длина: 255 символов. Пожалуйста, используйте уникальное значение для того, чтобы при запросе статуса транзакции получить актуальную информацию. В противном случае вы получите первую найденную по tracking_id транзакцию.
duplicate_check boolean Параметр управляет процессом проверки входящего запроса на уникальность. Если в течение 30 секунд придет запрос на выплату средств с одинаковыми amount и number или token, то запрос будет отклонен. По умолчанию, этот параметр имеет значение true.
language string Язык вашей страницы оформления заказа. Если параметр установлен и email уведомление о транзакции включено, то bePaid отправит email, язык текста которого будет language. По умолчанию - en. Доступные значения параметра language.
notification_url string URL, на который будут приходить уведомления. Формат запроса уведомления аналогичен формату ответа транзакции.
verification_url string URL, на который будут приходить запрос на подтверждение транзакции. Формат запроса на подтверждение аналогичен формату ответа транзакции.
test boolean Транзакция будет тестовой, если значение true.
recipient_credit_card object
number * обязательный
string (19) Номер карты.
holder * условно обязательный
string (32) Имя владельца карты.
exp_month * условно обязательный
integer Месяц окончания срока действия карты, представленный двумя цифрами (например, 01).
exp_year * условно обязательный
integer Год срока окончания действия карты, представленный четырьмя цифрами (например, 2007).
token * условно обязательный
string Вместо 4 параметров выше вы можете отправить токен карты, который вы получили в ответе первой оплаты.
recipient object Узнайте у службы поддержки, должны ли вы отправлять эти данные.
ip * условно обязательный
string IP-адрес получателя, которому производится выплата.
email * условно обязательный
string Email получателя, которому производится выплата.
device_id * условно обязательный
string ID устройства получателя, которому производится выплата.
birth_date * условно обязательный
string Дата рождения получателя в формате ISO 8601 YYYY-MM-DD.
taxpayer_id * условно обязательный
string Идентификационный номер налогоплательщика (ИНН), присвоенный получателю выплаты.
sender object Узнайте у службы поддержки, должны ли вы отправлять эти данные.
ip * условно обязательный
string IP-адрес отправителя.
email * условно обязательный
string Email отправителя.
device_id * условно обязательный
string Id устройства отправителя.
birth_date * условно обязательный
string Дата рождения отправителя в формате ISO 8601 YYYY-MM-DD
recipient_billing_address object Узнайте у службы поддержки, должны ли вы отправлять эти данные.
first_name * условно обязательный
string (30) Имя получателя.
last_name * условно обязательный
string (30) Фамилия получателя.
country * условно обязательный
string Страна получателя в ISO 3166-1 alpha-2 формате.
city * условно обязательный
string (60) Город получателя.
state * условно обязательный
string Двухбуквенная абревиатура штата, если страна получателя US или CA.
zip string Почтовый индекс получателя. Для country=US, формат почтового индекса Должен иметь вид NNNNN или NNNNN-NNNN.
address * условно обязательный
string (255) Адрес получателя.
phone * условно обязательный
string (100) Номер телефона получателя.
sender_billing_address object Узнайте у службы поддержки, должны ли вы отправлять эти данные.
first_name string (30) Имя отправителя.
last_name string (30) Фамилия отправителя.
country string Страна отправителя в формате ISO 3166-1 alpha-2.
city string (60) Город отправителя.
state string Двухбуквенная абревиатура штата, если страна отправителя US или CA.
zip string Почтовый индекс отправителя. Для country=US, формат почтового индекса должен иметь вид NNNNN или NNNNN-NNNN.
address string (255) Адрес отправителя.
phone string (100) Номер телефона отправителя.
additional_data object Cекция, содержащая дополнительную информацию о транзакции.
p2p object Секция для работы с OCT операциями.
service_id * условно обязательный
string Значение параметра уточните у вашего менеджера.
service_extension * условно обязательный
string Значение параметра уточните у вашего менеджера.
document * условно обязательный
object Узнайте у службы поддержки, должны ли вы отправлять эти данные.
type * условно обязательный
string Тип документа отправителя. Возможные значения:

PASSPORT - паспорт гражданина
ID - ID-карта.
issuer * условно обязательный
string Кем выдан документ отправителя.
series * условно обязательный
string Серия документа отправителя.
number * условно обязательный
string Номер документа отправителя.
issued_at * условно обязательный
string Дата начала действия документа отправителя. Формат YYYY-MM-DD.
valid_until * условно обязательный
string Дата окончания срока действия документа отправителя. Формат YYYY-MM-DD.
Пример запроса
{
  "request": {
    "amount": 100,
    "currency": "RUB",
    "description": "Test transaction ütf",
    "tracking_id": "tracking_id_000",
    "recipient": {
      "ip": "127.0.0.1",
      "email": "john@example.com",
      "birth_date": "1990-10-20"
    },
    "sender": {
      "ip": "127.0.0.1",
      "email": "john@example.com",
      "birth_date": "1990-10-20"
    },
    "recipient_billing_address": {
      "first_name": "John",
      "last_name": "Doe",
      "country": "US",
      "city": "Denver",
      "state": "CO",
      "zip": "96002",
      "address": "1st Street",
      "phone": "375444444444"
    },
    "sender_billing_address": {
      "first_name": "John",
      "last_name": "Doe",
      "country": "US",
      "city": "Denver",
      "state": "CO",
      "zip": "96002",
      "address": "1st Street",
      "phone": "375444444444"
    },
    "recipient_credit_card": {
      "number": "5555555555554444",
      "holder": "John Doe",
      "exp_month": "12",
      "exp_year": 2022
    },
    "additional_data": {
      "document": {
        "type": "PASSPORT",
        "issuer": "Organization name",
        "series": "MP",
        "number": "1234567890",
        "issued_at": "2010-03-12",
        "valid_until": "2025-03-12"
      }
    }
  }
}
Пример запроса с токеном карты
{
  "request": {
    "amount": 100,
    "currency": "RUB",
    "description": "Test transaction ütf",
    "tracking_id": "tracking_id_000",
    "recipient": {
      "ip": "127.0.0.1",
      "email": "john@example.com",
      "birth_date": "1990-10-20"
    },
    "sender": {
      "ip": "127.0.0.1",
      "email": "john@example.com",
      "birth_date": "1990-10-20"
    },
    "recipient_billing_address": {
      "first_name": "John",
      "last_name": "Doe",
      "country": "US",
      "city": "Denver",
      "state": "CO",
      "zip": "96002",
      "address": "1st Street",
      "phone": "375444444444"
    },
    "sender_billing_address": {
      "first_name": "John",
      "last_name": "Doe",
      "country": "US",
      "city": "Denver",
      "state": "CO",
      "zip": "96002",
      "address": "1st Street",
      "phone": "375444444444"
    },
    "recipient_credit_card": {
      "token": "b4469f38-cec7-4f55-a86d-2ab2dc300e0b"
    },
    "additional_data": {
      "document": {
        "type": "PASSPORT",
        "issuer": "Organization name",
        "series": "MP",
        "number": "1234567890",
        "issued_at": "2010-03-12",
        "valid_until": "2025-03-12"
      }
    }
  }
}
Ответ

Параметры ответа копируют параметры запроса за исключением дополнительных:

Параметр Тип Описание
transaction object
uid * обязательный
string UID обработанной транзакции.
status * обязательный
string Статус обработанной транзакции.
message * обязательный
string Сообщение с результатом запроса.
type * обязательный
string Тип транзакции.
tracking_id * обязательный
string Значение параметра tracking_id из запроса.
language * обязательный
string Значение параметра language из запроса или en, если параметр не был передан.
redirect_url * обязательный
string URL страницы эквайера, на который требуется направить клиента для завершения операции выплаты средств.
Используется в схеме обработке транзакций с редиректом. Уточните у Службы технической поддержки, работает ли ваш эквайер по такой схеме.
payment_method_type * обязательный
string Способ оплаты, используется для завершения транзакции:

credit_card
credit_card object
brand * required
string Определенный бренд карты: visa, master, jcb, discover, dinersclub, amex, belkart или unionpay.
last_4 * required
string Последние 4 цифры карты.
first_1 * required
string Первая цифра карты.
stamp * required
string Хэш карты. Постоянная величина, даже если дата окончания действия карты или владелец изменены.
token * required
string Токен карты. Позволяет сохранять данные клиентов и производить оплату, когда они делают покупку или вы возобновляете свои услуги.
receipt_url * обязательный
string Ссылка на квитанцию обработанной транзакции
payout object
auth_code * обязательный
string Код авторизации.
bank_code * обязательный
string Код ответа операции в банковской системе.
rrn * обязательный
string Номер операции в международной платёжной системе. ID транзакции, выданный сетью обработки карт.
ref_id * обязательный
string Номер операции в системе банка.
message * обязательный
string Сообщение от системы банка.
status * обязательный
string Статус обработанной банком-эквайером транзакции.
Пример ответа
{
  "transaction": {
    "uid": "1-d43572b244",
    "status": "successful",
    "amount": 100,
    "currency": "RUB",
    "description": "Test transaction ütf",
    "type": "payout",
    "payment_method_type": "credit_card",
    "tracking_id": "tracking_id_000",
    "message": "Successfully processed",
    "test": false,
    "created_at": "2021-07-01T13:44:56.936Z",
    "updated_at": "2021-07-01T13:44:57.228Z",
    "paid_at": "2021-07-01T13:44:57.217Z",
    "manually_corrected_at": null,
    "language": "en",
    "redirect_url": "http://127.0.0.1:9887/process/1-d43572b244",
    "credit_card": {
      "holder": "John Doe",
      "stamp": "e8a7e0cb4816c2bb608ee9a02f4f091a4982875b750bc7aba893f0ff688e2557",
      "brand": "master",
      "last_4": "4444",
      "first_1": "5",
      "bin": "555555",
      "issuer_country": null,
      "issuer_name": null,
      "product": null,
      "exp_month": 12,
      "exp_year": 2022,
      "token_provider": null,
      "token": null
    },
    "status_code": null,
    "recipient": {
      "ip": "127.0.0.1",
      "email": "john@example.com",
      "device_id": null,
      "birth_date": "1990-10-20"
    },
    "recipient_credit_card": {
      "holder": "John Doe",
      "stamp": "e8a7e0cb4816c2bb608ee9a02f4f091a4982875b750bc7aba893f0ff688e2557",
      "brand": "master",
      "last_4": "4444",
      "first_1": "5",
      "bin": "555555",
      "issuer_country": null,
      "issuer_name": null,
      "product": null,
      "exp_month": 12,
      "exp_year": 2022,
      "token_provider": null,
      "token": null
    },
    "recipient_billing_address": {
      "first_name": "John",
      "last_name": "Doe",
      "address": "1st Street",
      "country": "US",
      "city": "Denver",
      "zip": "96002",
      "state": "CO",
      "phone": "375444444444"
    },
    "receipt_url": "default_domain/customer/transactions/1-d43572b244/57cc78ebf6d0f22a599bbf039d3ba858fff6e2102f867da09cf3972fe84a8ec8",
    "sender_billing_address": {
      "first_name": "John",
      "last_name": "Doe",
      "address": "1st Street",
      "country": "US",
      "city": "Denver",
      "zip": "96002",
      "state": "CO",
      "phone": "375444444444"
    },
    "id": "1-d43572b244",
    "additional_data": {
      "document": {
        "type": "PASSPORT",
        "issuer": "Organization name",
        "series": "MP",
        "number": "1234567890",
        "issued_at": "2010-03-12",
        "valid_until": "2025-03-12"
      },
      "payout": {
        "auth_code": null,
        "bank_code": null,
        "rrn": null,
        "ref_id": "1569310086280783205",
        "message": "Successfully processed",
        "amount": 100,
        "currency": "RUB",
        "billing_descriptor": null,
        "gateway_id": 1,
        "status": "successful"
      }
    }
  }
}