NameDescriptionTypeAdditional information
AccountType

Optionally specifies which payment account type to create

PaymentAccountType

None.

CancelURL

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

string

Required

Absolute url

CustomerToken

Optionally contains the unique customer token used to identify the customer the payment account is being added/edited for.

string

None.

DisableDefaultAccountName

Specifies whether to disable the default payment account name. Defaults to false.

boolean

None.

Embedded

Specifies whether to present an embeddable UI.

boolean

None.

ExternalUserID

Contains the unique user ID for the customer that the payment account is being created for.

string

String length: inclusive between 0 and 256

HideLogo

Optionally specifies whether the logo should be hidden from the payment account UI. Defaults to false.

boolean?

None.

HideNickname

Optionally specifies whether the Nickname field should be hidden from the payment account UI. Defaults to false.

boolean?

None.

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

PostbackAuthorization

Optionally provide authorization information to send back to the postback endpoint in the HTTP Authorization header.

string

String length: inclusive between 0 and 4096

PostbackURL

Optionally provide a HTTP endpoint to post the new payment account information including token and description to.

string

String length: inclusive between 0 and 1024

SingleUse

Optionally specifies whether this payment account can only be used for a single payment. Defaults to false.

boolean?

None.

SuccessURL

Contains the URL to redirect the user's browser to once they successfully add/edit a payment account.

string

Required

Absolute url

Token

Optionally specifies the token of the existing payment account to edit. Leave empty/omit for a new payment account.

string

String length: inclusive between 0 and 1024