Skip to main content

Objects

accept_code

Data for sending a code.

NameMandatoryTypeDescription
rest_of_attempts+stringNumber of code sending attempts
active_to+stringCode lifetime
callback_url+stringAddress to which to send the code

account_details

Information about the sender and recipient accounts.

NameMandatoryTypeDescription
sender+objectInformation about the sender account
recipient+objectInformation about the recipient account

account_statement

Statement details.

NameMandatoryTypeDescription
date_from+dateStatement start date
date_to+dateStatement end date
account_number+stringAccount number (20 digits) for which the statement is generated

acquiring_payments

All the payment details.

NameMandatoryTypeDescription
id+stringUnique payment identifier
status+stringPayment status Possible values: succeeded, in_progress, pending, failed
created_at+stringCreation date in ISO 8601 format
payment_details+objectPayment data
amount_details+objectAmount
amounts-objectTransaction fee
finished_at-stringCompletion date in ISO 8601 format
customer+objectUser (payer) details
recurrent-objectDetails needed to perform recurring payments
participant_details-objectParticipants' details
refunds-arrayRefund list
customer_interaction-objectData needed for user interaction
transaction_info-objectTransaction details
metadata-objectAdditional information. Any data you need in order to perform the operation. Returned in responses and webhooks
error-objectError description

Payment statuses (status)

  • in_progress – the payment is being processed.
  • pending – awaiting your confirmation (session/confirm) or cancellation (session/cancel).
  • succeeded – the payment has been completed successfully.
  • failed – the payment has not gone through due to an error.

acquiring_widget

Settings for the payout form widget (for performing bank card payments).

NameMandatoryTypeDescription
session_id+stringIdentifies the payment session for which the payment will be performed
show_recurrent_checkbox-boolWhether to display the Enable automatic payments checkbox in the widget interface
success_return_url-stringThe URL to which the user is redirected after the payment has been successfully completed
failure_return_url-stringThe URL to which the user is redirected when an error occurs during the payment.
success_on_hold-boolWhether to show a message about a successful payment to a payer when holding. By default, false and the widget shows a loading screen until the end of the hold

amount

Amount object.

NameMandatoryTypeDescription
amount+intAmount value in minor currency units (ruble decimal format). For 100 rubles, enter 10000
currency+stringThe ISO 4217 currency code. Case insensitive. Options: rub, eur

amount_details

Amount object.

NameMandatoryTypeDescription
amount+intAmount value in minor currency units (ruble decimal format). For 100 rubles, enter 10000
currency+stringThe ISO 4217 currency code. Case insensitive. Options: rub, eur

amounts

Information on the transaction fee.

NameMandatoryTypeDescription
fee-objectInformation on the applicable fee

balance

Account balance details.

NameMandatoryTypeDescription
current_balance-stringCurrent account balance (the value can be positive or equal to 0). The value is specified in minor currency units (ruble decimal format). For 100 rubles, the value is 10000

bank_account

The payout recipient's account description.

NameMandatoryTypeDescription
system_type+stringBank payment system. Options: ru, faster_payment_system, faster_payment_system_verification
ru- (mandatory for system_type = ru)objectRecipient's Russian bank account (region: ru)
faster_payment_system- (mandatory for system_type = faster_payment_system)objectRecipient's data in the Faster Payment System
faster_payment_system_verification- (mandatory for system_type = faster_payment_system_verification)objectData for the recipient verification in the Faster Payment System

bank_account_ru

Bank account details.

NameMandatoryTypeDescription
bik- (mandatory for the /api/v1/tokenize method)stringRecipient’s Bank Identification Code
account- (mandatory for the /api/v1/tokenize method)stringRecipient's bank account
token- (mandatory for the /api/v1/token/info method)stringBank account token

bank_card

An unencrypted card object (can be used if you have PCI DSS).

NameMandatoryTypeDescription
number+stringCard number
expiration_month- (mandatory for payments if available)stringMonth
expiration_year- (mandatory for payments if available)stringYear
security_code- (mandatory for payments if available)stringCVC (security code)
cardholder_name-stringCardholder's name

card

The payout recipient's bank card details.

NameMandatoryTypeDescription
type+stringCard details transmission type. Possible values: bank_card, encrypted_card, tokenized_card
bank_card- (mandatory for type = bank_card)objectUnencrypted card
encrypted_card- (mandatory for type = encrypted_card)objectCard with encrypted fields (tokenized)
tokenized_card- (mandatory for type = tokenized_card)objectTokenized card number
brand-stringCard information. Returned in notifications, needed for user display
last4-stringCard information. Returned in notifications, needed for user display
bin-stringBank Identification Number (BIN) (the first 6 digits of a card number)

card_elements

The number of a card for tokenizing.

NameMandatoryTypeDescription
ref+stringA fixed value, always number
type+stringA fixed value, always card_number
card_number+stringCard number

confirm_information

Confirmation information for a transaction with an escrow account.

NameMandatoryTypeDescription
transfer_details+ (for payouts to cards)objectInformation about a transfer
account_details+ (for payouts to bank accounts)objectInformation about the sender and recipient accounts

contacts

Contacts of the user (payout recipient or payment sender).

NameMandatoryTypeDescription
e-mail-stringUser's email
phone-stringUser's phone number

counter_party

Counterparty details.

NameMandatoryTypeDescription
kpp-stringCounterparty's KPP
inn-stringCounterparty's INN
name+stringCounterparty's name
account_number+stringCounterparty's account number
bank_code+stringCounterparty's bank BIK

customer (user in your system)

Data about the user (payout recipient or payment sender) in your system, E.g. the login that lets you identify the user. Also includes their contact details.

Parent objects: acquiring_payments, payments.

NameMandatoryTypeDescription
reference+stringIdentifier of the user (payout recipient or payment sender) in your system (up to 128 characters)
contacts-arrayUser contacts

customer (payer)

Information about the payer of a payout from an escrow account.

Parent objects: transfer_details.

NameMandatoryTypeDescription
account_number-stringAccount number
name-stringName
bank_name-stringBank's name
bik-stringBank's BIC
correspondent_account_number-stringCorrespondent account number
inn-stringBank's INN (for cash and settlement only)
kpp-stringBank's KPP (for cash and settlement only)

customer_authorization

Information required for payments by Uzcard or Humo cards.

NameMandatoryTypeDescription
type+stringAuthentication type. Always: sms
suspend_key+stringConfirmation key required when sending a code
accept_code+objectData for sending a code
resend_sms+objectData for requesting a new code

customer_interaction

An object describing customer interaction.

NameMandatoryTypeDescription
type+stringCustomer interaction type. Possible values: redirect, inform
redirect- (mandatory for type = redirect)objectUser redirect data
inform- (mandatory for type = inform)objectPayment option data

data (user account)

Masked user account data.

NameMandatoryTypeDescription
masked_account+stringFirst 5 and last 4 digits of an account

data (token and card number)

Token and tokenized card details.

Returns in response to the tokenize/elements request.

NameRequiredTypeDescription
number+objectToken information

encrypted_card

Card with encrypted fields (tokenized). Transmitted during payouts or payments through the widget.

NameMandatoryTypeDescription
number_hash+stringCard number hash
expiration_date_hash-stringExpiration date hash
security_code_hash-stringCVC code hash
cardholder_name_hash-stringCardholder's name hash

error

Error description object.

NameMandatoryTypeDescription
code-stringError code
description-stringError description

Error codes

faster_payment_system

The data of a user of the Faster Payment System.

NameMandatoryTypeDescription
phone+stringRecipient's phone number
bank_id+stringIdentifier of the recipient's bank in the FPS. To get the identifier, use the fps/banks method
description+stringPayout purpose

faster_payment_system_verification

The data for the recipient verification in the Faster Payment System.

NameMandatoryTypeDescription
phone+stringRecipient's phone number
bank_id+stringIdentifier of the recipient's bank in the FPS. To get the identifier, use the fps/banks method

fee

Information on the applicable fee. The number of objects matches the number of applicable fees.

NameMandatoryTypeDescription
amount+intAmount value in minor currency units (ruble decimal format). For 100 rubles, enter 10000
currency+stringThe ISO 4217 currency code. Case insensitive. Options: rub, eur

fiscalization_details

Fiscalization details.

NameMandatoryTypeDescription
professional_income_taxpayer+objectFiscalization details for the self-employed

info (bank account token)

Bank account token details.

NameMandatoryTypeDescription
created_at+stringCreation date in ISO 8601 format
finished_at+stringCompletion date in ISO 8601 format
masked_account+stringMasked bank account
type+stringToken type. Always: bank_account_ru

info (tokenized bank card)

Details of a tokenized bank card.

Returns in response to the token/info request.

NameMandatoryTypeDescription
number_hash+stringToken (tokenized bank card)
brand+stringPayment system, i.e. visa
last4+stringLast 4 card numbers
type+stringToken type. Always: card

info (notifications number)

The number of unread notifications for a self-employed person's tax reference number (INN).

NameMandatoryTypeDescription
tax_reference+stringTax reference number (INN)
count-intNumber of unread notifications per each tax_reference value

info (notifications information)

Detailed information about notifications for a self-employed person's tax reference number (INN).

NameMandatoryTypeDescription
tax_reference+stringTax reference number (INN)
notifications-arrayNotifications for the value from tax_reference

info (public token)

Information about a public token.

Returns in response to the token/info request.

NameMandatoryTypeDescription
token+stringToken
created_at+stringCreation date in ISO 8601 format
finished_at+stringCompletion date in ISO 8601 format
is_active+boolPossible to conduct the operation with this token: true – allowed, false – not allowed
type+stringToken type. Always: public_token

info (token for recurring payments or payouts)

Object with information about a token for recurring payments or payouts. More information about recurring payments and token settings.

Returns in response to the token/info request.

NameMandatoryTypeDescription
token+stringToken
created_at+stringCreation date in ISO 8601 format
finished_at+stringCompletion date in ISO 8601 format. The setting isn't processed by the Bank
is_active+boolPossible to conduct the operation with this token: true – allowed, false – not allowed
initiator-stringRecurring payment type. Possible values: merchant – MIT payment (by default), client – CIT payment
type+stringToken type. Always: recurrent_token

info (tokenized card details)

Tokenized card details. Returns in response to the tokenize/elements request.

Parent objects: number.

NameRequiredTypeDescription
masked_card_number+stringMasked card number
card_network+stringCard payment system
card_type+stringCard type

inform

Payment option data.

NameMandatoryTypeDescription
qr-objectQR code for payments via FPS

internal_transfer

Information about an internal transfer

NameMandatoryTypeDescription
type+stringTransfer type. Possible values: transfer_from_nominal_account, transfer_from_bank_account
transfer_from_nominal_account- (mandatory for type = transfer_from_nominal_account)objectInformation about a transfer from an escrow account
transfer_from_bank_account- (mandatory for type = transfer_from_bank_account)objectInformation about a transfer from a settlement account

internet_banking

Details on payments via payment systems.

NameMandatoryTypeDescription
type+stringPayment system. Possible values: sber_pay
sber_pay+objectSberPay payment system transaction details

notification_list

The array contains data for informing the Federal Tax Service about statuses of notifications sent to the self-employed.

NameMandatoryTypeDescription
message_id_list-array[string]Array with message IDs
tax_reference+stringTax reference number (INN)

notifications

The array contains detailed information about notifications the Federal Tax Service sends to a self-employed person.

NameMandatoryTypeDescription
id+stringIdentifier
title+stringNotification header
message+stringNotification body
status+stringStatus. Possible values: "NEW" – new and unread notification; "ACKNOWLEDGED" – read notification; "ARCHIVED" – archived notification
created_at+dateTimeNotification date

number

Token and tokenized card details.

NameRequiredTypeDescription
token+stringToken
info+objectCard information

participant_details

Payout participant details.

NameMandatoryTypeDescription
sender-objectSender's details
recipient-objectRecipient's details

payee

Recipient data for tax payments with extended parameters.

NameRequiredTypeDescription
bik+stringRecipient bank's BIK
account+stringAccount number
account_eks+stringUnified Treasury Account
name+stringRecipient name
inn+stringRecipient's INN, 10 digits

payer

Sender data for tax payments with extended parameters.

NameRequiredTypeDescription
kpp+stringSender's KPP, 9 digits
inn+stringSender's INN, 10 digits

payment_details

The description of the method for performing the payment.

NameMandatoryTypeDescription
type+stringPayment method type. Possible values: card, recurrent, internal_transfer, faster_payment_system, wallet
card- (mandatory for type = card)objectBank card details
recurrent- (mandatory for type = recurrent)objectDetails for repeating the payment using the token
internal_transfer- (mandatory for type = internal_transfer)objectInternal transfer details
faster_payment_system- (mandatory for type = faster_payment_system)objectPayment via FPS
wallet- (mandatory for type = wallet)objectPayment via wallet

payment_method

The description of the method for receiving the payout.

NameMandatoryTypeDescription
type+stringThe type of method for receiving the payout. Possible values: card, bank_account, wallet, tax , recurrent, tokenized_card
card- (mandatory for type = card)objectRecipient's bank card
bank_account- (mandatory for type = bank_account)objectRecipient's bank account
wallet- (mandatory for type = wallet)objectRecipient's electronic wallet
tax- (mandatory for type = tax)object Payouts to the Russian Federal Tax Agency
recurrent- (mandatory for type = recurrent)objectPayout with token
tokenized_card- (mandatory for type = tokenized_card)objectPayout with tokenized card number

payment_options

Parameters needed to perform the payment.

NameMandatoryTypeDescription
return_url-stringThe URL to which the user is redirected after the payment has been performed. The URL must be valid
recurrent-boolDetermines whether the payment is to be performed using the saved token

payments

The payout details.

NameMandatoryTypeDescription
id+stringPayout identifier
status+stringStatus. Possible values: succeeded, in_progress, pending, failed
created_at+stringCreation date in ISO 8601 format
finished_at-stringCompletion date in ISO 8601 format
customer-objectThe recipient's data in your system, e.g. the login that lets you verify the recipient on your side.
payment_method+objectThe method of receiving the payout
amount_details+objectAmount
amounts-objectTransaction fee
fiscalization_details-objectFiscalization details
participant_details-object The details of payout participants required to perform the payout, e.g. the names and addresses of the payer and the recipient.
refunds-arrayRefund list
transaction_info-objectTransaction details
metadata-*Additional information. Any data you need in order to perform the operation. Returned in responses and webhooks
error-objectError description

Payout statuses (status)

  • in_progress – the payment is being processed.
  • pending – awaiting your confirmation (session/confirm) or cancellation (session/cancel).
  • succeeded – the payout has been completed successfully.
  • failed – the payout has not gone through because of an error.

period

Tax period description.

NameMandatoryTypeDescription
type+stringPeriod type. Possible values: month, quarter
number+numberDepends on the period type. Number from 1 to 12 for month, number from 1 to 4 for  quarter
year+stringYear, 4 digits. Example: 2021

professional_income_taxpayer

Fiscalization details for the self-employed.

NameMandatoryTypeDescription
services+arrayList of services provided (maximum 6)
tax_reference+stringSelf-employed person's INN
receipt-objectFiscalization receipt. Returned in notifications
payer_type-stringPayer type (who pays the self-employed). Possible values: legal, individual, foreign
payer_tax_number- (mandatory for payer_type = legal)stringPayer's INN
payer_name- (mandatory for payer_type = legal)stringPayer name

Payer type payer_type

Payer type. Possible values:

  • legal – legal entity
  • individual – individual person
  • foreign – non-resident of Russia

public_token

Information about a public token.

NameMandatoryTypeDescription
token+stringToken

qr

QR code for payments via FPS.

NameMandatoryTypeDescription
content+stringLink to QR code
img+stringQR code body

receipt

The data of the receipt created during fiscalization.

NameMandatoryTypeDescription
id+stringReceipt identifier
link-stringReceipt link

recipient (recipient of a payout from an escrow account)

Information about the recipient of a payout from an escrow account.

Parent objects: transfer_details.

NameMandatoryTypeDescription
account_number-stringAccount number
name-stringName
bank_name-stringBank's name
bik-stringBank's BIC
correspondent_account_number-stringCorrespondent account number
inn-stringBank's INN (for cash and settlement only)
kpp-stringBank's KPP (for cash and settlement only)

recipient (payout recipient details)

Payout recipient details. Which details are necessary depend upon the method of receiving the payout.

Parent objects: participant_details.

NameMandatoryTypeDescription
full_name- (mandatory for payouts to any cards)stringFull ame
first_name-stringFirst name
last_name-stringLast name
middle_name-stringPatronymic name
company_name-stringCompany name
reference-stringRecipient identifier in your system
tax_reference-stringTaxpayer identifier
beneficiary_id- (mandatory for the payments and payouts with a beneficiary)stringThe INN of the beneficiary
country_iso3-stringThe country (ISO-3166-1 alpha-3)
account-stringSender's escrow account

recurrent (token for recurring payments or payouts)

Object with a token for recurring payments or payouts.

Parent objects: payment_method.

NameMandatoryTypeDescription
token+stringToken

recurrent (information about a token for recurring payments or payouts)

Object with information about a token for recurring payments or payouts. More information about recurring payments and token settings.

Parent objects: acquiring_payments, payment_details.

NameMandatoryTypeDescription
token+stringToken
created_at+ (not mandatory for payment_details)stringCreation date in ISO 8601 format
finished_at+ (not mandatory for payment_details)stringCompletion date in ISO 8601 format. The setting isn't processed by the Bank
is_active+ (not mandatory for payment_details)boolPossible to conduct the operation with this token: true – allowed, false – not allowed
initiator-stringRecurring payment type. Possible values: merchant – MIT payment (by default), client – CIT payment

recurrent_token

Object with a token for recurring payments or payouts.

NameMandatoryTypeDescription
token+stringToken

redirect

User redirect data.

NameMandatoryTypeDescription
url+stringRedirect address including GET parameters
base_url+stringRedirect address
method+stringSubmission method, E.g. GET, POST
qs-map<string,string>A set of parameters depending on the transaction method
params-map<string,*>A set of parameters depending on the transaction method
  • Check if any parameters are specified in the qs and params objects.
  • Redirect the user to the redirect address specified in base_url using the method from the method parameter and including all the required parameters in the URL or request body.

refunds

Details about the refund.

NameMandatoryTypeDescription
id+stringUnique refund identifier
status+stringRefund status. Possible values: in_progress, accepted, declined, error
amount_details+objectThe amount of the refund
created_at+stringCreation date
finished_at-stringCompletion date
is_chargeback-boolWhether the refund is made within a chargeback
transaction_info-objectTransaction details

Refund statuses (status)

  • in_progress – the payment is being processed.
  • accepted – the refund has been completed successfully.
  • declined – Bank 131 has declined the refund.
  • error – the refund has not gone through because of an error.

resend_sms

Data for requesting a new code.

NameMandatoryTypeDescription
rest_of_attempts+stringNumber of the code request attempts left
allowed_from+stringTime starting from which a new code can be requested
callback_url+stringAddress to which to send a new code request

ru

Russian bank account details (region: ru).

NameMandatoryTypeDescription
bik- (mandatory for payouts without a token)stringRecipient’s Bank Identification Code
account- (mandatory for payouts without a token)stringRecipient's bank account
token- (mandatory for payouts with a token)stringBank account token
full_name+stringThe individual's full name. In case of a payout to an account of a sole proprietor should be passed in the following format: ИП <full name>. In case of a payout to a legal entity, enter the entity's name, if it is provided in the agreement. Important: if the name is passed incorrectly the recipient bank may cancel the payout and the payout will be refunded
description+stringPayout purpose
inn- (mandatory for the payouts to the accounts of legal entities and individual proprietors)stringThe recipient's INN, 10 digits for legal entities, 12 digits for individuals, including individual proprietors
kpp- (mandatory for the payouts to the accounts of legal entities)stringThe recipient's Tax Registration Reason Code (KPP)
is_fast-boolIndicates whether an urgent payout should be made (via BESP). An urgent payout takes place within an hour, a regular one—from 1 to 3 banking days

sber_pay

SberPay payment details.

NameMandatoryTypeDescription
phone-stringPhone number to send PUSH or SMS to. Format: 7**********
channel+ENUMSberPay payment channel. Options: app, mobile_web, web

self_employed_widget

Settings for the widget used for linking self-employed people to Bank 131.

NameMandatoryTypeDescription
tax_reference- (if phone is passed)stringSelf-employed person's INN
phone- (if tax_reference is passed)stringSelf-employed person's phone number

sender (escrow payer details)

Information about the payer of a payout from an escrow account.

Parent objects: transfer_details.

NameMandatoryTypeDescription
account_number-stringAccount number
name-stringName
bank_name-stringBank's name
bik-stringBank's BIC
correspondent_account_number-stringCorrespondent account number
inn-stringBank's INN (for cash and settlement only)
kpp-stringBank's KPP (for cash and settlement only)

