NameDescriptionTypeAdditional information
AccountType

PaymentAccountType

None.

AchAccountNumber

string

Matching regular expression pattern: ^(([0-9]{4,17}))$

AchInstitutionNumber

string

Matching regular expression pattern: \d{3}

AchRegion

PaymentAccountAchRegionType

None.

AchRememberMe

boolean?

None.

AchRoutingNumber

Canadian Routing number is stored as a single value in the RoutingNumber field, formatted according to the Canadian Standard 0005 rules. Format: 0{institutionNumber}{transitNumber}. Example: 000300001 Where, Bank Number: 003 and Transit Number: 00001

string

String length: inclusive between 0 and 256

AchTransitNumber

string

Matching regular expression pattern: \d{5}

AchType

PaymentAccountAchType

None.

AchUsageType

PaymentAccountAchUsageType

None.

AchValidate

Optionally specifies whether this account should be run against the ACH Account Validation Service when being saved to an enrolled customer profile

boolean

None.

Address

Customer address line. If Foreign address support is enabled, enter complete address in this field and leave Address2, City, State and Zip empty.

string

Matching regular expression pattern: ^[a-zA-Z0-9-.\,'\#\(\)\&\/\s]+$

String length: inclusive between 0 and 256

Address2

Customer address line 2

string

Matching regular expression pattern: ^[a-zA-Z0-9-. \,'\#\(\)\&]+$

String length: inclusive between 0 and 100

Agree

boolean

None.

CcAccountNumber

string

Matching regular expression pattern: ^([0-9]+)|(\*{5}\d{4})$

CcCardType

PaymentAccountCcCardType

None.

CcCVV

string

Matching regular expression pattern: \d{3,4}

CcExpirationDate

string

Matching regular expression pattern: ^((0[1-9]|1[0-2])|([1-9]))\/([0-9]{4}|[0-9]{2})$

CcRememberMe

boolean?

None.

City

Customer address city

string

Matching regular expression pattern: ^[a-zA-Z '\.]+((\s|\-)[a-zA-Z '\.]+)?$

String length: inclusive between 0 and 50

Country

Provide the customer's country as a 3-character ISO code. This is applicable when foreign address support is enabled. Defaults to 'USA' if not specified.

string

None.

Description

string

Matching regular expression pattern: ^[a-zA-Z0-9,\`\&\@\.\!\-_\# \*']+$

EnrollInRTP

boolean

None.

IsPinacleAccount

boolean?

None.

IsRTP

boolean?

None.

IsWalkIn

boolean

None.

Name

string

Matching regular expression pattern: ^[a-zA-Z0-9,\`\&'\.\-\:/ ']+((\s|\-)[a-zA-Z0-9,\`\&'\.\:/']+)?$

NotifyBillsToPinacle

boolean

None.

SingleUse

boolean

None.

SkipAccountOwnerCheck

boolean?

None.

State

Customer's address state code as a 2-character code. If provided, must be a 2 character US State, Territory, or Canadian province

string

None.

TerminalID

string

String length: inclusive between 0 and 1024

Token

string

String length: inclusive between 0 and 2048

Zip

string

Matching regular expression pattern: (^(\d{5})(-?(\d{4}))?$)|(^([abceghjklmnprstvxyABCEGHJKLMNPRSTVXY]{1}\d{1}[a-zA-Z]{1})([ \-])*(\d{1}[a-zA-Z]{1}\d{1})$)

String length: inclusive between 0 and 15