amount | null | The amount to authorize or capture in the specified currency . only. |
buyerExternalIdentifier | null | An optional external ID for a mattilda Pay buyer. The transaction will automatically be associated to a buyer with that external ID. If no buyer with this external ID exists then it will be ignored. This option is ignored if the buyerId is provided. |
buyerId | null | An optional ID for a mattilda Pay buyer. The transaction will automatically be associated to a buyer with that ID. If no buyer with this ID exists then it will be ignored. |
buyer | null | An optional object to represent the buyer (personal details, billing details, and shipping information). |
country | null | Required A valid ISO 3166 country code. |
currency | null | Required A valid, active, 3-character ISO 4217 currency code to authorize or capture the amount for. |
environment | production | The environment for the request. Can be sandbox or production . |
externalIdentifier | null | An optional external identifier that can be supplied. This will automatically be associated to any resource created by mattilda Pay and can subsequently be used to find a resource by that ID |
gr4vyId | null | Often required Shoult always be set to mattilda . |
intent | authorize | authorize , preferAuthorize , capture - Defines the intent of this API call. This determines the desired initial state of the transaction. When used, preferAuthorize automatically switches to capture if the selected payment method doesn’t support delayed capture. |
locale | en | An optional locale, this consists of a ISO 639 Language Code followed by an optional ISO 3166 Country Code , e.g. en , en-gb or pt-br . |
onEvent | null | An optional event handler to bind to the form. This is called for various events, more on that below. |
store | ask | 'ask' , 'preselect' , true , false - Explicitly store the payment method, ask the buyer or preselect it by default. Requires buyerId or buyerExternalIdentifier . |
theme | null | Theme customization options (See Theming) |
token | null | Required - The server-side generated JWT token used to authenticate any of the API calls. |
onComplete | null | Callback with a transaction object. (Form submission must be handled manually) |
display | all | all , addOnly , storedOnly , supportsTokenization - Filters the payment methods to show stored methods only, new payment methods only or methods that support tokenization. |
onCustomSubmit | null | Callback when a custom payment option is selected and the form submitted. |
metadata | Object | An optional object of key/values for transaction metadata. All values should be a string. |
paymentSource | null | installment , moto , recurring - Can be used to signal that Embed is used to capture the first transaction for a subscription or an installment. When used, store is implied to be true and display is implied to be supportsTokenization . This means that payment options that do not support tokenization are automatically hidden. |
cartItems | Array | An optional array of cart item objects, each object must define a name , quantity , and unitAmount . |
secure | true | An optional boolean which forces iframeHost and apiHost to use https protocol by default. This is useful for local development using http protocol. |
requireSecurityCode | false | An optional boolean which forces security code to be prompted for stored card payments. |
popupTimeout | number | An optional timeout in milliseconds to automatically cancel popup interactions. |
shippingDetailsId | null | An optional unique identifier of a set of shipping details stored for the buyer. |
fullPageReturnUrl | string | An optional return URL that the user will be redirected to when embed is being used in in-app browsers or payments completed in popups where the merchant page has been closed (mobile) |
redirectMode | fallback | fallback , fullPage - An optional configuration to change how redirects to payment providers are performed. fallback will attempt a popup before redirecting, fullPage will always perform a full page redirect rather than using a popup. This can be useful for testing the fallback behavior where a popup could not be used. |
onBeforeTransaction | null | An optional callback hook is called right before a transaction is created. It allows you to change the metadata , externalIdentifier and shippingDetailsId right before a transaction request. This callback should return a promise. |
showDeleteButton | false | An optional boolean which controls the display of the delete button on stored payment methods, so that buyers can delete them. |
merchantAccountId | default | An optional ID for the specific merchant account on the instance. |
billingAddressFields | Object | An optional object with billing details requirements. All properties are optional. Example: { address: { houseNumberOrName: true, line1: true, city: true, postalCode: true, state: true, country: true }, emailAddress: true, firstName: true, lastName: true, taxId: true } |
antiFraudFingerprint | string | An optional string to use as the device fingerprint. Leave unset to opt-in to mattilda Pay’s automatic anti-fraud functionality. |
enableAnimations | false | An optional boolean to turn on animations. |
separatePaymentOptions | false | An optional boolean to separate payment options with a small margin. |
excludedMethods | null | An optional list of methods to be excluded. |
optionLabels | Object | An optional object map of payment option labels |
autoSelectOption | null | first , firstStored , firstNonStored , none - Can be used to tell Embed to automatically select either the very first payment method available, the first stored method, the first non-stored method or not to select any method at all. By default, Embed will automatically select the card method if no stored methods are active. |