Выдача и возврат перевода
На данной странице вы найдете методы и вебхуки, которые понадобятся платежному партнеру для выдачи денежных средств получателю при успешном переводе или возврата денег отправителю.
Обратите внимание, что перевод можно выдать или вернуть только полностью.
Общий порядок запросов следующий:
- Получатель обращается к платежному партнеру с паспортом и кодом перевода, полученным при его отправлении.
- Платежный партнер инициирует платежную сессию на выдачу перевода и передает в Банк подробную информацию о Получателе.
- Банк создает транзакцию и возвращает результат создания.
- После получения ответа необходимо дождаться вебхука
ready_to_confirm
, в котором будет подробная информация о сумме к выплате и данные о получателе. - После получения вебхука
ready_to_confirm
необходимо будет подтвердить транзакцию методомsession/confirm
или отклонить ее методомsession/cancel
. - Для завершения транзакции дождитесь вебхука
payment_finished
.
Метод POST…/api/v1/cash/payout/session/init
Метод предназначен для старта выдачи перевода получателю или возврата денег отправителю. Набор параметров в обоих случаях одинаков. Чтобы вернуть перевод отправителю, данные отправителя (participant_details.sender
) и получателя перевода (participant_details.recipient
) в запросе должны совпадать.
Обратите внимание, что в параметр
tcn_code_encoded
передается код перевода, который необходимо обернуть в BASE64.
Параметры запроса
Название | Обязательность | Тип данных | Описание |
---|---|---|---|
tcn_code_encoded | + | string | Контрольный номер перевода, полученный от Получателя и обернутый в BASE64. Пример: “MzU4MDctMjM1ODk=” |
payment_method | + | object | Информация о методе платежа |
type | + | string | Способ платежа. Возможное значение: moneysend |
moneysend | + | object | Детали платежа через Moneysend |
amount_details | + | object | Сумма и валюта к выдаче |
amount | + | int | Сумма к выдаче |
currency | + | string | Валюта к выдаче |
participant_details | + | object | Информация об отправителе, получателе и точке выдачи |
recipient | + | object | Информация о получателе |
citizenship_country_iso3 | + | string | Страна гражданства получателя по стандарту ISO3166-1 alpha-3 |
first_name | + | string | Имя получателя |
last_name | + | string | Фамилия получателя |
middle_name | - | string | Отчество получателя |
country_iso3 | + | string | Страна регистрации получателя по стандарту ISO3166-1 alpha-3 |
state | - | string | Регион или район регистрации получателя |
city | + | string | Населенный пункт регистрации получателя |
postal_code | - | string | Почтовый индекс места регистрации получателя |
street | - | string | Название улицы места регистрации получателя |
building | + | string | Номер дома места регистрации получателя |
flat | - | string | Квартира места регистрации получателя |
tax_reference | - | string | 12-значный ИНН получателя |
date_of_birth | + | string | Дата рождения получателя. Убедитесь, что возраст получателя 18+ |
contacts | + | object | Контакты получателя |
phone | + | object | Телефон получателя |
full_number | + | string | Полный номер телефона получателя в формате +<код страны><номер> |
country_iso3 | + | string | Код страны, к которой относится номер телефона получателя, в формате ISO3 |
operator_code | + | string | Код оператора телефонного номера получателя |
short_number | + | string | Номер телефона получателя без кода оператора |
- | string | Email получателя | |
identity_document | + | object | Данные документа, удостоверяющего личность получателя |
id_type | + | string | Тип документа, удостоверяющего личность получателя. Возможные значения: — Паспорт иностранного гражданина — Паспорт гражданина Российской Федерации |
id_number | + | string | Серия и номер документа, удостоверяющего личность получателя (без пробелов) |
issue_date | + | string | Дата выдачи документа, удостоверяющего личность получателя, в формате ГГГГ-ММ-ДД |
id_expiration_date | - | string | Дата окончания срока действия документа, удостоверяющего личность получателя, в формате ГГГГ-ММ-ДД. Обязательно для заполнения при наличии в документе. Если его нет, просто не передавайте это поле |
division_code | - | string | Код подразделения, выдавшего документ, удостоверяющий личность получателя. Обязательно для заполнения при наличии в документе |
issued_by | - | string | Название подразделения, выдавшего документ, удостоверяющий личность получателя. Обязательно для заполнения при наличии в документе |
documents_foreigner | - | object | Параметры документа получателя-нерезидента. Обязательно для заполнения, если получатель является иностранным гражданином и выплата происходит в РФ |
id_type | + | string | Тип документа, удостоверяющего личность отправителя-нерезидента. Возможные значения: — Вид на жительство — Разрешение на временное проживание — Миграционная карта — Виза |
issued_by | - | string | Название органа, выдавшего документ, удостоверяющий личность получателя |
issue_date | + | string | Дата начала срока действия документа, удостоверяющего личность получателя, в формате ГГГГ-ММ-ДД |
id_expiration_date | + | string | Дата окончания срока действия документа, удостоверяющего личность получателя, в формате ГГГГ-ММ-ДД |
service_point | + | object | Точка выдачи денежных средств |
id | - | string | ID точки выдачи |
name | - | string | Название точки выдачи |
country_iso3 | + | string | Страна точки выдачи. Формат ISO 3166-1 alpha-3 |
state | - | string | Регион/район нахождения точки выдачи |
city | + | string | Населенный пункт нахождения точки выдачи |
oktmo | - | string | Код ОКТМО расположения точки выдачи средств |
street | - | string | Улица нахождения точки выдачи |
house | - | string | Здание нахождения точки выдачи |
terminal_id | - | string | Номер терминала/кассы |
source_of_money | - | string | Источник происхождения денег |
description | - | string | Дополнительная информация о переводе |
sender | + | object | Информация об отправителе |
citizenship_country_iso3 | + | string | Страна гражданства отправителя по стандарту ISO3166-1 alpha-3 |
first_name | + | string | Имя отправителя |
last_name | + | string | Фамилия отправителя |
middle_name | - | string | Отчество отправителя |
contacts | object | Контакты отправителя | |
phone | object | Телефон отправителя | |
full_number | + | string | Полный номер телефона отправителя в формате +<код страны><номер> |
country_iso3 | + | string | Код страны, к которой относится номер телефона отправителя, в формате ISO3 |
operator_code | + | string | Код оператора телефонного номера отправителя |
short_number | + | string | Номер телефона отправителя без кода оператора |
- | string | Email отправителя | |
cash_details | + | object | Дополнительная информация о платеже наличными |
shift | + | string | Номер кассовой смены |
Пример запроса
{
"tcn_code_encoded": "NTkyMjM3LTg5MjEzNDk5",
"payment_method": {
"type": "moneysend",
"moneysend": {}
},
"cash_details": {
"shift": "159"
},
"amount_details": {
"amount": 1000,
"currency": "rub"
},
"participant_details": {
"recipient": {
"citizenship_country_iso3": "AUS",
"first_name": "Ivan",
"last_name": "Sidorov",
"middle_name": "Ivanovich",
"country_iso3": "RUS",
"state": "New York",
"city": "Kazan",
"postal_code": "420000",
"street": "Nerkasova",
"building": "1",
"flat": "131",
"tax_reference": "123456789012",
"date_of_birth": "2008-01-01",
"identity_document": {
"id_type": "Паспорт гражданина Российской Федерации",
"id_number": "123456789",
"issue_date": "2020-01-01",
"id_expiration_date": "2030-01-01",
"division_code": "165-065",
"issued_by": "OVD Kazani"
},
"documents_foreigner": {
"id_type": "Виза",
"issued_by": "OVD Kazani",
"issue_date": "2020-01-01",
"id_expiration_date": "2030-01-01"
},
"service_point": {
"id": "1",
"name": "point_on_lenina",
"country_iso3": "RUS",
"state": "Moscow",
"city": "Moscow",
"oktmo": "36634436111",
"street": "Lenin avenue",
"house": "1",
"terminal_id": "123124"
},
"source_of_money": "salary",
"description": "salary transfers",
"contacts": {
"phone": {
"full_number": "+79377654321",
"country_iso3": "RUS",
"operator_code": "937",
"short_number": "7654321"
},
"email": "test@test.com"
}
},
"sender": {
"first_name": "Ivan",
"last_name": "Ivanov",
"middle_name": "Ivanovich",
"contacts": {
"phone": {
"full_number": "+79371234567",
"country_iso3": "RUS",
"operator_code": "937",
"short_number": "1234567"
},
"email": "test@test.com"
}
}
}
}
Параметры ответа
Название | Обязательность | Тип данных | Описание |
---|---|---|---|
status | + | string | Статус запроса |
session | + | object | Данные сессии |
id | + | string | ID сессии. Запомните его, он будет нужен для подтверждения/отклонения транзакции или для получения статуса по транзакции |
status | + | string | Текущий статус сессии. Возможные значения |
created_at | + | string | Дата и время создания сессии в формате RFC 3339. Пример: 2022-11-15T15:38:50.255803Z |
updated_at | + | string | Дата и время обновления сессии в формате RFC 3339. Пример: 2022-11-15T15:38:50.255803Z |
error | - | object | Причина ошибки. Возвращается только если была ошибка по сессии |
description | - | string | Описание ошибки |
code | - | string | Код ошибки |
payments | + | array | Данные платежа |
id | + | string | ID платежа |
status | + | string | Текущий статус платежа. Возможные значения |
created_at | + | string | Дата и время создания платежа в формате RFC 3339. Пример: 2022-11-15T15:38:50.255803Z |
payment_method | + | object | Информация о методе платежа |
type | + | string | Способ платежа. Возможное значение: moneysend |
participant_details | + | object | Объект participant_details , переданный в запросе |
recipient | + | object | Информация о получателе |
citizenship_country_iso3 | + | string | Страна гражданства получателя по стандарту ISO3166-1 alpha-3 |
first_name | + | string | Имя получателя |
last_name | + | string | Фамилия получателя |
middle_name | - | string | Отчество получателя |
country_iso3 | + | string | Страна регистрации получателя по стандарту ISO3166-1 alpha-3 |
state | - | string | Регион или район регистрации получателя |
city | + | string | Населенный пункт регистрации получателя |
postal_code | - | string | Почтовый индекс места регистрации получателя |
street | - | string | Название улицы места регистрации получателя |
building | + | string | Номер дома места регистрации получателя |
flat | - | string | Квартира места регистрации получателя |
tax_reference | - | string | 12-значный ИНН получателя |
date_of_birth | + | string | Дата рождения получателя. Убедитесь, что возраст получателя 18+ |
contacts | + | object | Контакты получателя |
phone | + | object | Телефон получателя |
full_number | + | string | Полный номер телефона получателя в формате +<код страны><номер> |
country_iso3 | + | string | Код страны, к которой относится номер телефона получателя, в формате ISO3 |
operator_code | + | string | Код оператора телефонного номера получателя |
short_number | + | string | Номер телефона получателя без кода оператора |
- | string | Email получателя | |
identity_document | + | object | Данные документа, удостоверяющего личность получателя |
id_type | + | string | Тип документа, удостоверяющего личность получателя. Возможные значения: — Паспорт иностранного гражданина — Паспорт гражданина Российской Федерации |
id_number | + | string | Серия и номер документа, удостоверяющего личность получателя (без пробелов) |
issue_date | + | string | Дата выдачи документа, удостоверяющего личность получателя, в формате ГГГГ-ММ-ДД |
id_expiration_date | - | string | Дата окончания срока действия документа, удостоверяющего личность получателя, в формате ГГГГ-ММ-ДД. Обязательно для заполнения при наличии в документе. |
division_code | - | string | Код подразделения, выдавшего документ, удостоверяющий личность получателя. Обязательно при наличии в документе |
issued_by | - | string | Название подразделения, выдавшего документ, удостоверяющий личность получателя. Обязательно при наличии в документе |
documents_foreigner | - | object | Параметры документа получателя-нерезидента. Обязательно, если получатель является иностранным гражданином и выплата происходит в РФ |
id_type | + | string | Тип документа, удостоверяющего личность отправителя-нерезидента. Возможные значения: — Вид на жительство — Разрешение на временное проживание — Миграционная карта — Виза |
issued_by | - | string | Название органа, выдавшего документ, удостоверяющий личность получателя |
issue_date | + | string | Дата начала срока действия документа, удостоверяющего личность получателя, в формате ГГГГ-ММ-ДД |
id_expiration_date | + | string | Дата окончания срока действия документа, удостоверяющего личность получателя, в формате ГГГГ-ММ-ДД |
service_point | + | object | Точка выдачи денежных средств |
id | - | string | ID точки выдачи |
name | - | string | Название точки выдачи |
country_iso3 | + | string | Страна точки выдачи. Формат ISO 3166-1 alpha-3 |
state | - | string | Регион/район нахождения точки выдачи |
city | + | string | Населенный пункт нахождения точки выдачи |
oktmo | - | string | Код ОКТМО расположения точки выдачи средств |
street | - | string | Улица нахождения точки выдачи |
house | - | string | Здание нахождения точки выдачи |
terminal_id | - | string | Номер терминала/кассы |
sender | + | object | Информация об отправителе |
citizenship_country_iso3 | + | string | Страна гражданства отправителя по стандарту ISO3166-1 alpha-3 |
first_name | + | string | Имя отправителя |
last_name | + | string | Фамилия отправителя |
middle_name | - | string | Отчество отправителя |
contacts | object | Контакты отправителя | |
phone | object | Телефон отправителя | |
full_number | + | string | Полный номер телефона отправителя в формате +<код страны><номер> |
country_iso3 | + | string | Код страны, к которой относится номер телефона отправителя, в формате ISO3 |
operator_code | + | string | Код оператора телефонного номера отправителя |
short_number | + | string | Номер телефона отправителя без кода оператора |
customer_verification | object | Данные получателя платежа, указанные при создании транзакции payment | |
first_name | + | string | Имя получателя |
last_name | + | string | Фамилия получателя |
middle_name | - | string | Отчество получателя |
date_of_birth | + | string | Дата рождения получателя. Убедитесь, что возраст получателя 18+ |
contacts | object | Контакты получателя | |
phone | object | Телефон получателя | |
full_number | + | string | Полный номер телефона получателя в формате +<код страны><номер> |
country_iso3 | + | string | Код страны, к которой относится номер телефона получателя, в формате ISO3 |
operator_code | + | string | Код оператора телефонного номера получателя |
short_number | + | string | Номер телефона получателя без кода оператора |
- | string | Email получателя | |
amount_details | + | object | Сумма и валюта к выдаче |
amount | + | int | Сумма к выдаче |
currency | + | string | Валюта к выдаче |
error | - | object | Причина ошибки. Возвращается только если была ошибка по сессии |
description | - | string | Описание ошибки |
code | - | string | Код ошибки |
Пример успешного ответа
В ответе будет присутствовать объект
customer_verification
с информацией по данным отправителя. Нужно сверить полученные данные в объектеcustomer_verification
с данными заявителя в документе, удостоверяющем личность. Если данные расходятся, средства не должны быть выданы.
{
"status": "ok",
"session": {
"id": "ps_3230",
"status": "in_progress",
"created_at": "2022-11-01T02:03:00.000000Z",
"updated_at": "2022-11-01T02:03:00.000000Z",
"payments": [
{
"id": "po_2018",
"status": "in_progress",
"created_at": "2022-11-01T02:03:00.000000Z",
"payment_method": {
"type": "moneysend"
},
"participant_details": {
"recipient": {
"citizenship_country_iso3": "AUS",
"first_name": "Ivan",
"last_name": "Sidorov",
"middle_name": "Ivanovich",
"country_iso3": "RUS",
"state": "New York",
"city": "Kazan",
"postal_code": "420000",
"street": "Nekrasova",
"building": "1",
"flat": "131",
"tax_reference": "123456789012",
"date_of_birth": "2010-01-01",
"contacts": {
"phone": {
"full_number": "+79377654321",
"country_iso3": "RUS",
"operator_code": "937",
"short_number": "7654321"
},
"email": "test@test.com"
},
"identity_document": {
"id_type": "Паспорт гражданина Российской Федерации",
"id_number": "123456789",
"issue_date": "2020-01-01",
"id_expiration_date": "2030-01-01",
"division_code": "165-065",
"issued_by": "OVD Kazani"
},
"documents_foreigner": {
"id_type": "Виза",
"issued_by": "OVD Kazani",
"issue_date": "2020-01-01",
"id_expiration_date": "2030-01-01"
},
"service_point": {
"id": "1",
"name": "point_on_lenina",
"country_iso3": "RUS",
"state": "Moscow",
"city": "Moscow",
"oktmo": "36634436111",
"street": "Lenin avenue",
"house": "1",
"terminal_id": "123124"
},
"source_of_money": "salary",
"description": "salary transfers",
"customer_verification": {
"first_name": "Ivan",
"last_name": "Ivanov",
"middle_name": "Ivanovich",
"date_of_birth": "2010-01-01",
"contacts": {
"phone": {
"full_number": "+79371234567",
"country_iso3": "RUS",
"operator_code": "937",
"short_number": "1234567"
},
"email": "test@test.com"
}
}
},
"sender": {
"first_name": "Ivan",
"last_name": "Ivanov",
"middle_name": "Ivanovich",
"contacts": {
"phone": {
"full_number": "+79371234567",
"country_iso3": "RUS",
"operator_code": "937",
"short_number": "1234567"
},
"email": "test@test.com"
}
}
}
}
]
}
}
Пример неуспешного ответа
{
"error": {
"code": "invalid_request",
"description": "participant_details.recipient.full_name.not_blank"
},
"status": "error"
}
Вебхук ready_to_confirm
Дождитесь этого вебхука, чтобы подтвердить или отклонить выплату.
Содержание вебхука совпадает с содержанием ответа на запрос cash/payout/session/init
.
Пример вебхука
"type": "ready_to_confirm",
{
"status": "ok",
"session": {
"id": "ps_3230",
"status": "in_progress",
"created_at": "2022-11-01T02:03:00.000000Z",
"updated_at": "2022-11-01T02:03:00.000000Z",
"payments": [
{
"id": "po_2018",
"status": "in_progress",
"created_at": "2022-11-01T02:03:00.000000Z",
"payment_method": {
"type": "moneysend"
},
"participant_details": {
"recipient": {
"citizenship_country_iso3": "AUS",
"first_name": "Ivan",
"last_name": "Sidorov",
"middle_name": "Ivanovich",
"country_iso3": "RUS",
"state": "New York",
"city": "Kazan",
"postal_code": "420000",
"street": "Nekrasova",
"building": "1",
"flat": "131",
"tax_reference": "123456789012",
"date_of_birth": "2010-01-01",
"contacts": {
"phone": {
"full_number": "+79377654321",
"country_iso3": "RUS",
"operator_code": "937",
"short_number": "7654321"
},
"email": "test@test.com"
},
"identity_document": {
"id_type": "Паспорт гражданина Российской Федерации",
"id_number": "123456789",
"issue_date": "2020-01-01",
"id_expiration_date": "2030-01-01",
"division_code": "165-065",
"issued_by": "OVD Kazani"
},
"documents_foreigner": {
"id_type": "Виза",
"issued_by": "OVD Kazani",
"issue_date": "2020-01-01",
"id_expiration_date": "2030-01-01"
},
"service_point": {
"id": "1",
"name": "point_on_lenina",
"country_iso3": "RUS",
"state": "Moscow",
"city": "Moscow",
"oktmo": "36634436111",
"street": "lenin avenue",
"house": "1",
"terminal_id": "123124"
},
"source_of_money": "salary",
"description": "salary transfers",
"customer_verification": {
"first_name": "Ivan",
"last_name": "Ivanov",
"middle_name": "Ivanovich",
"date_of_birth": "2010-01-01",
"contacts": {
"phone": {
"full_number": "+79371234567",
"country_iso3": "RUS",
"operator_code": "937",
"short_number": "1234567"
},
"email": "test@test.com"
}
}
},
"sender": {
"first_name": "Ivan",
"last_name": "Ivanov",
"middle_name": "Ivanovich",
"contacts": {
"phone": {
"full_number": "+79371234567",
"country_iso3": "RUS",
"operator_code": "937",
"short_number": "1234567"
},
"email": "test@test.com"
}
}
}
}
]
}
}
Метод POST.../api/v1/session/confirm
Метод предназначен для подтверждения транзакции после получения вебхука ready_to_confirm
и получения подтверждения согласия от Получателя с суммой выплаты.
После того как Партнер вызовет метод, произойдет подтверждение выплаты, отозвать или отклонить выплату будет невозможно.
Параметры запроса
Название | Обязательность | Тип данных | Описание |
---|---|---|---|
session_id | + | string | ID сессии из ответа на инициацию транзакции |
Пример запроса
"session_id": "ps_1"
Параметры ответа
Содержимое ответа совпадает с содержанием ответа на запрос cash/payout/session/init
.
Пример ответа
{
"status": "ok",
"session": {
"id": "ps_3230",
"status": "in_progress",
"created_at": "2022-11-01T02:03:00.000000Z",
"updated_at": "2022-11-01T02:03:00.000000Z",
"payments": [
{
"id": "po_2018",
"status": "in_progress",
"created_at": "2022-11-01T02:03:00.000000Z",
"payment_method": {
"type": "moneysend"
},
"participant_details": {
"recipient": {
"citizenship_country_iso3": "AUS",
"first_name": "Ivan",
"last_name": "Sidorov",
"middle_name": "Ivanovich",
"country_iso3": "RUS",
"state": "New York",
"city": "Kazan",
"postal_code": "420000",
"street": "Nekrasova",
"building": "1",
"flat": "131",
"tax_reference": "123456789012",
"date_of_birth": "2010-01-01",
"contacts": {
"phone": {
"full_number": "+79377654321",
"country_iso3": "RUS",
"operator_code": "937",
"short_number": "7654321"
},
"email": "test@test.com"
},
"identity_document": {
"id_type": "Паспорт гражданина Российской Федерации",
"id_number": "123456789",
"issue_date": "2020-01-01",
"id_expiration_date": "2030-01-01",
"division_code": "165-065",
"issued_by": "OVD Kazani"
},
"documents_foreigner": {
"id_type": "Виза",
"issued_by": "OVD Kazani",
"issue_date": "2020-01-01",
"id_expiration_date": "2030-01-01"
},
"service_point": {
"id": "1",
"name": "point_on_lenina",
"country_iso3": "RUS",
"state": "Moscow",
"city": "Moscow",
"oktmo": "36634436111",
"street": "Lenin avenue",
"house": "1",
"terminal_id": "123124"
},
"source_of_money": "salary",
"description": "salary transfers",
"customer_verification": {
"first_name": "Ivan",
"last_name": "Ivanov",
"middle_name": "Ivanovich",
"date_of_birth": "2010-01-01",
"contacts": {
"phone": {
"full_number": "+79371234567",
"country_iso3": "RUS",
"operator_code": "937",
"short_number": "1234567"
},
"email": "test@test.com"
}
}
},
"sender": {
"first_name": "Ivan",
"last_name": "Ivanov",
"middle_name": "Ivanovich",
"contacts": {
"phone": {
"full_number": "+79371234567",
"country_iso3": "RUS",
"operator_code": "937",
"short_number": "1234567"
},
"email": "test@test.com"
}
}
}
}
]
}
}
Метод POST.../api/v1/session/cancel
Метод предназначен для отмены выдачи денег.
Параметры запроса
Название | Обязательность | Тип данных | Описание |
---|---|---|---|
session_id | + | string | ID сессии из ответа на инициацию транзакции |
Пример запроса
"session_id": "ps_1"
Параметры ответа
Содержимое ответа совпадает с содержанием ответа на запрос cash/payout/session/init
.
Пример ответа
{
"status": "ok",
"session": {
"id": "ps_3230",
"status": "in_progress",
"created_at": "2022-11-01T02:03:00.000000Z",
"updated_at": "2022-11-01T02:03:00.000000Z",
"payments": [
{
"id": "po_2018",
"status": "pending",
"created_at": "2022-11-01T02:03:00.000000Z",
"payment_method": {
"type": "moneysend"
},
"participant_details": {
"recipient": {
"citizenship_country_iso3": "AUS",
"first_name": "Ivan",
"last_name": "Sidorov",
"middle_name": "Ivanovich",
"country_iso3": "RUS",
"state": "New York",
"city": "Kazan",
"postal_code": "420000",
"street": "Nekrasova",
"building": "1",
"flat": "131",
"tax_reference": "123456789012",
"date_of_birth": "2010-01-01",
"contacts": {
"phone": {
"full_number": "+79377654321",
"country_iso3": "RUS",
"operator_code": "937",
"short_number": "7654321"
},
"email": "test@test.com"
},
"identity_document": {
"id_type": "Паспорт гражданина Российской Федерации",
"id_number": "123456789",
"issue_date": "2020-01-01",
"id_expiration_date": "2030-01-01",
"division_code": "165-065",
"issued_by": "OVD Kazani"
},
"documents_foreigner": {
"id_type": "Виза",
"issued_by": "OVD Kazani",
"issue_date": "2020-01-01",
"id_expiration_date": "2030-01-01"
},
"service_point": {
"id": "1",
"name": "point_on_lenina",
"country_iso3": "RUS",
"state": "Moscow",
"city": "Moscow",
"oktmo": "36634436111",
"street": "Lenin avenue",
"house": "1",
"terminal_id": "123124"
},
"source_of_money": "salary",
"description": "salary transfers",
"customer_verification": {
"first_name": "Ivan",
"last_name": "Ivanov",
"middle_name": "Ivanovich",
"date_of_birth": "2010-01-01",
"contacts": {
"phone": {
"full_number": "+79371234567",
"country_iso3": "RUS",
"operator_code": "937",
"short_number": "1234567"
},
"email": "test@test.com"
}
}
},
"sender": {
"first_name": "Ivan",
"last_name": "Ivanov",
"middle_name": "Ivanovich",
"contacts": {
"phone": {
"full_number": "+79371234567",
"country_iso3": "RUS",
"operator_code": "937",
"short_number": "1234567"
},
"email": "test@test.com"
}
}
}
}
]
}
}
Вебхук payment_finished
Банк отправляет этот вебхук, когда завершает транзакцию.
В теле вебхука приходят все параметры транзакции, в том числе ее статус (в поле
status
).
Содержание вебхука будет равно содержанию ответа на cash/payout/session/init
.
Подробное описание вебхука.
Пример вебхука
"type": "payment_finished",
{
"status": "ok",
"session": {
"id": "ps_3230",
"status": "accepted",
"created_at": "2022-11-01T02:03:00.000000Z",
"updated_at": "2022-11-01T02:03:00.000000Z",
"payments": [
{
"id": "po_2018",
"status": "succeeded",
"created_at": "2022-11-01T02:03:00.000000Z",
"payment_method": {
"type": "moneysend"
},
"participant_details": {
"recipient": {
"citizenship_country_iso3": "AUS",
"first_name": "Ivan",
"last_name": "Sidorov",
"middle_name": "Ivanovich",
"country_iso3": "RUS",
"state": "New York",
"city": "Kazan",
"postal_code": "420000",
"street": "Nekrasova",
"building": "1",
"flat": "131",
"tax_reference": "123456789012",
"date_of_birth": "2010-01-01",
"contacts": {
"phone": {
"full_number": "+79377654321",
"country_iso3": "RUS",
"operator_code": "937",
"short_number": "7654321"
},
"email": "test@test.com"
},
"identity_document": {
"id_type": "Паспорт гражданина Российской Федерации",
"id_number": "123456789",
"issue_date": "2020-01-01",
"id_expiration_date": "2030-01-01",
"division_code": "165-065",
"issued_by": "OVD Kazani"
},
"documents_foreigner": {
"id_type": "Виза",
"issued_by": "OVD Kazani",
"issue_date": "2020-01-01",
"id_expiration_date": "2030-01-01"
},
"service_point": {
"id": "1",
"name": "point_on_lenina",
"country_iso3": "RUS",
"state": "Moscow",
"city": "Moscow",
"oktmo": "36634436111",
"street": "Lenin avenue",
"house": "1",
"terminal_id": "123124"
},
"source_of_money": "salary",
"description": "salary transfers",
"customer_verification": {
"first_name": "Ivan",
"last_name": "Ivanov",
"middle_name": "Ivanovich",
"date_of_birth": "2010-01-01",
"contacts": {
"phone": {
"full_number": "+79371234567",
"country_iso3": "RUS",
"operator_code": "937",
"short_number": "1234567"
},
"email": "test@test.com"
}
}
}
},
"sender": {
"first_name": "Ivan",
"last_name": "Ivanov",
"middle_name": "Ivanovich",
"contacts": {
"phone": {
"full_number": "+79371234567",
"country_iso3": "RUS",
"operator_code": "937",
"short_number": "1234567"
},
"email": "test@test.com"
}
}
}
]
}
}