Parameter | Type | Required | Description | Valid Values |
---|
uuid
| string | Required | Universally Unique Identifier (ID) for the GIACT Policy. | |
createdBy
| string | Optional | User that originally created the GIACT Policy. | |
updatedBy
| string | Optional | The user that has most recently run and updated the GIACT Policy. | |
createdAt
| string | Optional | The time the GIACT Policy was originally made. | |
updatedAt
| string | Optional | The time the GIACT Policy was most recently run and updated. | |
status
| string | Required | Status of Merchant Boarding | INCOMPLETE
PENDING
DECLINED
MANUALVALIDATED
IN_PROGRESS
BOARDINGAPPROVED
PARTIALLY_BOARDED
BOARDED
|
state
| string | Required | Phase of Underwriting. | UNDERWRITING_PENDING
UNDERWRITING_MANUAL
UNDERWRITING_VALIDATED
|
ownership
| object | Required | Details about entity hierarchy. | |
| facilitatorId
| string | Required | The Payment Facilitator’s ID that facilitates the Merchant’s payment processing. | |
referrerId
| string | Required | The Referrer’s ID that boarded the Merchant to the Platform. | |
merchantId
| string | Required | The ID of the Merchant itself. | |
accounts
| array of objects | Required | Details for the bank account of the Merchant. | |
| accountType
| string | Required | The type of account the Merchant will be using for source funding and/or payout on the Platform. | Corporate checking account
Corporate savings account
Personal checking account
Personal savings account
|
description
| string | Optional | Optional description of the bank account being added. | |
method
| string | Required | The methods of payments available through this bank account. | all
credit
debit
|
name
| string | Optional | Optional custom name for the Bank Account. | |
number
| string | Required | The bank account number. | |
primary
| boolean | Required | Whether or not this is or will be the primary account for the Merchant on the Platform. | true
false
|
routing
| string | Required | The bank account routing number. | |
businessInfo
| object | Required | Information about the Merchant business itself. | |
| advancedBilling
| boolean | Optional | | true
false
|
businessDescription
| string | Required | A description of what the Merchant business does. | |
businessEnvironment
| string | Required | The environment where the Merchant’s payments are accepted. | cardPresent
e-commerce
fuel
moto
restaurant
serviceStation
supermarket
|
businessType
| string | Required | The formal business type as filed with the Merchant’s Secretary of State and the IRS. | Corporation
Government Organization
Limited Liability Company
Non-Profit Organization
Partnership
Sole Proprietor
|
displayName
| string | Optional | Optional name for the Merchant’s Business to display in the Portal. | |
doingBusinessAs
| string | Optional | Optional DBA for the Merchant to list any other names they may be “Doing Business As”. | |
donationsOverseas
| boolean | Optional | Whether or not the Merchant makes international charitable donations. | true
false
|
donationsPercentage
| number | Optional | What percentage of the Merchant’s income is donated. (To the nearest whole number) | |
ein
| string | Optional | The Entity Identification Number given to the Merchant by the IRS. | |
einType
| string | Optional | The type of [tax] Entity Identification Number. | ssn
tin
other
|
establishedAt
| string | Required | | |
haveEmployees
| boolean | Optional | Optionally include whether or not the Merchant has employees. | true
false
|
irsFilingName
| string | Optional | Optionally include the name that the Merchant used when filing for EIN number. | |
mcc
| string | Required | Merchant Commercial Code. | |
name
| string | Required | Include the Merchant’s Trade Name or Name their customers know them by. | |
newToCardProcessing
| boolean | Required | Optinoally include whether or not the Merchant is new to accepting card payments through their business. | true
false
|
payoutSecondaryDescriptor
| string | Optional | Optionally add more text to append a payout descriptor with unique information to help identify this particular Merchant’s payouts from others in your portfolio. | |
public
| boolean | Optional | Optionally include whether or not the Merchant is a publicly traded company. | true
false
|
seasonal
| boolean | Optional | Optionally include whether or not the Merchant is seasonal only. | true
false
|
website
| string | Optional | Optionally include the Merchant’s primary website. | |
channel
| string | Optional | | Direct
Partner
|
clientIp
| string | Optional | Optionally include the IP address of the Merchant. | |
communication
| object | Required | Merchant contact information. | |
| businessPhone
| string | Required | Merchant business phone number. | |
customerPhone
| string | Required | Merchant customer inquiries phone number. | |
email
| string | Required | Merchant email address. | |
fax
| string | Required | Merchant fax number. | |
currency
| string | Optional | 3 digit currency abbreviation. | AED
AFN
ALL
AMD
ANG
AOA
ARS
AUD
AWG
AZN
BAM
BBD
BDT
BGN
BHD
BIF
BMD
BND
BOB
BOV
BRL
BSD
BTN
BWP
BYN
BZD
CAD
CDF
CHE
CHF
CHW
CLF
CLP
CNY
COP
COU
CRC
CUC
CUP
CVE
CZK
DJF
DKK
DOP
DZD
EGP
ERN
ETB
EUR
FJD
FKP
GBP
GEL
GHS
GIP
GMD
GNF
GTQ
GYD
HKD
HNL
HRK
HTG
HUF
IDR
ILS
INR
IQD
IRR
ISK
JMD
JOD
JPY
KES
KGS
KHR
KMF
KPW
KRW
KWD
KYD
KZT
LAK
LBP
LKR
LRD
LSL
LYD
MAD
MDL
MGA
MKD
MMK
MNT
MOP
MRU
MUR
MVR
MWK
MXN
MXV
MYR
MZN
NAD
NGN
NIO
NOK
NPR
NZD
OMR
PAB
PEN
PGK
PHP
PKR
PLN
PYG
QAR
RON
RSD
RUB
RWF
SAR
SBD
SCR
SDG
SEK
SGD
SHP
SLL
SOS
SRD
SSP
STN
SVC
SYP
SZL
THB
TJS
TMT
TND
TOP
TRY
TTD
TWD
TZS
UAH
UGX
USD
USN
UYI
UYU
UZS
VEF
VND
VUV
WST
XAF
XAG
XAU
XBA
XBB
XBC
XBD
XCD
XDR
XOF
XPD
XPF
XPT
XSU
XUA
YER
ZAR
ZMW
ZWL
|
customInfo
| string | Required | Any Custom Information about the Merchant | |
location
| object | Required | Merchant Location Information. | |
| address1
| string | Required | Merchant Address Line 1 | |
address2
| string | Optional | Optional Address Line 2 | |
city
| string | Required | Merchant City | |
country
| string | Required | Merchant Country | CAN
USA
|
locationType
| string | Optional | Type of Location of Merchant Business. | Others
P. Res-Prof / Construction
Private Residence
Retail Storefront
Warehouse
|
zipCode
| string | Required | Merchant 5-Digit Postal Code | |
state
| string | Required | Merchant location, 2-character postal abbreviation for U.S. State or Canadian Province. | For U.S. (States): AK
AL
AR
AZ
CA
CT
CO
DC
DE
FL
GA
HI
ID
IL
IA
IN
KS
KY
LA
MS
MT
MA
MD
ME
MI
MN
MO
NC
ND
NE
NH
NJ
NM
NV
NY
OH
OK
OR
PA
RI
SD
SC
TN
TX
UT
VT
VA
WA
WI
WV
WY
For Canada (Provinces):
AB
BC
MB
NB
NL
NT
NS
NU
ON
PE
QC
SK
YT |
owners
| array of objects | Required | One or More Merchant Owner(s) Information. | |
| address1
| string | Required | Owner Residence Address Line 1. | |
address2
| string | Optional | Optional Owner Residence Address Line 2. | |
citizenship
| string | Optional | Optional Owner Country of Citizenship | ASM
ATA
ABW
AFG
AGO
AIA
ALA
ALB
AND
ARE
ARG
ARM
ATF
ATG
AUS
AUT
AZE
BDI
BEL
BEN
BES
BFA
BGD
BGR
BHR
BHS
BIH
BLM
BLR
BLZ
BMU
BOL
BRA
BRB
BRN
BTN
BVT
BWA
COM
CAF
CAN
CCK
CHE
CHL
CHN
CIV
CMR
COD
COG
COK
COL
CPV
CRI
CUB
CUW
CXR
CYM
CYP
CZE
DMA
DOM
DEU
DJI
DNK
DZA
ECU
EGY
ERI
ESH
ESP
EST
ETH
FSM
FIN
FJI
FLK
FRA
FRO
GAB
GBR
GEO
GGY
GHA
GIB
GIN
GLP
GMB
GNB
GNQ
GRC
GRD
GRL
GTM
GUF
GUM
GUY
HKG
HMD
HND
HRV
HTI
HUN
IRQ
ISR
IDN
IMN
IND
IOT
IRL
IRN
ISL
ITA
JAM
JEY
JOR
JPN
KAZ
KEN
KGZ
KHM
KIR
KNA
KOR
KWT
LAO
LBN
LBR
LBY
LCA
LIE
LKA
LSO
LTU
LUX
LVA
MAC
MDA
MNG
MAF
MAR
MCO
MDG
MDV
MEX
MHL
MKD
MLI
MLT
MMR
MNE
MNP
MOZ
MRT
MSR
MTQ
MUS
MWI
MYS
MYT
NIC
NPL
NAM
NCL
NER
NFK
NGA
NIU
NLD
NOR
NRU
NZL
OMN
PNG
PAK
PAN
PCN
PER
PHL
PLW
POL
PRI
PRK
PRT
PRY
PSE
PYF
QAT
REU
ROU
RUS
RWA
SDN
SPM
SSD
SAU
SEN
SGP
SGS
SHN
SJM
SLB
SLE
SLV
SMR
SOM
SRB
STP
SUR
SVK
SVN
SWE
SWZ
SXM
SYC
SYR
TLS
TCA
TCD
TGO
THA
TJK
TKL
TKM
TON
TTO
TUN
TUR
TUV
TWN
TZA
UGA
UKR
UMI
URY
USA
UZB
VAT
VCT
VEN
VGB
VIR
VNM
VUT
WLF
WSM
YEM
ZAF
ZMB
ZWE
|
city
| string | Required | Owner’s Residence City | |
country
| string | Required | Owner’s Residence Country | CAN
USA
|
dateOfBirth
| string | Required | Owner’s Date of Birth | |
driversLicense
| string | Optional | Owner’s Driver’s License ID Number | |
driversLicenseState
| string | Optional | Optionally Include Owner’s Driver’s License State or Province of Issuance. | For U.S. (States): AK
AL
AR
AZ
CA
CT
CO
DC
DE
FL
GA
HI
ID
IL
IA
IN
KS
KY
LA
MS
MT
MA
MD
ME
MI
MN
MO
NC
ND
NE
NH
NJ
NM
NV
NY
OH
OK
OR
PA
RI
SD
SC
TN
TX
UT
VT
VA
WA
WI
WV
WY
For Canada (Provinces):
AB
BC
MB
NB
NL
NT
NS
NU
ON
PE
QC
SK
YT |
email
| string | Required | Owner’s Email | |
fax
| string | Optional | Optionally Include Owner’s Fax Number | |
firstName
| string | Required | Owner’s First Name | |
id
| string | Optional | | |
lastName
| string | Required | Owner’s Last Name | |
middleName
| string | Optional | Optionally include Owner’s Middle Name (if applicable). | |
ownershipShare
| number | Required | Percentage of Merchant Business Ownership Controlled by This Owner. | |
phone
| string | Required | Owner’s Direct Phone Number | |
primary
| boolean | Required | Whether or not this is the Primary Owner (controlling the most Ownership Share). | True
False
|
significantResponsibility
| boolean | Required | Whether or not this Owner holds significant responsibility for Merchant Liabilities. | True
False
|
ssn
| string | Optional | Optionally include the SSN or SIN of the Owner. | |
termsAndConditions
| object | Required | Terms and Conditions Acknowledgment and Attestation for Platform usage and Compliance. | |
| acceptDate
| string | Required | The Date the Owner accepted the Terms and Conditions | |
attestation
| boolean | Required | Whether or not the Owner has accepted the Terms and Conditions of the Platform. | True
False
|
date
| string | Required | The Date of the Platform Terms and Conditions most recent version. | |
version
| string | Required | The Most Recent Uploaded Version of the Platform Terms and Conditions. | |
| title
| string | Required | The Owner’s Official Title within the Merchant’s Business. | |
zipCode
| string | Required | Postal Code of the Owner. | |
state
| string | Required | State or Provice of Owner’s Residence. | For U.S. (States): AK
AL
AR
AZ
CA
CT
CO
DC
DE
FL
GA
HI
ID
IL
IA
IN
KS
KY
LA
MS
MT
MA
MD
ME
MI
MN
MO
NC
ND
NE
NH
NJ
NM
NV
NY
OH
OK
OR
PA
RI
SD
SC
TN
TX
UT
VT
VA
WA
WI
WV
WY
For Canada (Provinces):
AB
BC
MB
NB
NL
NT
NS
NU
ON
PE
QC
SK
YT |
pciCompliance
| object | Optional | Optionally include PCI Compliance Information. | |
| pci
| boolean | Optional | Whether or not the Merchant is PCI Compliant. | True
False
|
qsa
| string | Optional | Name of Merchant’s PCI-certified Qualified Security Assessor (QSA) | |
saqDate
| string | Optional | Date the Merchant last performed the PCI DSS Self-Assessment Questionaire | |
saqType
| string | Optional | The SAQ Letter Rating provided from the last PCI DSS Self-Assessment Questionaire | SAQ-A
SAQ-A-EP
SAQ-B
SAQ-B-IP
SAQ-C-VT
SAQ-C
SAQ-P2PE-HW
SAQ-D
|
processingHistory
| object | Optional | Breakdown of Merchant Processing Types. | |
| amexVolume
| number | Optional | Total of Annual American Express Credit Card Transactions. | |
annualCCSales
| number | Optional | Total of Annual Credit Card Transactions. | |
annualHighestTransaction
| number | Optional | Highest Ticket (Dollar) Amount Transaction Anually. | |
avgTicket
| number | Optional | Average Transaction Ticket Size. | |
ndxDays
| number | Optional | | |
percentBusiness
| number | Optional | Percentage of Processing for Business Customers. | |
percentEcomm
| number | Optional | Percentage of Processing for eCommerce Customers. | |
percentEMVChip
| number | Optional | Percentage of Processing using EMV Chip Cards. | |
percentKeyed
| number | Optional | Percentage of Processing through manually keying Cards. | |
percentNdx
| number | Optional | | |
totalVolume
| number | Optional | Total Dollar Amount Volume Anually. | |
transactionsPerMonth
| number | Optional | Number of Transactions per Month. | |
signUpLink
| string | Optional | | |
sourceOfCall
| string | Optional | | |
options
| object | Optional | | |
| acquirerId
| string | Optional | Acquirer or ICA ID for MasterCard MATCH integration. | |