# Request parameters
You can download collection-for-postman, which already has all the queries from this section.
Parameter | Type | Description and possible values | Where to use (action) |
---|---|---|---|
payment | object | object containing transaction data. | pay , preauth , reversal , payout |
payment.action | string Type of transaction. Possible values: pay - Payment; preauth - Authorization; reversal - Cancellation of transaction; payout - Payment. | pay , preauth , reversal , payout | |
payment.orderId | string | order number in your system. Must be unique among successful transactions! | pay , preauth , reversal , payout |
payment.price | string | payment amount. Separator - dot. | pay , preauth , reversal , payout |
payment. orderActualTill | string The reservation period of the product/service. After the specified date the payment will not be possible. Format: 2020-02-20 12:34:56+00:00 . If the parameter is not specified, then the standard period of 48 hours applies. | pay , preauth | |
customerInfo | object | object containing user data. | pay , preauth , reversal , payout , card-binding |
customerInfo. email | string | user's email. Format: user@example.com . | pay , preauth , reversal , payout , card-binding |
customerInfo. phone | string | user phone number in RF format: +79001234567 . | |
target | object | object containing a reference to an existing transaction/card token. | pay , reversal , payout , card-binding |
target.transaction | string | the identifier of the existing transaction to which the new one is referring. | pay , reversal |
target.card | string | card token (e.g. for recurring payments). | pay , payout |
target. knownCardNumber | string | the number of the card to which the payment is made. | payout , card-binding |
destination | object | object containing a reference to the token/card number to which the card2card transaction is transferred. | card2card |
destination.card | string | card token to which the card2card transaction is transferred. | card2card |
destination. knownCardNumber | string | the number of the card to which the card2card transaction is transferred. | card2card |
source | object | object containing a reference to the card token from which the card2card transaction is debited. | card2card |
source.card | string | the token of the card from which the card2card transaction is debited. | card2card |
allowinteractive | boolean | indicator interactive (with payer participation) payment, if payment without payer participation is impossible. Supported only in Mandarin Custom Pay. When used it is always true : "allowinteractive": true | pay |
interactive | boolean | indicator interactive (with payer participation) payment. Supported only in Mandarin Custom Pay. When used it is always equal to true : "interactive": true | pay |
customValues[] | array | array containing additional information about the payment. It can contain up to 8 pairs of parameters. Each parameter is displayed to the payer in the right block of the payment page. | pay , preauth , reversal , payout |
customValues[]. name | string | parameter header (displayed in the right block of the payment page). | pay , preauth , reversal , payout |
customValues[]. value | string | parameter value (displayed in the right block of the payment page). | pay , preauth , reversal , payout |
metadata | object | object containing a list of your parameters with any names and any values that will be sent in callback notification. Parameters are not displayed in the payer user interface. Parameter names cannot contain spaces! | pay , preauth , reversal , payout |
urls | object | object containing url. If absent, the url from the settings are used. | pay , preauth , reversal , payout , card-binding |
urls.return | string | Url for redirecting user after payment. | pay , preauth , reversal , payout , card-binding |
urls.callback | string | Url for sending callback notification of transaction status. | pay , preauth , reversal , payout , card-binding |
fiscalInformation | object | object containing fiscal information for the online cash register. | pay |
fiscalInformation. taxationSystem | string | taxation system. Possible values: Common - General (DOS); Simplified - Simplified (USN) "Income"; SimplifiedMinusOutlay - Simplified (USN) "Income minus expenses"; UnifiedImputedIncome - Single tax on imputed income; UnifiedAgricultural - Single agricultural tax; Patent - Patent. | pay |
fiscalInformation. items[] | array | array of lines in the check. | pay |
fiscalInformation. items[].description | string | item name. | pay |
fiscalInformation. items[].quantity | string | quantity or weight. Separator is dot. | pay |
fiscalInformation. items[].totalPrice | string | amount (price х quantity). Separator is dot. | pay |
fiscalInformation. items[].vat | string | VAT rate. Possible values: None - No VAT; Vat0 - VAT at 0%; Vat10 - VAT at 10%; Vat20 - VAT at 20%. | pay |
TESTING
Data for testing payment products are in separate section.