token | yes | Widget token issued by Freedom Pay. It is passed next to payment, not inside it. |
payment.amount | yes | Payment amount, not less than 1. |
payment.description | yes | Description of the payment, up to 1024 characters. |
payment.order | no | Order ID in your system, up to 50 characters. It comes back in the notifications. |
payment.currency | no | Currency, ISO 4217 letter code. Default: the currency of the merchant's country. |
payment.language | no | Language of the payment page. Default: ru. |
payment.expires_at | no | Time until which the client can pay, ISO 8601 in UTC. Not later than 7 days from now; otherwise the lifetime from the merchant settings is used. |
payment.test | no | 1 — test payment. Default: the mode from the merchant settings. |
payment.options.callbacks.result_url | no | URL for the payment result, see Result notify. Default: the URL from the merchant settings. |
payment.options.callbacks.check_url | no | URL for the check before the payment, see Check request. |
payment.options.user.id | no | Client ID in your system. Required with recurrent_profile.start. |
payment.options.user.email | no | Client's email. |
payment.options.user.phone | no | Client's phone number with the country code, digits only. |
payment.options.custom_params | no | Your own parameters as an object. They come back in the notifications. |
payment.options.receipt_positions | no | Receipt positions, if fiscalization is enabled for the merchant: count, name, price are required in each position; tax_type, unit_code are optional. |
payment.options.recurrent_profile.start | no | true — create a recurring profile with the payment. Its ID pg_recurring_profile_id comes to result_url; use it in Create recurring payment. Available after Freedom Pay enables recurring payments for the merchant. |
payment.options.recurrent_profile.lifetime | no | Lifetime of the recurring profile in months. Default: 1. |