Skip to main content
Skip table of contents

API Specification Supplement (Entities, Accounts, Merchants, Members)

Entities Class

Field

Required

Variable Type

Variable Min-Max

Example

clientIp

Required

string

Ipv4 or Ipv6 address

255.255.255.255 (Ipv4)

2001:db8:3333:4444:CCCC:DDDD:EEEE:FFFF (Ipv6)

login

Required

string

NA

t1_log_5d5f06bfab1e1bd9105bbe4 (User Login)

type

Required

numeric array

[0] - [6]

1 'Corporation`

name

Required

string

1 - 100 characters

Smith Company LLC (Entity Name)

address1

Required

string

1 - 500 characters

123 North 12 St (Entity First Line of Address)

address2

Optional

string

1 - 500 characters

Apt 1200 (Entity Second Line of Address)

city

Required

string

1 - 500 characters

Miami (City)

state

Required

string array

Enumeration Values

NY ‘New York’

zip

Required

string

1 - 20 characters

33024 (Zip)

country

Required

array

Enumeration Values

USA ‘United States’

timezone

Required

array

Enumeration Values

est ‘Eastern Standard Time’

phone

Required

string

5 - 15 characters

1234567891 (Entity Phone Number)

customerPhone

Optional

string

5 - 15 characters

8001234567 (Entity Customer Service Phone Number)

fax

Optional

string

5 - 15 characters

1987654321 (Entity Fax Number)

email

Required

string

1 - 100 characters

support@example.com (Entity Email Address)

website

Optional

string

1 - 100 characters

www.example.com (Entity Website)

ein

Required

integer

9 characters

123456789 (IRS Employment Number)

locations

Required

integer

1 - 1000000 characters

5000 (Entity Number of Business Locations)

public

Required

boolean

0/1

0 ‘Private entity’

tcVersion

Optional

string

0 - 20 characters

1.2 (Entity Terms and Conditions Version Number)

tcAcceptDate

Optional

digit string

12 digits

(date: YYYMMDDHHII)

201901011430 'January 01, 2019 at 2:30PM`

tcAcceptIp

Optional

string

NA

255.255.255.255 (Term and Conditions IP Address for Entity)

custom

Optional

string

0 - 1000 characters

custom value (free-form field)

reserved

Required

numeric array

[0] - [5]

0 ‘No reserve’

checkStage

Optional

string array

Enumeration Values

postboard ‘Check the Merchant after they are boarded.’

inactive

Required

boolean

0/1

0 ‘Active’

frozen

Required

boolean

0/1

0 ‘Not frozen’

Accounts Class

Field

Required

Variable Type

Variable Min-Max

Example

entity

Required

string

NA

t1_ent_5d5eb377832badd38780044 (Entity Identifier)

account

Required

object

NA

NA

method

Optional

account object property (numeric array)

[1] - [11]

8 ‘Checking’

number

Optional

account object property (text string)

4 - 17 characters

12345678910 (Bank Account Number)

routing

Optional

account object property (text string)

5 - 20 characters

021000021 (Bank Routing Number)

name

Optional

string

0 - 100 characters

Bank Account Name (Client Bank Account Name)

description

Optional

string

0 - 100 characters

Main Bank Account (Client Bank Account Description)

primary

Required

boolean

0/1

1 ‘Primary’

status

Required

numeric array

[0] - [4]

1 ‘Ready’

currency

Required

string array

Enumeration Values

USD ‘United States dollar’

expiration

Optional

digit string

4 digits

(date: MMYY)

0119 ‘January 2019’

inactive

Required

boolean

0/1

0 ‘Active’

frozen

Required

boolean

0/1

0 ‘Not frozen’

Merchant Class

Field

Required

Variable Type

Variable Min-Max

Example

entity

Required

string

NA

t1_ent_5d5eb377832badd38780044 (Entity Identifier)

dba

Optional

string

0 -50 characters

Smith Company LLC (Merchant Business Name)

new

Required

boolean

0/1

1 ‘New’

established

Optional

string

8 digits

(date: YYYYMMDD)

20190101 ‘January 01, 2019’

annualCCSales

Required

integer (in cents)

NA

5050000 ‘$50,500.00’

avgTicket

Required

integer (in cents)

NA

2550 ‘$25.50'

amex

Optional

string

1 - 15 characters

123456789 (AMEX Merchant Identifier)

discover

Optional

string

1 - 15 characters

987654321 (Discover Merchant Identifier)

mcc

Optional

string

4 characters

8111 ‘Legal Services’ (Merchant Category Code)

environment

Required

string array

Enumeration Values

cardPresent ‘Card Present’

status

Required

numeric array

[0] - [4]

1 ‘Ready’

inactive

Required

boolean

0/1

0 'Active

frozen

Required

boolean

0/1

0 ‘Not frozen’

Members Class

Field

Required

Variable Type

Variable Min-Max

Example

merchant

Required

string

NA

t1_mer_5d5f06bfb05e0ca0194f6fc (Merchant Identifier)

title

Optional

string

0 - 100 characters

CEO (Member Relation with Associated Merchant)

first

Required

string

1 - 100 characters

Smith (Member First Name)

middle

Optional

string

0 - 100 characters

Smith (Member Middle Name)

last

Required

string

1 - 100 characters

Smith (Member Last Name)

ssn

Optional

string

9 characters

123456789 (Member Social Security Number)

dob

Required

string

8 digits

(date: YYYYMMDD)

20190101 ‘January 01, 2019’

gender

Optional

string array

Enumeration Values

female ‘Female’

dl

Optional

string

0 - 15 characters

1234567891 (Member Driver’s License)

dlstate

Optional

string array

Enumeration Values

NY ‘New York’

email

Required

string

1 - 100 characters

support@example.com (Member Email Address)

ownership

Required

integer (in basis points)

1 - 10000 characters

5550 ‘55.5%’

primary

Required

boolean

0/1

1 ‘Primary’

timezone

Required

array

Enumeration Values

est ‘Eastern Standard Time’

address1

Optional

string

1 - 500 characters

123 North 12 St (Member First Line of Address)

address2

Optional

string

1 - 500 characters

Apt 1200 (Member Second Line of Address)

city

Optional

string

1 - 500 characters

Miami (City)

state

Optional

string array

Enumeration Values

NY ‘New York’

zip

Optional

string

1 - 20 characters

33024 (Zip)

country

Optional

array

Enumeration Values

USA ‘United States’

phone

Optional

string

5 - 15 characters

1234567891 (MemberPhone Number)

fax

Optional

string

5 - 15 characters

1987654321 (Member Fax Number)

inactive

Required

boolean

0/1

0 'Active

frozen

Required

boolean

0/1

0 ‘Not frozen’

JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.