Interface AccountUpdateParams

Export

AccountUpdateParams

Hierarchy

  • AccountUpdateParams

Properties

bank_account? email? metadata? name? settings? surcharging_settings? white_label_domain?

Properties

Optional bank_account

bank_account?: BankAccountCreateParams

A bank account to attach to this account for receiving payouts. (Note: currently this is only used for partner account payouts) By default, providing a bank account sets it as the new default bank account for its currency.

Memberof

AccountUpdateParams

Optional email

email?: string

The primary user's email address.

Memberof

AccountUpdateParams

Optional metadata

metadata?: {
    [key: string]: string;
}

Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value (i.e. \'\' or null) to them. All keys can be unset by posting an empty value (i.e. {} or null) to metadata.

Memberof

AccountUpdateParams

Type declaration

  • [key: string]: string

Optional name

name?: string

The business name or individual name.

Memberof

AccountUpdateParams

Optional settings

settings?: AccountSettingsCreateParams

Account Settings

Memberof

AccountUpdateParams

Optional surcharging_settings

surcharging_settings?: SurchargingSettings

Surcharging settings for the account. Currently in beta and not available to all accounts.

Memberof

AccountUpdateParams

Optional white_label_domain

white_label_domain?: string

The custom domain the partner chooses to reflect on all of its merchant accounts as part of the white label settings. It requires paymentsonline.io to be appended to the string to be accepted as a valid URL (i.e. https://customdomain.paymentsonline.io). Note: This feature is only available to Partner accounts.

Memberof

AccountUpdateParams

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc