Main payout scenario

What scenarios there are

Payouts via API can be performed using a token or without a token.

The choice of scenario depends on the how the payment is received and whether you have a PCI DSS security certificate.

Payout to a bank card without PCI DSS

In this case, you cannot store and send the recipient's bank card details with open parameters, which means the payout can only be performed using a token, via the tokenization widget.

The widget allows you to obtain the user's card details and pass them within your request in a secure tokenized form.

How to perform a payout to a bank card via widget

Payout to a bank card with PCI DSS, bank account, QIWI or YooMoney (Yandex.Money) wallet

No need to use a token: all the payout parameters can be passed with open parameters.

The payment session

All API operations are carried out within a payment session (PaymentSession) – payouts, payments, and refunds. You can perform payouts in two ways:

  • initiate the payout when you start the session (as a single request, session/init/payout);
  • or create a session and only then perform the payout (making two requests: session/create and session/start/payout). for example, to immediately obtain the session identifier and use it to monitor what is happening with the payout.

Main payout scenario

These steps are necessary for payouts with the widget only

  1. You send a request for token creation to access the JavaScript library.
  2. You create the widget with this token, show it to the user, and obtain card details in tokenized form.

Tokenized card details can be saved so you can send money to that card later.

  1. You perform the payout however you prefer:

In the request for payout creation, you pass the method of receiving the payment and all the parameters mandatory for that method.

  1. Make sure Bank 131 is ready to perform a payment and waits for your approval. There are two ways:
  • get from Bank 131 the webhook ready_to_confirm
  • or send the request session/status and wait until the value confirm is returned in the field session.next_action.
  1. You confirm (confirm_request) or cancel (cancel_request).
  2. Bank 131 sends you the payment_finished webhook containing the result of the payout. If the status is succeeded, the payout has been performed successfully.

A payout to a Russian bank account may be returned within 5 days. In this case, you will receive the webhook payment_refunded. Learn more about payout refunds

The scenario of payouts to self-employed people

If you are paying out to self-employed people, the scenario will be slightly different.

More about payouts to the self-employed

One-request payout

For payouts to bank accounts or to cards with PCI DSS, there is a simplified scenario: you send the payout using the session/init/payout request and obtain the result from the payment_finished webhook or using the session/status method.

How to perform a one-request payout

Payout statuses

The status of the payout is returned in the status field of the Payment object. To query it, wait for a webhook from Bank 131 or send a session/status request with the identifier of the session containing this payout. You can choose any of these options or combine them as you wish.

Possible payout statuses:

  • in_progress — the payment is being processed;
  • pending — awaiting your confirmation (confirm_request) or cancelation (cancel_request);
  • succeeded — the payout has completed successfully;
  • failed — an error occured while processing the payout.
← How it all worksPayout refunds →