Interface MerchantAccountCreateParams

Export

MerchantAccountCreateParams

Hierarchy

  • MerchantAccountCreateParams

Properties

email metadata? name? pricing_template_ids? product_code_ids? surcharging_settings?

Properties

email

email: string

The primary user's email address.

Memberof

MerchantAccountCreateParams

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

MerchantAccountCreateParams

Type declaration

  • [key: string]: string

Optional name

name?: string

The business name or individual name.

Memberof

MerchantAccountCreateParams

Optional pricing_template_ids

pricing_template_ids?: string[]

An array of Pricing Template ids to associate with the merchant account. This is ignored for partner accounts. Only 1 pricing template per payment_method_type is allowed. For example, only 1 card and 1 ach_debit template may be submitted for a given merchant. You cannot specify 2 templates of type card for a single merchant. You should create a separate merchant account in that case. Note: Pass an empty array to configure without pricing for now, pricing must be specified before an onboarding application is made available

Memberof

MerchantAccountCreateParams

Optional product_code_ids

product_code_ids?: string[]

Deprecated: Use pricing_template_ids to specify merchant pricing. An array of ProductCode ids to associate with the merchant account. This is ignored for partner accounts. Only 1 capability per payment_method_type is allowed. For example, only 1 card and 1 ach_debit may be submitted for a given merchant. You cannot specify 2 capabilities of type card for a single merchant. You should create a separate merchant account in that case. Note: If your account contains multiple capabilities for a given payment method type, then you must explicitly specify the one you want to use. If your account only contains a single capability per payment method type then those values will be the default. If your account is enabled to process in both the United States and Canada, new merchant accounts will be configured with US capabilities if no value is specified for product_code_ids.

Memberof

MerchantAccountCreateParams

Deprecated

Optional surcharging_settings

surcharging_settings?: SurchargingSettings

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

Memberof

MerchantAccountCreateParams

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc