Sign in
Платежи

Информация о платеже

Запрос позволяет получить информацию о текущем состоянии платежа по его уникальному идентификатору.

get/payments/{payment_id}

Path parameters

payment_idstring required

Идентификатор платежа в ЮKassa.

Example:1da5c87d-0984-50e8-a7f3-8de646dd9ec9

Идентификатор платежа.

Response

Запрос успешно обработан

idstring required

Идентификатор платежа в ЮKassa.

status'pending' | 'waiting_for_capture' | 'succeeded' | 'canceled' required

Статус платежа. Возможные значения: pending, waiting_for_capture, succeeded и canceled. Подробнее про жизненный цикл платежа: https://yookassa.ru/developers/payment-acceptance/getting-started/payment-process#lifecycle

descriptionstring

Описание транзакции (не более 128 символов), которое вы увидите в личном кабинете ЮKassa, а пользователь — при оплате. Например: «Оплата заказа № 72 для user@yoomoney.ru».

captured_atstring date-time

Время подтверждения платежа. Указывается по UTC: https://ru.wikipedia.org/wiki/%D0%92%D1%81%D0%B5%D0%BC%D0%B8%D1%80%D0%BD%D0%BE%D0%B5_%D0%BA%D0%BE%D0%BE%D1%80%D0%B4%D0%B8%D0%BD%D0%B8%D1%80%D0%BE%D0%B2%D0%B0%D0%BD%D0%BD%D0%BE%D0%B5_%D0%B2%D1%80%D0%B5%D0%BC%D1%8F и передается в формате ISO 8601: https://en.wikipedia.org/wiki/ISO_8601.

created_atstring date-time required

Время создания заказа. Указывается по UTC: https://ru.wikipedia.org/wiki/%D0%92%D1%81%D0%B5%D0%BC%D0%B8%D1%80%D0%BD%D0%BE%D0%B5_%D0%BA%D0%BE%D0%BE%D1%80%D0%B4%D0%B8%D0%BD%D0%B8%D1%80%D0%BE%D0%B2%D0%B0%D0%BD%D0%BD%D0%BE%D0%B5_%D0%B2%D1%80%D0%B5%D0%BC%D1%8F и передается в формате ISO 8601: https://en.wikipedia.org/wiki/ISO_8601. Пример: 2017-11-03T11:52:31.827Z

expires_atstring date-time

Время, до которого вы можете бесплатно отменить или подтвердить платеж. В указанное время платеж в статусе waiting_for_capture будет автоматически отменен. Указывается по UTC: https://ru.wikipedia.org/wiki/%D0%92%D1%81%D0%B5%D0%BC%D0%B8%D1%80%D0%BD%D0%BE%D0%B5_%D0%BA%D0%BE%D0%BE%D1%80%D0%B4%D0%B8%D0%BD%D0%B8%D1%80%D0%BE%D0%B2%D0%B0%D0%BD%D0%BD%D0%BE%D0%B5_%D0%B2%D1%80%D0%B5%D0%BC%D1%8F и передается в формате ISO 8601: https://en.wikipedia.org/wiki/ISO_8601. Пример: 2017-11-03T11:52:31.827Z

testboolean required

Признак тестовой операции.

paidboolean required

Признак оплаты заказа.

refundableboolean required

Возможность провести возврат по API.

receipt_registration'pending' | 'succeeded' | 'canceled'

Статус регистрации чека. Возможные значения: pending — данные в обработке; succeeded — чек успешно зарегистрирован; canceled — чек зарегистрировать не удалось; если используете Чеки от ЮKassa: https://yookassa.ru/developers/payment-acceptance/receipts/54fz/yoomoney/basics, обратитесь в техническую поддержку, в остальных случаях сформируйте чек вручную. Присутствует, если вы используете решения ЮKassa для отправки чеков в налоговую: https://yookassa.ru/developers/payment-acceptance/receipts/basics.

metadataMetadata

Любые дополнительные данные, которые нужны вам для работы (например, ваш внутренний идентификатор заказа). Передаются в виде набора пар «ключ-значение» и возвращаются в ответе от ЮKassa. Ограничения: максимум 16 ключей, имя ключа не больше 32 символов, значение ключа не больше 512 символов, тип данных — строка в формате UTF-8.

merchant_customer_idstring

Идентификатор покупателя в вашей системе, например электронная почта или номер телефона. Не более 200 символов. Присутствует, если вы хотите запомнить банковскую карту и отобразить ее при повторном платеже в виджете ЮKassa: https://yookassa.ru/developers/payment-acceptance/integration-scenarios/widget/basics.

Example response

{
  "id": "1da5c87d-0984-50e8-a7f3-8de646dd9ec9",
  "status": "succeeded",
  "amount": {
    "value": "1000.00",
    "currency": "RUB"
  },
  "income_amount": {
    "value": "1000.00",
    "currency": "RUB"
  },
  "description": "Оплата заказа № 72",
  "recipient": {
    "account_id": "123",
    "gateway_id": "456"
  },
  "payment_method": {
    "type": "bank_card",
    "id": "1da5c87d-0984-50e8-a7f3-8de646dd9ec9",
    "saved": true,
    "status": "active",
    "title": "Основная карта",
    "card": {
      "first6": "427918",
      "last4": "7918",
      "expiry_year": "2017",
      "expiry_month": "07",
      "card_product": {
        "code": "MCP",
        "name": "MIR Privilege"
      },
      "issuer_country": "RU",
      "issuer_name": "Sberbank"
    }
  },
  "captured_at": "2017-11-03T11:52:31.827Z",
  "created_at": "2017-11-03T11:52:31.827Z",
  "expires_at": "2017-11-03T11:52:31.827Z",
  "confirmation": {
    "type": "redirect",
    "enforce": true
  },
  "refunded_amount": {
    "value": "1000.00",
    "currency": "RUB"
  },
  "paid": true,
  "refundable": true,
  "receipt_registration": "succeeded",
  "cancellation_details": {
    "reason": "insufficient_funds"
  },
  "authorization_details": {
    "rrn": "603668680243",
    "auth_code": "062467",
    "three_d_secure": {
      "applied": true
    }
  },
  "transfers": [
    {
      "account_id": "123",
      "amount": {
        "value": "1000.00",
        "currency": "RUB"
      },
      "status": "succeeded",
      "platform_fee_amount": {
        "value": "1000.00",
        "currency": "RUB"
      },
      "description": "Заказ маркетплейса №72"
    }
  ],
  "deal": {
    "id": "dl-d68d2fe4-2abb-47e5-8112-32e28f87fb52",
    "settlements": [
      {
        "type": "payout",
        "amount": {
          "value": "1000.00",
          "currency": "RUB"
        }
      }
    ]
  },
  "merchant_customer_id": "user@test.merchant",
  "invoice_details": {
    "id": "in-e44e8088-bd73-43b1-959a-954f3a7d0c54"
  }
}

Changes