Description of the payment transaction.
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| billing_address_collect | bool | ❌ | Determines whether the customer is asked to fill in the billing address. Relevant when a card payment method is selected. <BR> _ true - The address fields appear on the checkout page.<BR> _ false - The address fields appear only if the country is **US, GB or **CA**. |
| cardholder_name | str | ❌ | The name of the card owner, printed on the front of the card. |
| display_description | bool | ❌ | Determines whether the checkout page displays the payment description.<BR>_ true - The payment description appears.<BR> _ false - The payment description does not appear.<BR> Relevant when description is passed in the Create Checkout Page request. |
| dynamic_currency_conversion | bool | ❌ | Determines whether the checkout page displays multiple currency options for a payment.<BR> _ true - Multiple currency options appear.<BR> _ false - Currency options do not appear.<BR>When the customer selects the requested currency, the checkout page displays the following information:<BR>_ The original amount and currency.<BR> _ The converted amount in the requested currency.<BR> _ The exchange rate.<BR> Relevant when: <BR> _ The Create Checkout Page request passes requested_currency.<BR> _ fixed_side is buy. <BR> _ One or more payment methods support the values for currency and requested_currency. |
| merchant_color | str | ❌ | reserved |
| merchant_currency_only | bool | ❌ | In a payment with FX where fixed_side=buy, determines whether the buyer's currency and the exchange rate appear. One of the following:<BR> _ true - The currency and the exchange rate are hidden.<BR> _ false - The currency and the exchange rate appear. |
| payment_fees_display | bool | ❌ | Determines whether payment fees appear on the checkout page.<BR> _ true - Payment fees appear when the payment_fees object is set in the 'Create Checkout Page' request.<BR> _ false - Payment fees do not appear. |
| required_customer_fields | any | ❌ | Indicates the list of fields that the customer has to fill in on the payment page before completing the payment via hosted checkout. Valid values include:<BR>_ name – The customer's full name (default).<BR> _ email – The customer's email address.<BR> _ phone_number – The customer's phone number.<BR> _ address – The address of the customer. |
| save_card_default | bool | ❌ | Determines whether the save card checkbox is checked by default.<BR> _ true - The save card checkbox is checked.<BR> _ false - The save card checkbox is cleared.<BR> Relevant when customer_id is passed in the 'Create Checkout Page' request. |