Features
Version 1.8
API allows for convenient and secure payouts and, additionally, the payment of taxes.
Guarantee payment balance
First you send a guarantee payment to Bank 131, then the Bank executes your payout orders. The total of your payouts cannot exceed the guarantee payment you have deposited.
To perform payouts through the Faster Payment System, you need to open a current account in Bank 131.
You need to regularly check the balance of your guarantee payment
balance using the wallet/balance
method and top it up in advance via bank wire to the account specified
in your agreement with the Bank. The wire takes 1 to 3 working days.
If the total of the payouts you have ordered to be performed using this API exceeds your guarantee payment, Bank 131 will not be able to perform the payouts.
To whom you can send payouts
Any individuals and legal entities, sole proprietors, and self-employed.
For payments to the self-employed, you need to link the self-employed person to Bank 131, and then perform a payout with fiscalization via API.
Where you can send payouts
- Russian bank cards Visa, MasterCard, Mir
- Russian bank accounts
- YooMoney wallets (formerly Yandex.Money)
- Russian Federal Tax Agency
Supported payout currencies
Who can do this
Sole proprietors and legal entities registered in Russia and abroad.
Getting started
Sign an agreement with Bank 131, complete your legal entity KYC procedure with Bank 131, and complete the integration via this API. Where to begin
How to obtain card details for payouts
If you have a PCI DSS certificate, you can collect bank card details for payouts on your side. If you do not have it, you can use our widget: the recipient enters their card details in the widget and you will receive a token which you can then use to perform payouts to this card.
- How to perform a payout to a card with PCI DSS
- How to perform a payout to a card with a token via widget
You can also perform payouts by tokenized card numbers.
Card identifier
To enable this functionality, please contact your manager at Bank 131.
If you do not have a PCI DSS certificate and you need to understand which card the user is using and whether users' cards overlap, you can use the card identifier feature.
If you have multiple projects (
X-PARTNER-PROJECT
), a card identifier may be the same or different for each project. Please inform your manager at Bank 131 which option you prefer.
A card identifier is unique and is generated based on the card number and its expiration date. Its value is passed in the new parameter card_id
.
A card identifier can not be used for making payments or for getting all linked cards.
A card identifier is not a replacement for a token — you will receive both.
Main payout scenario
- With token
- Without token
Send a request to create an access token for the JavaScript library.
Launch the widget with the created token, show it to the user, and get tokenized card details.
Tokenized card details can be saved so that you can send money to that card later.
Perform the payout:
- (recommended) create a payout session (
session/create
), then start the payout using the session identifier (session/start/payout
), or - create a session and start the payout simultaneously (
session/init/payout
).
The payout request should specify the method to receive the payment and all the parameters mandatory for that method.
- (recommended) create a payout session (
Wait for a
ready_to_confirm
webhook from Bank 131, indicating that it is ready to perform a payment and is waiting for your approval.In case you disabled webhooks, send a
session/status
request and wait untilconfirm
is returned in thesession.next_action
field.Confirm (
session/confirm
) or cancel (session/cancel
) the operation.Wait for a
payment_finished
webhook containing the result of the payout. If the status issucceeded
, the payout was successful.
Perform the payout:
- (recommended) create a payout session (
session/create
), then start the payout using the session identifier (session/start/payout
), or - create a session and start the payout simultaneously (
session/init/payout
).
The payout request should specify the method to receive the payment and all the parameters mandatory for that method.
- (recommended) create a payout session (
Wait for a
ready_to_confirm
webhook from Bank 131, indicating that it is ready to perform a payment and is waiting for your approval.In case you disabled webhooks, send a
session/status
request and wait untilconfirm
is returned in thesession.next_action
field.Confirm (
session/confirm
) or cancel (session/cancel
) the operation.Wait for a
payment_finished
webhook containing the result of the payout. If the status issucceeded
, the payout was successful.
A payout to a Russian bank account may be refunded within 5 days. In this case, you will receive a
payment_refunded
webhook. Learn more about payout refunds
Refunds
If your payout fails, you can request a refund. The refunds are made within 5 days. Learn more on payout refunds.
Settlement account
You may perform payouts via API through the Faster Payment System with the funds on your current settlement account. The funds are instantly debited from your current account and credited to the recipient's account. You may top up your current account with a bank transfer.
You may monitor the current account balance in your remote banking service account, the statement will show the payouts through FPS, as well as all other current account transactions.
Escrow account
You may realize payouts from payers to beneficiaries using an escrow account. Before crediting funds to your escrow account, provide the Bank with the information about the beneficiaries who own the funds.
The funds are instantly debited from your account and credited to the beneficiary's bank card.
You may monitor the escrow account balance in your remote banking system account. The statement will show all transactions for the account, including payouts. Additionally, the Bank will send you the daily payouts report.
Financial documents
The Banks sends you daily and monthly reports about your payouts.
And the terms?
Prices for payouts are fixed in your agreement with the Bank. You can discuss them with your manager. The limits vary depending on the payout method.