# Ready to pay requested

Endpoint: POST ready-to-pay-requested
Version: latest
Security: SecretApiKey, JWT

## Request fields (application/json):

  - `eventType` (string)
    Type of event that triggered the webhook.
    Enum: "ready-to-pay-requested"

  - `websiteId` (string)
    ID of the website.
A website is where an organization obtains a customer.
For more information, see [Obtain an organization ID and website ID](https://www.rebilly.com/docs/settings/organizations-and-websites/#obtain-your-organization-id-and-website-id).

  - `currency` (string)
    Currency of the ready to pay request.

  - `amount` (number)
    Amount of the ready to pay request.

  - `items` (array)

  - `items.planId` (string, required)
    ID of the plan.
    Example: "plan_0YV7DENSVGDBW9S71XZNNYYQ0X"

  - `items.quantity` (integer, required)
    Number of product units in the specified plan.

  - `billingAddress` (any)
    Customer's billing address.

  - `riskMetadata` (object)
    Risk metadata used for 3D Secure and risk scoring.

  - `riskMetadata.ipAddress` (string,null)
    Customer's IP address.
    Example: "93.92.91.90"

  - `riskMetadata.fingerprint` (string,null)
    Customer's device fingerprint.
A device fingerprint is a unique token that is used to identify the customer.
The device fingerprint is generated based on device attributes, such as: hardware,
software, IP address, language, browser, and more.
    Example: "pIUt3xbgX3l9g3YDiLbx"

  - `riskMetadata.httpHeaders` (any)

  - `riskMetadata.browserData` (object,null)
    Browser data used for 3D Secure and risk scoring.

  - `riskMetadata.browserData.colorDepth` (integer, required)
    Browser color depth in bits per pixel. This value is obtained using the  property.
    Example: 24

  - `riskMetadata.browserData.isJavaEnabled` (boolean, required)
    Specifies if Java is enabled in a browser. This value is obtained from the  property.

  - `riskMetadata.browserData.language` (string, required)
    Browser language settings. This value is obtained from the  property.
    Example: "en-US"

  - `riskMetadata.browserData.screenWidth` (integer, required)
    Width of the browser screen. This value is obtained from the  property.
    Example: 1920

  - `riskMetadata.browserData.screenHeight` (integer, required)
    Height of the browser screen. This value is obtained from the  property.
    Example: 1080

  - `riskMetadata.browserData.timeZoneOffset` (integer, required)
    Browser time zone offset in minutes from UTC.
A positive offset indicates that the local time is behind UTC.
A negative offset indicates that the local time is ahead of UTC.
You can find this value using the  property.
    Example: 300

  - `riskMetadata.browserData.isAdBlockEnabled` (boolean)
    Specifies if the usage of ad block has been detected in the browser.

  - `riskMetadata.extraData` (object,null)
    Third-party data used for risk scoring.

  - `riskMetadata.extraData.kountFraudSessionId` (string)
    Alpha-numeric  as provided by the Kount SDK.
    Example: "abcdefg12345abababab123456789012"

  - `riskMetadata.extraData.payPalMerchantSessionId` (string)
    PayPal  as generated by the PayPal Fraudnet SDK.
    Example: "dd65ratxc5qv15iph3vyoq7l6davuowa"

  - `riskMetadata.extraData.threatMetrixSessionId` (string)
    Temporary identifier that is unique to the visitor's session and passed to ThreatMetrix.
    Example: "dd65ratxc5qv15iph3vyoq7l6davuowadd65ratxc5qv15iph3vyoq7l6davuowa"

  - `customerId` (string)
    ID of the customer resource.

  - `transactionId` (string)
    ID of the transaction.

  - `_embedded` (object)
    Embedded objects related to the ready to pay event.

  - `_embedded.checkoutForm` (object)

  - `_embedded.checkoutForm.customDomain` (string,null)
    Custom domain for the checkout form.

  - `_embedded.checkoutForm.plans` (array, required)
    List of plans that are applied to a customer order by default.
Plans describe how the customer must pay for products. For more information, see [Plans](https://www.rebilly.com/docs/dev-docs/api/plans/).

  - `_embedded.checkoutForm.addonPlans` (array)
    List of add-on plans that are displayed to the customer on the payment screen.
Add-ons are plans that the customer has not already subscribed to.

The customer selects whether to add an add-on plan to their current order.

  - `_embedded.checkoutForm.bumpPlans` (array)
    List of bump plans that are displayed to the customer on the payment screen.
Use bump plans to offer purchase bonuses, discounts, and deals to the customer.

The customer selects whether to purchase bump plans,
or to use the plans that are specified in their current order.

  - `_embedded.checkoutForm.accountsEnabled` (boolean)
    Specifies if the account is enabled.
If this value is , the customer can sign-up and sign-in using the checkout form.

  - `_embedded.checkoutForm.couponsEnabled` (boolean)
    Specifies if coupons are enabled in the checkout form.
If this value is , the customer can use coupons in the checkout form.
Use coupons to reward customers, generate sales, or to test new pricing strategies.

  - `_embedded.checkoutForm.purchaseLimit` (integer,null)
    Limits the number of purchases that can be made using a specific checkout form.
If a purchase limit value is set, each purchase decreases this value.
When the purchases limit value reaches zero, the checkout form becomes inactive.

  - `_embedded.checkoutForm.paymentMethods` (array)
    List of available payment methods.
Payment methods must have at least one active gateway account.
If not specified, all available payment methods are displayed.
    Enum: "payment-card", "ach", "cash", "check", "paypal", "AdvCash", "Aera", "Affirm", "Afterpay", "Aircash", "Airpay", "Alfa-click", "Alipay", "AmazonPay", "Apple Pay", "AstroPay Card", "AstroPay-GO", "BankSEND", "BankReferenced", "bank-transfer", "bank-transfer-2", "bank-transfer-3", "bank-transfer-4", "bank-transfer-5", "bank-transfer-6", "bank-transfer-7", "bank-transfer-8", "bank-transfer-9", "Baloto", "Beeline", "Belfius-direct-net", "bitcoin", "Bizum", "Blik", "Boleto", "Boleto-2", "Boleto-3", "cash-deposit", "CASHlib", "CashToCode", "CCAvenue", "China UnionPay", "Clearpay", "Cleo", "CODVoucher", "Conekta-oxxo", "Conekta-spei", "cryptocurrency", "Cupon-de-pagos", "CyberSource", "Dimoco-pay-smart", "Directa24Card", "domestic-cards", "Efecty", "echeck", "ecoPayz", "ecoPayzTurkey", "ecoVoucher", "EPS", "ePay.bg", "Ethereum", "e-wallet", "ezyEFT", "eZeeWallet", "FasterPay", "Flexepin", "Giropay", "Google Pay", "Gpaysafe", "iCashOne Voucher", "iDebit", "iDEAL", "ING-homepay", "INOVAPAY-pin", "INOVAPAY-wallet", "InstaDebit", "InstantPayments", "instant-bank-transfer", "Interac-online", "Interac-eTransfer", "Interac-express-connect", "Interac", "invoice", "iWallet", "Jeton", "JetonCash", "jpay", "KakaoPay", "Khelocard", "Klarna", "KNOT", "Litecoin", "loonie", "LPG-online", "LPG-payment-card", "Matrix", "MaxiCash", "Megafon", "MercadoPago", "MiFinity-eWallet", "miscellaneous", "MobilePay", "Multibanco", "Bancontact", "Bancontact-mobile", "MTS", "MuchBetter", "MyFatoorah", "Neosurf", "Netbanking", "Neteller", "Nordea-Solo", "NordikCoin", "OchaPay", "online-bank-transfer", "Onlineueberweisen", "oriental-wallet", "OXXO", "P24", "Pagadito", "PagoEffectivo", "Pagsmile-lottery", "Pagsmile-deposit-express", "PayCash", "Payco", "Payeer", "PaymentAsia-crypto", "Paysafecard", "PayTabs", "Pay4Fun", "Paynote", "Paymero", "Paymero-QR", "PayU", "PayULatam", "Perfect-money", "Piastrix", "PIX", "PinPay", "phone", "PhonePe", "POLi", "PostFinance-card", "PostFinance-e-finance", "QIWI", "QPay", "QQPay", "rapyd-checkout", "rebilly-hosted-payment-form", "Resurs", "reverse-withdrawal", "Ripple", "SafetyPay", "Samsung Pay", "SEPA", "Siirto", "Skrill", "Skrill Rapid Transfer", "SMSVoucher", "Sofort", "SparkPay", "SPEI", "swift-dbt", "Tele2", "Telr", "Terminaly-RF", "Tether", "ToditoCash-card", "Trustly", "Tupay", "TWINT", "UniCrypt", "UPayCard", "UPI", "USD-coin", "VCreditos", "VegaWallet", "VenusPoint", "voucher", "voucher-2", "voucher-3", "voucher-4", "Wallet88", "Webmoney", "Webpay", "Webpay-2", "Webpay Card", "WeChat Pay", "XPay-P2P", "XPay-QR", "Yandex-money", "Zotapay", "Zimpler", "Zip"

  - `_embedded.checkoutForm.customization` (object)
    Visual customization options for the checkout form.

  - `_embedded.checkoutForm.customization.logoId` (string,null)
    ID of the linked file object.
    Example: "file_0YV7HZ7KDCC5WBV9Q7WRKG1H6N"

  - `_embedded.checkoutForm.customization.summary` (string,null)
    Summary text.

  - `_embedded.checkoutForm.customization.buttonText` (string)
    Button text. Use the  placeholder to display the checkout form total.

  - `_embedded.checkoutForm.customization.colors` (object)
    Primary color used in the checkout form and button text.

  - `_embedded.checkoutForm.customization.colors.primary` (string)
    Primary color for the checkout form in hexadecimal format.

  - `_embedded.checkoutForm.customization.colors.buttonText` (string)
    Button text color for the checkout form in hexadecimal format.

  - `_embedded.checkoutForm.customization.links` (object)
    URLs that are displayed on the checkout form.

  - `_embedded.checkoutForm.customization.links.refundPolicy` (string,null)
    Website refund policy URL.

  - `_embedded.checkoutForm.customization.links.privacyPolicy` (string,null)
    Website privacy policy URL.

  - `_embedded.checkoutForm.customization.links.termsOfService` (string,null)
    Website terms of service URL.

  - `_embedded.checkoutForm.customization.tracking` (object)
    Tracking system IDs.

  - `_embedded.checkoutForm.customization.tracking.googleAnalytics` (string,null)
    Google Analytics tracking ID.
    Example: "UA-XXXXX-YY"

  - `_embedded.checkoutForm.customization.tracking.googleTagManager` (string,null)
    Google Tag Manager tracking ID.
    Example: "GTM-XXXXX"

  - `_embedded.checkoutForm.customization.tracking.gtagJs` (string,null)
    Google Analytics tracking ID.
This value is used by Google Global Site Tag (gtag.js) service.
    Example: "UA-XXXXX-YY"

  - `_embedded.checkoutForm.customization.tracking.facebookPixel` (string,null)
    Facebook Pixel tracking ID.
    Example: "1234567890"

  - `_embedded.checkoutForm.customization.tracking.segmentAnalytics` (string,null)
    Segment Analytics tracking ID.
    Example: "1234567890"

  - `_embedded.checkoutForm.customization.tracking.heapIo` (string,null)
    Heap.io tracking ID.
    Example: "1234567890"

  - `_embedded.checkoutForm.customization.requiredAdditionalFields` (array)
    List of required fields.
    Example: ["information.companyName","information.phoneNumber"]

  - `_embedded.checkoutForm.name` (string, required)
    Name of the checkout form.
This name value is for internal display, and is not visible to your customers.
Use this name to locate and organize your checkout forms.

  - `_embedded.checkoutForm.status` (string)
    Status of the checkout form. If the  value is ,
the checkout form URL produces a 404 error.
    Enum: "active", "inactive"

  - `_embedded.customer` (object)
    Customer information.

  - `_embedded.customer.paymentToken` (string)
    Write-only payment token.
If supplied, the token is converted into a payment instrument and set as the  value.
If both are supplied, the value of this property overrides the  value.
The token expires after first use.

  - `_embedded.customer.defaultPaymentInstrument` (object,null)

  - `_embedded.customer.preferredPayoutInstrumentId` (string,null)
    ID of the customer's preferred payment instrument for payouts.
    Example: "inst_0YVB8KPKNXCBR9EDX7JHSED75N"

  - `_embedded.customer.customFields` (object)
    Use custom fields to extend a resource scheme to include custom data that is not provided as a common field.
For more information, see [Custom fields](https://www.rebilly.com/catalog/all/custom-fields).

  - `_embedded.customer.primaryAddress` (any)
    Customer's primary address.

  - `_embedded.customer.isEddRequired` (boolean)
    Specifies if Enhanced Due Diligence (EDD) is enabled for this customer.
For more information, see [Enhanced Due Diligence](https://www.rebilly.com/docs/kyc-and-aml/edd/).

  - `_embedded.customer.locale` (string,null)
    Language locale identifier in [RFC 5646](https://tools.ietf.org/html/rfc5646) format.
    Example: "fr-FR"

  - `_embedded.customer.taxNumbers` (array,null)
    Tax numbers of the customer.

  - `_embedded.customer.taxNumbers.type` (string, required)
    Type of the tax number.
    Enum: "eu-vat", "other"

  - `_embedded.customer.taxNumbers.value` (string, required)
    Value of the tax number.
    Example: "GB980780684"

  - `_embedded.customer.taxNumbers.isDefault` (boolean)
    Determines if the tax number is selected as default to display on invoices.
    Example: true

  - `_embedded.customer.leadSource` (object)
    Lead source information.

  - `_embedded.customer.leadSource.medium` (string,null)
    Category of the lead source traffic.
For example, the medium could be organic search, Google ads, Display ads, and so on.

  - `_embedded.customer.leadSource.source` (string,null)
    Domain, platform, or channel from which the lead source originates.

  - `_embedded.customer.leadSource.campaign` (string,null)
    Campaign name of the lead source.

  - `_embedded.customer.leadSource.term` (string,null)
    Term associated with a lead source.

  - `_embedded.customer.leadSource.content` (string,null)
    Content contained in the lead source content.
For example, content could be graphics, video, and so on.

  - `_embedded.customer.leadSource.affiliate` (string,null)
    Individual or entity that is affiliated with the lead source.

  - `_embedded.customer.leadSource.subAffiliate` (string,null)
    Individual or entity that is associated with a lead source affiliate.
In other products, this field may also be referred to as sub ID or click ID in some.

  - `_embedded.customer.leadSource.salesAgent` (string,null)
    Name of the sales agent associated with the lead source.

  - `_embedded.customer.leadSource.clickId` (string,null)
    ID of the lead source click.
This value is passed in the ad click URL for tracking and campaign attribution.

  - `_embedded.customer.leadSource.path` (string,null)
    URL from which the lead source originates.

  - `_embedded.customer.leadSource.referrer` (string,null)
    Lead source [ URL](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Referer).

  - `_embedded.transaction` (object)
    Transaction information.

  - `_embedded.transaction.parentTransactionId` (string)
    ID of the parent transaction.
    Example: "txn_0YVDTQJ8YWDGQACV2N2N5SPWQ0"

  - `_embedded.transaction.billingAddress` (object)
    Billing address.

  - `_embedded.transaction.billingAddress.firstName` (string,null)
    Contact's first name.
    Example: "Benjamin"

  - `_embedded.transaction.billingAddress.lastName` (string,null)
    Contact's last name.
    Example: "Franklin"

  - `_embedded.transaction.billingAddress.organization` (string,null)
    Contact's organization.
    Example: "Rebilly"

  - `_embedded.transaction.billingAddress.address` (string,null)
    First line of the contact's street address.
    Example: "36 Craven St"

  - `_embedded.transaction.billingAddress.address2` (string,null)
    Second line of the contact's street address.

  - `_embedded.transaction.billingAddress.city` (string,null)
    Contact's city of residence.
    Example: "Austin"

  - `_embedded.transaction.billingAddress.region` (string,null)
    Contact's region of residence.
    Example: "Texas"

  - `_embedded.transaction.billingAddress.country` (string,null)
    Contact's country of residence in ISO 3166 alpha-2 country code.
For examples, see [ISO.org](https://www.iso.org/obp/ui/#search/code/).
    Example: "GB"

  - `_embedded.transaction.billingAddress.postalCode` (string,null)
    Contact's postal code.
    Example: "WC2N 5NF"

  - `_embedded.transaction.billingAddress.phoneNumbers` (array)
    List of phone numbers associated with the contact.

  - `_embedded.transaction.billingAddress.phoneNumbers.label` (string, required)
    Phone number label or name.
    Example: "main"

  - `_embedded.transaction.billingAddress.phoneNumbers.value` (string, required)
    Phone number value.
    Example: "1-512-777-0269"

  - `_embedded.transaction.billingAddress.phoneNumbers.primary` (boolean)
    Specifies if the phone number is the contact's primary phone number.
    Example: true

  - `_embedded.transaction.billingAddress.emails` (array)
    List of email addresses associated with the contact.

  - `_embedded.transaction.billingAddress.emails.label` (string, required)
    Email label or name.
    Example: "main"

  - `_embedded.transaction.billingAddress.emails.value` (string, required)
    Email address value.
    Example: "rebilly@example.com"

  - `_embedded.transaction.billingAddress.emails.primary` (boolean)
    Specifies if the email address is the contact's primary email address.
    Example: true

  - `_embedded.transaction.billingAddress.dob` (string,null)
    Contact's date of birth in ISO-8601  format.
    Example: "1980-04-01"

  - `_embedded.transaction.billingAddress.jobTitle` (string,null)
    Contact's job title.
    Example: "CEO"

  - `_embedded.transaction.redirectUrl` (string,null)
    URL where the end-user is redirected to when an offsite transaction is completed.
The default value is the website URL.

  - `_embedded.transaction.description` (string)
    Description of the payment.

  - `_embedded.transaction.requestId` (string)
    Request ID of the transaction. This ID must be unique within a 24 hour period.
Use this field to prevent duplicated transactions.

  - `_embedded.transaction.velocity` (integer)
    Number of transactions by the same customer in the past 24 hours.

  - `_embedded.transaction.paymentInstrument` (object)

  - `_embedded.transaction.riskMetadata` (any)

  - `_embedded.transaction.notificationUrl` (string,null)
    URL where a server-to-server POST notification is sent.
This notification is sent when the transaction result is finalized after a timeout or an offsite interaction.

Do not interpret this notification as a confirmation,
complete a  request to confirm the result of the transaction.
To ensure the request is not reattempted,
when the result is confirmed, respond with a  HTTP status code.

The following placeholders are available to use in this URI:  and .
These placeholders are replaced the with the transaction ID and result accordingly.

  - `_embedded.transaction.isProcessedOutside` (boolean)
    Specifies if the transaction is processed outside of Rebilly.

  - `_embedded.transaction.isMerchantInitiated` (boolean)
    Specifies if the transaction is initiated by the merchant.

  - `_embedded.transaction.limits` (object,null)
    Transaction amount limit information.

  - `_embedded.transaction.limits.amount` (number)
    Limit amount.
    Example: 275.35

  - `_embedded.transaction.limits.currency` (string)
    Currency code in ISO 4217 format.

  - `_embedded.transaction.limits.resetTime` (string,null)
    Date and time in which the limit amount resets.
This value may be used for user interfaces.

  - `_embedded.transaction.method` (string)
    Payment method.

> Use  instead.
    Enum: "payment-card", "ach", "cash", "check", "paypal", "AdvCash", "Aera", "Affirm", "Afterpay", "Aircash", "Airpay", "Alfa-click", "Alipay", "AmazonPay", "Apple Pay", "AstroPay Card", "AstroPay-GO", "BankSEND", "BankReferenced", "bank-transfer", "bank-transfer-2", "bank-transfer-3", "bank-transfer-4", "bank-transfer-5", "bank-transfer-6", "bank-transfer-7", "bank-transfer-8", "bank-transfer-9", "Baloto", "Beeline", "Belfius-direct-net", "bitcoin", "Bizum", "Blik", "Boleto", "Boleto-2", "Boleto-3", "cash-deposit", "CASHlib", "CashToCode", "CCAvenue", "China UnionPay", "Clearpay", "Cleo", "CODVoucher", "Conekta-oxxo", "Conekta-spei", "cryptocurrency", "Cupon-de-pagos", "CyberSource", "Dimoco-pay-smart", "Directa24Card", "domestic-cards", "Efecty", "echeck", "ecoPayz", "ecoPayzTurkey", "ecoVoucher", "EPS", "ePay.bg", "Ethereum", "e-wallet", "ezyEFT", "eZeeWallet", "FasterPay", "Flexepin", "Giropay", "Google Pay", "Gpaysafe", "iCashOne Voucher", "iDebit", "iDEAL", "ING-homepay", "INOVAPAY-pin", "INOVAPAY-wallet", "InstaDebit", "InstantPayments", "instant-bank-transfer", "Interac-online", "Interac-eTransfer", "Interac-express-connect", "Interac", "invoice", "iWallet", "Jeton", "JetonCash", "jpay", "KakaoPay", "Khelocard", "Klarna", "KNOT", "Litecoin", "loonie", "LPG-online", "LPG-payment-card", "Matrix", "MaxiCash", "Megafon", "MercadoPago", "MiFinity-eWallet", "miscellaneous", "MobilePay", "Multibanco", "Bancontact", "Bancontact-mobile", "MTS", "MuchBetter", "MyFatoorah", "Neosurf", "Netbanking", "Neteller", "Nordea-Solo", "NordikCoin", "OchaPay", "online-bank-transfer", "Onlineueberweisen", "oriental-wallet", "OXXO", "P24", "Pagadito", "PagoEffectivo", "Pagsmile-lottery", "Pagsmile-deposit-express", "PayCash", "Payco", "Payeer", "PaymentAsia-crypto", "Paysafecard", "PayTabs", "Pay4Fun", "Paynote", "Paymero", "Paymero-QR", "PayU", "PayULatam", "Perfect-money", "Piastrix", "PIX", "PinPay", "phone", "PhonePe", "POLi", "PostFinance-card", "PostFinance-e-finance", "QIWI", "QPay", "QQPay", "rapyd-checkout", "rebilly-hosted-payment-form", "Resurs", "reverse-withdrawal", "Ripple", "SafetyPay", "Samsung Pay", "SEPA", "Siirto", "Skrill", "Skrill Rapid Transfer", "SMSVoucher", "Sofort", "SparkPay", "SPEI", "swift-dbt", "Tele2", "Telr", "Terminaly-RF", "Tether", "ToditoCash-card", "Trustly", "Tupay", "TWINT", "UniCrypt", "UPayCard", "UPI", "USD-coin", "VCreditos", "VegaWallet", "VenusPoint", "voucher", "voucher-2", "voucher-3", "voucher-4", "Wallet88", "Webmoney", "Webpay", "Webpay-2", "Webpay Card", "WeChat Pay", "XPay-P2P", "XPay-QR", "Yandex-money", "Zotapay", "Zimpler", "Zip"

  - `_embedded.transaction.orderId` (string)
    Order ID of the transaction.
This ID must be unique within a 24 hour period.

>  Use the  field instead.

  - `_embedded.website` (object)

  - `_embedded.website.name` (string, required)
    Name of the website.

  - `_embedded.website.url` (string, required)
    Domain address of the website.

  - `_embedded.website.servicePhone` (string, required)
    Customer service phone number of the website.

  - `_embedded.website.serviceEmail` (string, required)
    Customer service email address of the website.

  - `_embedded.website.settings` (object)
    Website settings.

  - `_embedded.website.settings.depositForm` (object)
    Deposit form settings.

  - `_embedded.website.settings.depositForm.theme` (object,null)
    Theme settings that are used in the deposit form.

  - `_embedded.website.settings.depositForm.theme.colorPrimary` (string,null)
    Primary color for the deposit form in hexadecimal format.
    Example: "0044d4"

  - `_embedded.website.settings.depositForm.theme.colorSecondary` (string,null)
    Secondary color for the deposit form in hexadecimal format.
    Example: "ffffff"

  - `_embedded.website.settings.depositForm.theme.buttonTemplate` (string,null)
    Submit button template.  can be used as a placeholder for amount and currency.
    Example: "Pay {{amount}}"

  - `_embedded.website.settings.paymentForm` (object)
    Payment form settings.

  - `_embedded.website.settings.paymentForm.css` (string,null)
    Hosted payment form [CSS options](https://www.rebilly.com/docs/content/concepts-and-features/tutorial/customize-style-rebilly-instruments/#2-use-css-property-to-override-any-styles).

  - `_embedded.website.settings.paymentForm.theme` (object,null)
    Hosted payment form [theme options](https://www.rebilly.com/docs/content/concepts-and-features/tutorial/customize-style-rebilly-instruments/#adjust-the-default-style).
    Example: {"colorPrimary":"#504CCA"}

  - `_embedded.website.settings.paymentForm.features` (object,null)
    Hosted payment form features.

  - `_embedded.website.settings.paymentForm.features.showCoupons` (array,null)

  - `_embedded.website.settings.paymentForm.features.fullPageRedirect` (boolean,null)
    Specifies whether the hosted payment form uses a full page redirect, or the default iframe modal, for approval URL redirects.

  - `_embedded.website.settings.paymentForm.features.skipRedirectOnPaymentComplete` (boolean,null)
    Specifies whether the hosted payment form skips the redirect to the website URL when the payment is completed.

  - `_embedded.website.settings.paymentForm.features.hideZeroAmountSummaryItems` (boolean,null)
    Specifies whether the hosted payment form displays 0 amount line items in the summary.

  - `_embedded.website.settings.amplitude` (object)
    Amplitude settings. Amplitude is an analytics tool for tracking user behavior.

  - `_embedded.website.settings.amplitude.tracking` (boolean)
    Specifies whether the hosted pages, such as KYC pages, include Amplitude analytics.

  - `_embedded.website.settings.amplitude.apiKey` (string,null)
    API key of an Amplitude project.
    Example: "35d1795750c585984f7e6b01c0ca6e19"

  - `_links` (array)
    Links to related resources.

  - `_links.href` (string)
    URL of the link.

  - `_links.rel` (string)
    Relationship type of the link.
    Enum: "checkoutForm", "customer", "transaction", "website"