Выплата средств
Данная операция предназначена для перевода денежных средств на счет покупателя в указанной платёжной системе. Не требуется наличие у пользователя успешной операции оплаты. Операция поддерживается не всеми платёжными системами и доступна не для всех торговцев.
Запрос
Для выплаты средств отправьте POST
запрос на https://api.bepaid.by/beyag/transactions/payouts
со следующими параметрами:
Параметр | Тип | Описание |
---|---|---|
request | object | |
amount * обязательный |
integer | Сумма в минимальных денежных единицах. Например, $32.45 должна быть отправлена как 3245 |
currency * обязательный |
string | Валюта транзакции в формате ISO-4217 alpha-3 code. Например, USD . |
description * обязательный |
string | Описание заказа. |
test | boolean | true или false |
tracking_id | string | ID транзакции или заказа в вашей системе. В параметре может быть отправлено несколько значений, разделенных символом ; . Например: "cbe59142-90af-4aea-b5a5-5bf3f66cf3da;f7883cb9-0e26-43a7-beb7-4027cb55d1a6;4a6a89d5-6950-400f" . Если в запросе было передано более одного значения tracking_id , поиск транзакции в личном кабинете может быть осуществлен по любому из них. |
ip | string | IP-адрес клиента, производящего оплату в вашем магазине. |
language | string | Язык вашей страницы оформления заказа. Если параметр установлен и email уведомление о транзакции включено, то bePaid отправит email, язык текста которого будет language . По умолчанию - en . Доступные значения параметра language . |
notification_url | string | URL, на который будут приходить уведомления об оплате. Если не указан - уведомления не высылаются; |
verification_url | string | URL, на который будут приходить запрос на подтверждение транзакции. Формат запроса на подтверждение аналогичен формату ответа транзакции. |
return_url * обязательный |
string | URL, на который будет возвращен плательщик после завершения операции в платёжной системе. |
customer * условно обязательный |
object | Секция информации о покупателе. Проверьте описание платежного метода, чтобы узнать, необходимо ли передавать параметры данной секции. |
first_name | string (60) | Имя клиента. |
last_name | string (60) | Фамилия клиента. |
middle_name | string (60) | Отчество клиента. |
string | email клиента, производящего оплату в вашем магазине. | |
country | string | Страна клиента в ISO 3166-1 alpha-2 формате. |
city | string (120) | Город клиента. |
zip | string (40) | Почтовый индекс клиента. |
address | string (510) | Адрес клиента. |
phone | string (200) | Номер телефона клиента. |
device_id | string | Идентификационный номер устройства клиента. |
method | object | Набор параметров данной секции зависит от того, какую электронную платёжную систему планируется использовать. |
type * обязательный |
string | Бренд. |
Пример запроса
{
"request":{
"amount":100,
"currency":"USD",
"description":"description",
"test": false,
"tracking_id":"your_uniq_number",
"ip":"127.0.0.1",
"language":"en",
"notification_url":"https://your-notification.url",
"return_url":"https://your-success.url",
"customer":{
"first_name":"John",
"last_name":"Doe",
"middle_name": "Mid",
"country":"US",
"city":"Denver",
"zip":"96002",
"address":"1st Street",
"phone":"17777777777",
"device_id":"12312312321fff67"
},
"method":{
"type": "visa"
}
}
}
Ответ
Параметр | Тип | Описание |
---|---|---|
transaction | object | |
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 | string |
method_type * обязательный |
string | Имя платёжной системы или определённый способ оплаты, поддерживаемый подключенной платёжной системой |
receipt_url * обязательный |
string | Ссылка на квитанцию обработанной транзакции. |
payout | object | |
status * обязательный |
string | Статус обработанной транзакции. |
gateway_id * обязательный |
integer | Идентификатор внутреннего платежного шлюза. |
ref_id | string | Номер операции в платёжной системе. |
bank_code | string | Код результата транзакции на стороне провайдера. |
rrn | string | Идентификатор транзакции на стороне провайдера, полученный от третьей стороны. |
message | string | Сообщение от платёжной системы |
message | string | Сообщение с результатом запроса. |
tracking_id | string | Значение параметра tracking_id из запроса. |
test | boolean | true или false . Транзакция будет тестовой при true |
language | string | Значение параметра language из запроса. |
paid_at | string | Дата проведения транзакции. |
billing_address | object | Информация о клиенте. |
first_name | string | Имя клиента. |
middle_name | string | Отчество клиента. |
last_name | string | Фамилия клиента. |
country | string | Страна клиента. |
city | string | Город клиента. |
zip | string | Почтовый индекс клиента. |
address | string | Адрес клиента. |
phone | string | Номер телефона клиента. |
customer | object | Секция информации о покупателе. |
ip | string | IP-адрес клиента. |
string | email клиента. |
Пример ответа
{
"transaction":{
"uid":"2-52671c8733",
"type":"payout",
"status":"successful",
"amount":100,
"currency":"USD",
"description":"Test transaction",
"created_at":"2014-06-11T12:04:59+03:00",
"updated_at":"2014-06-11T12:04:59+03:00",
"tracking_id":"tracking_id_000",
"message":"Successfully processed",
"test":true,
"method_type":":method_name",
"receipt_url": "https://merchant.bepaid.by/customer/transactions/2-52671c8733/11443f39ae75aa1f955a9c9283cd5045bfb0413b65d666f834a9da4e7d3926b5",
"payout":{
"status":"successful",
"gateway_id":85,
"ref_id":"777888",
"message":"The operation was successfully processed",
"bank_code": null,
"rrn": null
},
"customer":{
"ip":"127.0.0.1",
"email":"john@example.com"
},
"billing_address":{
"first_name":"John",
"last_name":"Doe",
"address":"1st Street",
"country":"US",
"city":"Denver",
"zip":"96002",
"phone":17777777777
}
}
}