Skip to main content

V1CheckoutBody

Properties

NameTypeRequiredDescription
amountfloatThe 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.
countrystr
currencystr
account_funding_transactiondictDetails of an account funding transaction (AFT), which transfers funds from a card to a cardholder's wallet.
cart_itemsHostedPageAdditionalResponseCartItemsDescribes the cart items that the customer is purchasing. These items are displayed at the checkout page.
customerstrDescription of the payment transaction. To display the description, set display_description to true in custom_elements.
escrowboolDetermines whether the payment is held in escrow for later release.
escrow_release_daysfloatDetermines 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_strID of the Rapyd checkout page. String starting with checkout_.
merchant_main_buttonstrA 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.
merchant_privacy_policystrURL for the terms and conditions of the agreement between the client and the client’s customers. To configure this field, use the Client Portal.
merchant_termsstrURL for the client's terms and conditions. To configure this field, use the Client Porta
merchant_websitestrThe 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
custom_elementsHostedPageAdditionalResponseCustomElementsDescription of the payment transaction.
page_expirationfloatLength 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.

Build Your Own SDKs with  liblab

Build developer friendly SDKs in minutes from your APIs

Start for Free →