Standard payout and payment scenarios

The information below will help you understand how to generally perform payouts and payments via API. It includes the main steps, but depending on the selected transaction method or conditions you might need to complete additional actions.

Find the detailed scenarios for each particular case in the Payouts and Payments sections, respectively.

info

When working with bank cards, you have to comply with the PCI DSS standard, but the scope of the requirements depends on the way you perform a payout or a payment. If you use Bank 131 widget, you will have to comply with fewer requirements.

You can decide whether you want to get webhooks. If they are disabled, you will have to send a session/status request each time to understand the next step and transaction results.

Payouts

The steps depend on whether or not you use our widget.

With our widget

1. Send a token request to generate a public token. The token is used to initialize the widget for safely entering card details.

2. Initialize the widget using the received token. After the payer provides their card details, the widget will return you the hash to be used for payouts.

   Save the hash for future payouts.

3. Start the payout in one of the following ways:

   • send a session/create request and then a session/start/payout request with the session identifier and payout details—the recommended option
   • start a session and the payout simultaneously (session/init/payout)

4. Wait for a ready_to_confirm webhook from the Bank, indicating that it is ready to perform the payout and is waiting for your confirmation.

5. Confirm (session/confirm) or cancel (session/cancel) the payout.

   To enable automatic confirmation, contact you manager at Bank 131.

6. Wait for a payment_finished webhook with the payout results. If the status is succeeded, the payout was successful.

Without our widget

1. Start the payout in one of the following ways:

   • send a session/create request and then a session/start/payout request with the session identifier and payout details—the recommended option
   • start a session and the payout simultaneously (session/init/payout)

2. Wait for a ready_to_confirm webhook from the Bank, indicating that it is ready to perform the payout and is waiting for your confirmation.

3. Confirm (session/confirm) or cancel (session/cancel) the payout.

   To enable automatic confirmation, contact you manager at Bank 131.

4. Wait for a payment_finished webhook with the payout results. If the status is succeeded, the payout was successful.

Payments

The steps depend on whether or not you use our widget.

With our widget

1. Create a payment session with a session/create request. In the response you will get the session identifier.

2. Send a token request to generate a public token. The token is used to initialize the widget for safely entering card details.

3. Initialize the widget using the received token.

4. Wait for a ready_to_confirm webhook from the Bank, indicating that it is ready to perform the payment and is waiting for your confirmation.

5. Confirm (session/confirm) or cancel (session/cancel) the payment.

   To enable automatic confirmation, contact you manager at Bank 131.

6. Wait for a ready_to_capture webhook. It means the required amount is held on the bank card successfully. Capture the full amount or a part of it (session/capture), or cancel the payment (session/cancel).

   Skip this step if delayed capture payments are not enabled for you. In this case, the funds will be put on hold and captured automatically.

7. Wait for a payment_finished webhook with the payment results. If the status is succeeded, the payment was successful.

Without our widget

1. Start the payment in one of the following ways:

   • send a session/create request and then a session/start/payment request with the session identifier and payment details—the recommended option
   • start a session and the payment simultaneously (session/init/payment)

2. Wait for a ready_to_confirm webhook from the Bank, indicating that it is ready to perform the payment and is waiting for your confirmation.

3. Confirm (session/confirm) or cancel (session/cancel) the payment.

   To enable automatic confirmation, contact you manager at Bank 131.

4. If you get an action_required webhook from Bank 131, this means that you will need to take an additional action to perform the payment. For instance, the payer might need to go through 3D Secure. Send the HTTP 200 OK code in response and redirect the payer to the address for 3D Secure.

5. Wait for a ready_to_capture webhook. It means the required amount is held on the bank card successfully. Capture the full amount or a part of it (session/capture), or cancel the payment (session/cancel).

   Skip this step if delayed capture payments are not enabled for you. In this case, the funds will be put on hold and captured automatically.

6. Wait for a payment_finished webhook with the payment results. If the status is succeeded, the payment was successful.