Properties
| Name | Type | Required | Description |
|---|---|---|---|
| country | str | ✅ | The two-letter ISO 3166-1 ALPHA-2 code for the country. |
| customer | str | ✅ | ID of a specific customer. String starting with cus_. Restricts the payment link to the customer. |
| billing_address_collect | bool | ❌ | Indicates whether the hosted page displays address fields to fill in.<BR> _ true - The address fields are displayed. <BR> _ false - The address fields are displayed only for country codes US, GB and CA. |
| cancel_url | str | ❌ | URL where the customer is redirected after pressing Back to Website to exit the hosted page. This URL overrides the merchant_website URL. Does not support localhost URLs. |
| card_fields | V1hostedcollectcardCardFields | ❌ | Contains details about the card. |
| complete_url | str | ❌ | URL where the customer is redirected after pressing Close to exit the hosted page. This URL overrides the merchant_website URL. Does not support localhost URLs.The two-letter ISO 3166-1 ALPHA-2 code for the country. |
| complete_payment_url | str | ❌ | URL where the customer is redirected when payment is successful, after returning from an external page such as a 3DS page. Does not support localhost URLs. |
| 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. |
| error_payment_url | str | ❌ | URL where the customer is redirected when payment is not successful, after returning from an external page, such as a 3DS page. Does not support localhost URLs. |
| 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. |
| page_expiration | str | ❌ | End of the time when the customer can use the hosted page, in Unix time. If page_expiration is not set, the hosted page expires 14 days after creation. Range: 1 minute to 30 days. |
| payment_method_type | str | ❌ | Limits the page to a specific type of payment method. For example, dk_visa_card. For a list of payment methods, use List Payment Methods by Country. |