CheckoutPageResponse
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| language | str | ❌ | Determines the default language of the hosted page. When this parameter is null, the language of the user's browser is used. If the language of the user's browser cannot be determined, the default language is English |
| merchant_alias | str | ❌ | Reserved, the default language is Rapyd |
| merchant_color | str | ❌ | Color of the call-to-action (CTA) button on the hosted page. To configure this field, use the Client Portal |
| merchant_customer_support | MerchantCustomerSupport | ❌ | |
| merchant_logo | str | ❌ | URL for the image of the client's logo. To configure this field, use the Client Portal |
| merchant_website | str | ❌ | The URL where the customer is redirected after exiting the hosted page. Relevant when one or both of the following fields is unset: _ cancel_url_ complete_url. To configure this field, use the Client Portal |
| redirect_url | str | ❌ | URL of the hosted page that is shown to the customer. |
| merchant_terms | str | ❌ | URL for the client's terms and conditions. To configure this field, use the Client Porta |
| merchant_privacy_policy | str | ❌ | URL for the terms and conditions of the agreement between the client and the client’s customers. To configure this field, use the Client Portal. |
| page_expiration | float | ❌ | Length of time for the payment to be completed after it is created, measured in seconds. When both expiration and payment_expiration are set, the payment expires at the earlier time. |
| status | HostedPageStatus | ❌ | Status of the hosted page. One of the following: NEW - The hosted page was created. DON - Done. The card was added to the customer profile. EXP - The hosted page expired. |
| account_funding_transaction | dict | ❌ | Details of an account funding transaction (AFT), which transfers funds from a card to a cardholder's wallet. |
| amount | float | ❌ | 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. If the amount is a whole number, use an integer and not a decimal. |
| cart_items | HostedPageAdditionalResponseCartItems | ❌ | Describes the cart items that the customer is purchasing. These items are displayed at the checkout page. |
| country | str | ❌ | |
| currency | str | ❌ | |
| customer | str | ❌ | Description of the payment transaction. To display the description, set display_description to true in custom_elements. |
| escrow | bool | ❌ | Determines whether the payment is held in escrow for later release. |
| escrow_release_days | float | ❌ | Determines the number of days after creation of the payment that funds are released from escrow. Funds are released at 5:00 pm GMT on the day indicated. Integer, range: 1-90. |
| id_ | str | ❌ | ID of the Rapyd checkout page. String starting with checkout_. |
| merchant_main_button | str | ❌ | A string that represents the text on the main Call to Action (CTA) button. One of the following:_ place_your_order - Place Your Order._ pay - Pay._ pay_now - Pay Now._ make_payment - Make Payment._ purchase - Purchase._ buy - Buy._ donate - Donate._ place_your_order To configure this button, use the Client Portal. |
| custom_elements | HostedPageAdditionalResponseCustomElements | ❌ | Description of the payment transaction. |
| complete_checkout_url | str | ❌ | URL where the customer is redirected after pressing Finish to exit the hosted page. This URL overrides the merchant_website URL. Does not support localhost URLs. |
| cancel_checkout_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. |
Build Your Own SDKs with liblab
Build developer friendly SDKs in minutes from your APIs