API Specification Supplement (Entities, Accounts, Merchants, Members)
Entities Class
Field | Required | Variable Type | Variable Min-Max | Example |
---|---|---|---|---|
clientIp | Required | string | Ipv4 or Ipv6 address |
|
login | Required | string | NA |
|
type | Required | numeric array | [0] - [6] |
|
name | Required | string | 1 - 100 characters |
|
address1 | Required | string | 1 - 500 characters |
|
address2 | Optional | string | 1 - 500 characters |
|
city | Required | string | 1 - 500 characters |
|
state | Required | string array | Enumeration Values |
|
zip | Required | string | 1 - 20 characters |
|
country | Required | array | Enumeration Values |
|
timezone | Required | array | Enumeration Values |
|
phone | Required | string | 5 - 15 characters |
|
customerPhone | Optional | string | 5 - 15 characters |
|
fax | Optional | string | 5 - 15 characters |
|
Required | string | 1 - 100 characters |
| |
website | Optional | string | 1 - 100 characters |
|
ein | Required | integer | 9 characters |
|
locations | Required | integer | 1 - 1000000 characters |
|
public | Required | boolean | 0/1 |
|
tcVersion | Optional | string | 0 - 20 characters |
|
tcAcceptDate | Optional | digit string | 12 digits (date: YYYMMDDHHII) |
|
tcAcceptIp | Optional | string | NA |
|
custom | Optional | string | 0 - 1000 characters |
|
reserved | Required | numeric array | [0] - [5] |
|
checkStage | Optional | string array | Enumeration Values |
|
inactive | Required | boolean | 0/1 |
|
frozen | Required | boolean | 0/1 |
|
Accounts Class
Field | Required | Variable Type | Variable Min-Max | Example |
---|---|---|---|---|
entity | Required | string | NA |
|
account | Required | object | NA | NA |
method | Optional | account object property (numeric array) | [1] - [11] |
|
number | Optional | account object property (text string) | 4 - 17 characters |
|
routing | Optional | account object property (text string) | 5 - 20 characters |
|
name | Optional | string | 0 - 100 characters |
|
description | Optional | string | 0 - 100 characters |
|
primary | Required | boolean | 0/1 |
|
status | Required | numeric array | [0] - [4] |
|
currency | Required | string array | Enumeration Values |
|
expiration | Optional | digit string | 4 digits (date: MMYY) |
|
inactive | Required | boolean | 0/1 |
|
frozen | Required | boolean | 0/1 |
|
Merchant Class
Field | Required | Variable Type | Variable Min-Max | Example |
---|---|---|---|---|
entity | Required | string | NA |
|
dba | Optional | string | 0 -50 characters |
|
new | Required | boolean | 0/1 |
|
established | Optional | string | 8 digits (date: YYYYMMDD) |
|
annualCCSales | Required | integer (in cents) | NA |
|
avgTicket | Required | integer (in cents) | NA |
|
amex | Optional | string | 1 - 15 characters |
|
discover | Optional | string | 1 - 15 characters |
|
mcc | Optional | string | 4 characters |
|
environment | Required | string array | Enumeration Values |
|
status | Required | numeric array | [0] - [4] |
|
inactive | Required | boolean | 0/1 |
|
frozen | Required | boolean | 0/1 |
|
Members Class
Field | Required | Variable Type | Variable Min-Max | Example |
---|---|---|---|---|
merchant | Required | string | NA |
|
title | Optional | string | 0 - 100 characters |
|
first | Required | string | 1 - 100 characters |
|
middle | Optional | string | 0 - 100 characters |
|
last | Required | string | 1 - 100 characters |
|
ssn | Optional | string | 9 characters |
|
dob | Required | string | 8 digits (date: YYYYMMDD) |
|
gender | Optional | string array | Enumeration Values |
|
dl | Optional | string | 0 - 15 characters |
|
dlstate | Optional | string array | Enumeration Values |
|
Required | string | 1 - 100 characters |
| |
ownership | Required | integer (in basis points) | 1 - 10000 characters |
|
primary | Required | boolean | 0/1 |
|
timezone | Required | array | Enumeration Values |
|
address1 | Optional | string | 1 - 500 characters |
|
address2 | Optional | string | 1 - 500 characters |
|
city | Optional | string | 1 - 500 characters |
|
state | Optional | string array | Enumeration Values |
|
zip | Optional | string | 1 - 20 characters |
|
country | Optional | array | Enumeration Values |
|
phone | Optional | string | 5 - 15 characters |
|
fax | Optional | string | 5 - 15 characters |
|
inactive | Required | boolean | 0/1 |
|
frozen | Required | boolean | 0/1 |
|