Properties
| Name | Type | Required | Description |
|---|---|---|---|
| amount | str | ✅ | The amount of the payment, in units of the currency defined in currency. Decimal, including the correct number of decimal places for the currency exponent, as defined in ISO 2417:2015.<BR> On the hosted payment page, the customer: <BR> _ Cannot modify the amount when amount_is_editable is false or not used. <BR> _ Can modify the amount when amount_is_editable is true and amount has a positive value. <BR> * Must enter an amount when amount_is_editable is true and amount is 0, null, or not used. |
| country | str | ✅ | The two-letter ISO 3166-1 ALPHA-2 code for the country. |
| currency | str | ✅ | In transactions without FX, defines the currency of the transaction. Three-letter ISO 4217 code. <BR> In FX transactions: <BR> _ When fixed_side is buy, it is the currency received in the Rapyd wallet. <BR> _ When fixed_side is sell, it is the currency charged to the buyer. <BR> See also fixed_side and requested_currency fields. |
| amount_is_editable | bool | ❌ | Determines whether the customer can edit the amount. <BR> _ true - The customer can edit the amount. <BR> _ false - The customer cannot edit the amount. |
| checkout | dict | ❌ | Optional parameters for the checkout page. |
| customer | str | ❌ | ID of a specific customer. String starting with cus_. Restricts the payment link to the customer. |
| fixed_side | str | ❌ | Indicates whether the FX rate is fixed for the buy side (seller) or for the sell side (buyer).<BR>_ buy - The currency that the Rapyd Wallet receives for goods or services. Fixed side buy relates to the seller (merchant) funds. For example, a US-based merchant wants to charge 100 USD. The buyer (customer) pays the amount in MXN that converts to 100 USD.<BR>_ sell - The currency that the buyer is charged for purchasing goods or services. Fixed side sell relates to the buyer (customer) funds. For example, a US-based merchant wants to charge a buyer 2,000 MXN and will accept whatever amount in USD that is converted from 2,000 MXN. |
| language | str | ❌ | Determines the default language of the hosted page. For a list of values, see 'List Supported Languages'. <BR> * When this parameter is null, the language of the user's browser is used. <BR> If the language of the user's browser cannot be determined, the default language is English. |
| max_payments | float | ❌ | Indicates the maximum number of times that the payment link can be used for payments. When not indicated, there is no limit. |
| merchant_reference_id | str | ❌ | Identifier defined by the client for reference purposes. Limit: 45 characters. |
| requested_currency | str | ❌ | Currency for one side of an FX transaction. Three-letter ISO 4217 code. <BR><BR>_ When fixed_side is sell, it is the currency received in the Rapyd Wallet. <BR><BR>_ When fixed_side is buy, it is the currency charged to the buyer (customer). |