sender (payout payer details)

Payout payer details. Which details are necessary depend upon the method of receiving the payout.

Parent objects: participant_details.

NameMandatoryTypeDescription
full_name-stringFull ame
first_name-stringFirst name
last_name-stringLast name
middle_name-stringPatronymic name
company_name-stringCompany name
reference-stringRecipient identifier in your system
tax_reference-stringTaxpayer identifier
beneficiary_id- (mandatory for the payments and payouts with a beneficiary)stringThe INN of the beneficiary
country_iso3-stringThe country (ISO-3166-1 alpha-3)
account- (mandatory for making payouts from an escrow account)stringSender's escrow account

services

A description of the service which the payout is covering for fiscalization purposes. The object may contain up to 6 services.

  • The restriction on the number of services per receipt is regulated by the Federal Tax Service (not by the Bank).
  • If the number of services is greater than six, you can:
    • split them into multiple receipts,
    • combine them.
      Example: if 10 consulting services, 10 000 rubles each, were provided, you can specify 10 services, 10 000 rubles each, as a single item instead of specifying each service separately.
NameMandatoryTypeDescription
name+stringService name (up to 256 characters)
amount_details+objectService price
quantity-integerNumber of services provided. Default value: 1
  • Note: The product of the service price and the number of services provided must equal the amount of the payout.

session

A container with data about all the operations performed within a single payment session.

Payment operations can only be performed within a session. One or more operations of the same or different types can be performed within the session (e.g. several payouts, a payment and a refund, or a payment which is subsequently split).

NameMandatoryTypeDescription
id+stringSession identifier
status+stringStatus. Possible values: created, in_progress, accepted, cancelled, error
created_at+stringCreation date in ISO 8601 format
updated_at+stringUpdate date in ISO 8601 format
payments-arrayA list of payouts performed within the session
acquiring_payments-arrayA list of payments performed within the session
next_action-stringA label indicating actions needed to perform the transaction successfully. Possible values: confirm, capture
error-objectError description

Payment session statuses (status)

  • created – the session has been created and is waiting to be started or canceled.
  • in_progress – the payment is being processed.
  • accepted – the payment has been completed successfully.
  • cancelled – the payment has been canceled.
  • error – an unexpected error occurred while processing.

    Attention! This status is not final. Please contact Bank 131's support team and wait for a final transaction status.

Next steps (next_action)

If this field is not empty, it means that Bank 131 is waiting for you to perform specific actions to continue with the operation:

tax

Data for tax payment.

NameRequiredTypeDescription
type+stringTax type or payment method. Options: tax_short, tax_full
tax_full- (mandatory for type = tax_full)objectData for tax payment with an extended set of parameters
tax_details- (mandatory for type = tax_short)objectData for tax payment with a minimal set of parameters

tax_details

Data for tax payments.

NameRequiredTypeDescription
period- (required for payments with an extended set of fields)stringPeriod. Input format described below
period- (used only for type = tax_short)objectTax period
kbk- (required for payments with an extended set of fields)stringBudget classification code, 20 digits
oktmo- (required for payments with an extended set of fields)stringAll-Russian Classifier of Territories of Municipal Formations, 8 or 11 digits
payment_reason- (required for payments with an extended set of fields)stringPayment reason. Input format described below
document_number- (required for payments with an extended set of fields)stringDocument number. Input format described below
document_date- (required for payments with an extended set of fields)stringDocument date. Input format described below
Input format for the 'period' field in requests with extended parameters
  • If the payment_reason field is set to "ТП" or "ЗД", then the payment frequency established by legislation should be specified in one of the following formats:
    • for monthly payments: "МС.MM.YYYY", where MM is the month (from 01 to 12), and YYYY is the year for which the payment is made (e.g., for income tax withholding for February 2020, use "МС.02.2020")
    • For taxes paid quarterly: "КВ.QQ.YYYY", where QQ is the quarter (from 01 to 04), and YYYY is the year for which the tax is paid.
    • For semi-annual taxes (e.g., Simplified Tax System): "ПЛ.HH.YYYY", where HH is the half-year (01 or 02), and YYYY is the year for which the tax is transferred.
    • For annual payments: "ГД.00.YYYY", where YYYY is the year for which the tax is paid (e.g., for final profit tax calculation for 2019, use "ГД.00.2019").
  • If the payment_reason field is set to "ТР", then the demand date is indicated.
  • If the payment_reason field is set to "АП", then "0" is used.
