Sign in
Выплаты

Создание выплаты

Используйте этот запрос, чтобы создать в ЮKassa объект выплаты: https://yookassa.ru/developers/api#payout_object. В запросе необходимо передать сумму выплаты, данные о способе получения выплаты (например, номер кошелька ЮMoney), описание выплаты и при необходимости дополнительные параметры, связанные с той функциональностью, которую вы хотите использовать. Передаваемые параметры и данные для аутентификации: https://yookassa.ru/developers/using-api/interaction-format#auth запросов зависят от того, какое платежное решение вы используете — обычные выплаты: https://yookassa.ru/developers/payouts/overview или выплаты в рамках Безопасной сделки: https://yookassa.ru/developers/solutions-for-platforms/safe-deal/basics.

post/payouts

Headers

Idempotence-Keystring required

Request body

payout_tokenstring

Токенизированные данные для выплаты. Например, синоним банковской карты. Обязательный параметр, если не передан payout_destination_data или payment_method_id.

payment_method_idstring

Идентификатор сохраненного способа оплаты, данные которого нужно использовать для проведения выплаты. Подробнее о выплатах с использованием идентификатора сохраненного способа оплаты: https://yookassa.ru/developers/payouts/scenario-extensions/multipurpose-token Обязательный параметр, если не передан payout_destination_data или payout_token.

descriptionstring

Описание транзакции (не более 128 символов). Например: «Выплата по договору 37».

metadataMetadata

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

Example request

{
  "amount": {
    "value": "1000.00",
    "currency": "RUB"
  },
  "payout_destination_data": {
    "account_number": "41001614575714"
  },
  "payout_token": "hoiCz_UVAdi_eKEthqhjRIJp.SC.001.202101",
  "payment_method_id": "1da5c87d-0984-50e8-a7f3-8de646dd9ec9",
  "description": "Оплата заказа № 72",
  "deal": {
    "id": "dl-d68d2fe4-2abb-47e5-8112-32e28f87fb52"
  },
  "personal_data": [
    {
      "id": "pd-22e12f66-000f-5000-8000-18db351245c7"
    }
  ]
}

Response

Запрос принят в обработку и успешно обработан.

idstring required

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

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

Статус выплаты. Возможные значения: pending — выплата создана, но деньги еще не поступили на указанное платежное средство пользователя (например, ЮKassa ждет подтверждения от эквайера, что перевод успешен); succeeded — выплата успешно завершена, деньги переведены на платежное средство пользователя (финальный и неизменяемый статус); canceled — выплата отменена, инициатор и причина отмены указаны в объекте cancellation_details (финальный и неизменяемый статус).

descriptionstring

Описание транзакции (не более 128 символов). Например: «Выплата по договору 37».

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

succeeded_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. Пример: 2017-11-03T11:52:42.312Z Обязательный параметр для выплат в статусе succeeded.

metadataMetadata

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

testboolean required

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

Example response

{
  "id": "po-27ced252-0025-5000-9000-0a682a8bab8f",
  "amount": {
    "value": "1000.00",
    "currency": "RUB"
  },
  "payout_destination": {
    "card": {
      "first6": "427918",
      "last4": "7918",
      "issuer_country": "RU",
      "issuer_name": "Sberbank"
    }
  },
  "description": "Оплата заказа № 72",
  "created_at": "2020-07-03T11:52:31.827Z",
  "succeeded_at": "2020-07-03T11:52:42.312Z",
  "deal": {
    "id": "dl-d68d2fe4-2abb-47e5-8112-32e28f87fb52"
  },
  "self_employed": {
    "id": "se-7474a846-a965-498d-bbf9-1c3c8907cbbd"
  },
  "receipt": {
    "service_name": "Оказание услуг по доставке товара",
    "npd_receipt_id": "208jd98zqe",
    "url": "https://www.nalog.gov.ru/api/v1/receipt/208jd98zqe/print",
    "amount": {
      "value": "1000.00",
      "currency": "RUB"
    }
  },
  "cancellation_details": {
    "reason": "insufficient_funds"
  }
}

Changes