Payment) содержит всю информацию о платеже, актуальную на текущий момент времени.
Он формируется при создании платежа и приходит в ответ на любой запрос, связанный с платежами.pending, waiting_for_capture,
succeeded и canceled. Подробнее про жизненный цикл платежа amount за вычетом комиссии ЮKassa.
Если вы партнер и для аутентификации запросов используете OAuth-токен, запросите у магазина право на получение информации о комиссиях при платежах.pending — данные в обработке;succeeded — чек успешно зарегистрирован;canceled — чек зарегистрировать не удалось; если используете Чеки от ЮKassa, обратитесь в техническую поддержку, в остальных случаях сформируйте чек вручную.canceled: кто отменил платеж и по какой причине. Подробнее про неуспешные платежи { "id": "22e12f66-000f-5000-8000-18db351245c7", "status": "waiting_for_capture", "paid": true, "amount": { "value": "2.00", "currency": "RUB" }, "authorization_details": { "rrn": "10000000000", "auth_code": "000000", "three_d_secure": { "applied": true } }, "created_at": "2018-07-18T10:51:18.139Z", "description": "Заказ №72", "expires_at": "2018-07-25T10:52:00.233Z", "metadata": {}, "payment_method": { "type": "bank_card", "id": "22e12f66-000f-5000-8000-18db351245c7", "saved": false, "card": { "first6": "555555", "last4": "4444", "expiry_month": "07", "expiry_year": "2022", "card_type": "MasterCard", "issuer_country": "RU", "issuer_name": "Sberbank" }, "title": "Bank card *4444" }, "recipient": { "account_id": "100500", "gateway_id": "100700" }, "refundable": false, "test": false, "income_amount": { "value": "1.97", "currency": "RUB" } }
Payment.
Он содержит всю необходимую информацию для проведения оплаты (сумму, валюту и статус).
У платежа линейный жизненный цикл, он последовательно переходит из статуса в статус.payment_method). Вы можете не передавать этот объект в запросе. В этом случае пользователь будет выбирать способ оплаты на стороне ЮKassa.true инициирует создание многоразового payment_method.curl https://api.yookassa.ru/v3/payments \ -X POST \ -u <Идентификатор магазина>:<Секретный ключ> \ -H 'Idempotence-Key: <Ключ идемпотентности>' \ -H 'Content-Type: application/json' \ -d '{ "amount": { "value": "2.00", "currency": "RUB" }, "payment_method_data": { "type": "bank_card" }, "confirmation": { "type": "redirect", "return_url": "https://www.example.com/return_url" }, "description": "Заказ №72" }'
{ "id": "22e12f66-000f-5000-8000-18db351245c7", "status": "pending", "paid": false, "amount": { "value": "2.00", "currency": "RUB" }, "confirmation": { "type": "redirect", "return_url": "https://www.example.com/return_url", "confirmation_url": "https://yoomoney.ru/payments/external/confirmation?orderId=22e12f66-000f-5000-8000-18db351245c7" }, "created_at": "2018-07-18T10:51:18.139Z", "description": "Заказ №72", "metadata": {}, "payment_method": { "type": "bank_card", "id": "22e12f66-000f-5000-8000-18db351245c7", "saved": false }, "recipient": { "account_id": "100500", "gateway_id": "100700" }, "refundable": false, "test": false }
created_at.gte=2018-07-18T10:51:18.139Zcreated_at.gt=2018-07-18T10:51:18.139Zcreated_at.lte=2018-07-18T10:51:18.139Zcreated_at.lt=2018-07-18T10:51:18.139Zcaptured_at.gte=2018-07-18T10:51:18.139Zcaptured_at.gt=2018-07-18T10:51:18.139Zcaptured_at.lte=2018-07-18T10:51:18.139Zcaptured_at.lt=2018-07-18T10:51:18.139Zpayment_method=bank_cardstatus=succeededlimit=5010cursor=37a5c87d-3984-51e8-a7f3-8de646d39ec15next_cursor, полученное в ответе на предыдущий запрос. Используется, если в списке больше объектов, чем может поместиться в выдаче (limit), и конец выдачи не достигнут. Пример использования limit, список будет выводиться фрагментами.
В этом случае в ответе на запрос вернется фрагмент списка и параметр next_cursor с указателем на следующий фрагмент.curl https://api.yookassa.ru/v3/payments \ -u <Идентификатор магазина>:<Секретный ключ>
{ "type": "list", "items": [ { "id": "22e12f66-000f-5000-8000-18db351245c7", "status": "waiting_for_capture", "paid": true, "amount": { "value": "2.00", "currency": "RUB" }, "created_at": "2018-07-18T10:51:18.139Z", "description": "Заказ №72", "expires_at": "2018-07-25T10:52:00.233Z", "metadata": {}, "payment_method": { "type": "bank_card", "id": "22e12f66-000f-5000-8000-18db351245c7", "saved": false, "card": { "first6": "555555", "last4": "4444", "expiry_month": "07", "expiry_year": "2022", "card_type": "MasterCard", "issuer_country": "RU", "issuer_name": "Sberbank" }, "title": "Bank card *4444" }, "recipient": { "account_id": "100500", "gateway_id": "100700" }, "refundable": false, "test": false } ], "next_cursor": "37a5c87d-3984-51e8-a7f3-8de646d39ec15" }
curl https://api.yookassa.ru/v3/payments/{payment_id} \ -u <Идентификатор магазина>:<Секретный ключ>
{ "id": "22e12f66-000f-5000-8000-18db351245c7", "status": "waiting_for_capture", "paid": true, "amount": { "value": "2.00", "currency": "RUB" }, "created_at": "2018-07-18T10:51:18.139Z", "description": "Заказ №72", "expires_at": "2018-07-25T10:52:00.233Z", "metadata": {}, "payment_method": { "type": "bank_card", "id": "22e12f66-000f-5000-8000-18db351245c7", "saved": false, "card": { "first6": "555555", "last4": "4444", "expiry_month": "07", "expiry_year": "2022", "card_type": "MasterCard", "issuer_country": "RU", "issuer_name": "Sberbank" }, "title": "Bank card *4444" }, "recipient": { "account_id": "100500", "gateway_id": "100700" }, "refundable": false, "test": false }
succeeded.
Это значит, что вы можете выдать товар или оказать услугу пользователю.waiting_for_capture и только в течение определенного времени (зависит от способа оплаты).
Если вы не подтвердите платеж в отведенное время, он автоматически перейдет в статус canceled, и деньги вернутся пользователю.curl https://api.yookassa.ru/v3/payments/{payment_id}/capture \ -X POST \ -u <Идентификатор магазина>:<Секретный ключ> \ -H 'Idempotence-Key: <Ключ идемпотентности>' \ -H 'Content-Type: application/json' \ -d '{ "amount": { "value": "2.00", "currency": "RUB" } }'
{ "id": "22e12f66-000f-5000-8000-18db351245c7", "status": "succeeded", "paid": true, "amount": { "value": "2.00", "currency": "RUB" }, "captured_at": "2018-07-18T11:17:33.483Z", "created_at": "2018-07-18T10:51:18.139Z", "description": "Заказ №72", "metadata": {}, "payment_method": { "type": "bank_card", "id": "22e12f66-000f-5000-8000-18db351245c7", "saved": false, "card": { "first6": "555555", "last4": "4444", "expiry_month": "07", "expiry_year": "2022", "card_type": "MasterCard", "issuer_country": "RU", "issuer_name": "Sberbank" }, "title": "Bank card *4444" }, "recipient": { "account_id": "100500", "gateway_id": "100700" }, "refundable": true, "refunded_amount": { "value": "0.00", "currency": "RUB" }, "test": false }
waiting_for_capture.
Отмена платежа значит, что вы не готовы выдать пользователю товар или оказать услугу.
Как только вы отменяете платеж, мы начинаем возвращать деньги на счет плательщика.
Для платежей банковскими картами, из кошелька ЮMoney или через SberPay отмена происходит мгновенно.
Для остальных способов оплаты возврат может занимать до нескольких дней.curl https://api.yookassa.ru/v3/payments/{payment_id}/cancel \ -X POST \ -u <Идентификатор магазина>:<Секретный ключ> \ -H 'Idempotence-Key: <Ключ идемпотентности>' \ -H 'Content-Type: application/json' \ -d '{ }'
{ "id": "22e12f66-000f-5000-8000-18db351245c7", "status": "canceled", "paid": false, "amount": { "value": "2.00", "currency": "RUB" }, "created_at": "2018-07-18T10:51:18.139Z", "description": "Заказ №72", "metadata": {}, "payment_method": { "type": "bank_card", "id": "22e12f66-000f-5000-8000-18db351245c7", "saved": false, "card": { "first6": "555555", "last4": "4444", "expiry_month": "07", "expiry_year": "2022", "card_type": "MasterCard", "issuer_country": "RU", "issuer_name": "Sberbank" }, "title": "Bank card *4444" }, "recipient": { "account_id": "100500", "gateway_id": "100700" }, "refundable": false, "test": false }
payment_method) исходного платежа.
При оплате банковской картой деньги возвращаются на карту, которая была использована для проведения платежа. Как проводить возвраты