Информация по платежу
Метод возвращает подробности одного платежа: сумму, статус, стороны, назначение. Нужен, чтобы отследить, в каком состоянии платёж и дошёл ли он до получателя.
JSONRPC-метод: get_payment
Поля запроса и ответа — в автогенерируемом описании метода Получить данные платежа.
Когда использовать
- Проверить статус исходящей выплаты — например, дошёл ли платёж по сделке
- Узнать реквизиты плательщика по входящему платежу перед идентификацией
- Получить
document_numberплатёжного поручения после того, как платёжная система его присвоит
Полный список статусов и типов платежа — в обзоре раздела.
Формат ответа зависит от типа платежа
Одно и то же поле payment возвращает разный набор данных в зависимости от того, каким был платёж:
- Обычный платёж — плательщик и получатель в блоках
payerиrecipient - Карточная выплата (
ndfl_to_executor_to_card,payment_contract_to_card) — вместо получателя приходитdeal_idиlinked_payment_id, статусы сокращены доNEW,PAID,CANCELED - СБП-выплата по новому флоу (
payment_contract_by_sbp_v2,ndfl_to_executor_by_sbp_v2) — появляетсяcancel_reason_descriptionс причиной отмены
Точную структуру каждого варианта смотрите в автогенерируемом описании — там развёрнуты все схемы ответа.
Возврат излишне зачисленных средств
Если по входящему платежу типа incoming при идентификации вы указали сумму к возврату, в ответе появляется блок excess_refund с данными созданного платежа-излишка: его идентификатор, сумму и статус.
У самого платежа-излишка (тип excess_refund) в ответе есть поле parent_id — идентификатор родительского входящего платежа, из которого излишек создан.
Возможные ошибки
| Код | Текст |
|---|---|
4412 | Payment not found |