NameDescriptionTypeAdditional information
AccountLevelAddonPayments

Collection of APIAccountLevelAddOnPayment

None.

AllowPaymentAccountSave

Optionally control whether the user will be allowed to save any payment accounts they add when making the payment. If omitted, will default to true to enrolled payments, false for one-time payments.

boolean?

None.

CancelURL

Contains the URL to redirect the user's browser to if they cancel the payment.

string

Required

Absolute url

Customer

For one-time payments, contains the information of the customer submitting the payment.

CustomerModel

None.

CustomerToken

For enrolled payments, contains the unique customer token used to identify the customer making the payment.

string

None.

Embedded

Specifies whether to present an embeddable UI.

boolean

None.

InvoicePayments

List of invoices that will be paid by this payment.

Collection of SSOPaymentUIInvoiceRequestModel

Required

LanguageCode

Optionally specifies the language to use for the user interface. Specify as a two-character language code.

string

Language code

String length: inclusive between 0 and 2

PaymentAccountType

Optionally restricts which payment account types can be created/used for placing this payment.

PaymentAccountType

None.

SuccessURL

Contains the URL to redirect the user's browser to once they successfully place the payment. The external user ID and the transaction ID will be appended to the query string on the URL so that the destination can identify the transaction that has been placed.

string

Required

Absolute url

UserLevelAddonPayments

Collection of APIAddOnPayment

None.