Input format for the 'payment_reason' field in requests with extended parameters
  • "ТП" – when paying the tax/contribution for the current period.
  • "ЗД" – when voluntarily repaying tax/contribution arrears.
  • "ТР" – when repaying the debt based on a demand issued by the tax authority or the Social Insurance Fund (FSS).
  • "АП" – when repaying the debt based on an audit act (before the demand is issued).
Input format for the 'document_number' field in requests with extended parameters
  • If the payment_reason field is set to "ТП" or "ЗД", then use "0".
  • If the payment_reason field is set to "ТР", use the number of the tax payment demand.
  • If the payment_reason field is set to "АП", use the number of the decision issued after the audit.
Input format for the 'document_date' field in requests with extended parameters
  • If the payment_reason field is set to "ТП", use the date of signing the declaration or "0" if the date is not specified.
  • If the payment_reason field is set to "ЗД", use "0".
  • If the payment_reason field is set to "ТР", use the date of the payment demand.
  • If the payment_reason field is set to "АП", use the date of the post-audit decision.

tax_full

Data for tax payment with an extended set of parameters.

NameRequiredTypeDescription
uin+stringUnique identifier of the charge. Always 0 for tax payments
description+stringPurpose of the payment
tax_details+stringPayment data for tax payment
payer+objectSender's data for tax payment
payee+objectRecipient's data for tax payment

tokenize_widget

Settings for the tokenization widget.

NameMandatoryTypeDescription
access+boolIdentifies whether this public key can use the tokenization widget.

tokenized_card

A card token.

NameRequiredTypeDescription
token+stringToken

total_balance

Balance information.

NameMandatoryTypeDescription
opening+intOpening balance on the statement start date
closing+intClosing balance on the statement end date

total_turnover

Information on funds movement.

NameMandatoryTypeDescription
debet+intTotal debits over the period covered by the statement
credit+intTotal credits over the period covered by the statement

transaction_info

Transaction information.

NameMandatoryTypeDescription
rrn+stringRetrieval Reference Number (a unique identifier generated for a bank transaction)
ern-stringAcquirer Reference Number (a unique number assigned to credit card transactions)
auth_code-stringAuthorization code

transactions

An array with information on transactions.

NameMandatoryTypeDescription
amount+intTop-up amount (non-negative values only)
base_amount-intTransaction amount in the currency. Should be filled out only for transactions in currencies other than Russian rubles. When using the base currency (RUB), the parameter is optional
currency+stringTransaction currency
payment_date+dateTransaction date
bank_system_id+stringPayment identifier. It is specified for all kinds of payments:
- for payments sent via the API
- for transfers from another bank
- for payments made through online banking
transaction_id-stringTransaction identifier. It is specified for payments sent via the API
session_id-stringSession identifier. It is specified for payments sent via the API
purpose+stringPayment purpose
counter_party+objectPayer information
type+stringTransaction type. Possible values: credit (for replenishment operations), debet (for write-off operations) values

transfer_details

Information about a transfer.

NameMandatoryTypeDescription
payment_method+objectThe method of receiving the payout
customer+objectInformation about a payer
recipient+objectInformation about a recipient
purpose+stringPayout purpose in the following format: <description>; card:<card mask>
amount+objectAmount

transfer_from_bank_account

Information on a transfer from a settlement account.

NameMandatoryTypeDescription
description+stringDescription

transfer_from_nominal_account

Information on a transfer from an escrow account.

NameMandatoryTypeDescription
description+stringDescription

wallet

Electronic wallet details.

NameMandatoryTypeDescription
type+stringWallet type. Possible values: yoomoney
yoomoney-objectYooMoney (Yandex.Money) wallet details

wallets

Your guarantee payment balance details (this balance is used to perform payouts).

NameMandatoryTypeDescription
id+stringBalance identifier
amount_details+objectCurrent balance

yoomoney

YooMoney (Yandex.Money) wallet details.

NameMandatoryTypeDescription
account+stringYooMoney wallet number, 11 to 20 digits. Example: 4100175017397
description-stringPayment description (up to 128 characters)