Search Overlay

Onboarding Fields

The following tables provide an overview of the mandatory and optional fields that are required for each call to the Applications API. You can find complete details about each field in the API reference.

Required fields are indicated by region in the CA, EU, and US columns, using the following key:

  • M = Mandatory
  • O = Optional
  • C = Conditional – Field is required only if another optional field is included which would require this field to be specified.

At the moment, only the US region is supported. The fields in the table for Canada and the EU are left blank. These regions will be populated when they are supported.

Create Merchant fields

POST /merchant/v1/applications

Field CA EU US Notes
name     O  
merchantRefNum     M  
OnboardingConfigId     M  
locale     O  
type     O  
acceptTermsAndConditions     M  
termsVersion     M  
addendum     O

 

submit     M  
businessLegalEntity     M  

businessLegalEntity object

The following fields are in the businessLegalEntity object. businessLegalEntity is a required field. If the type is ADDITIONAL_LOCATION or ADDITIONAL_ACCOUNT, only id is required and all other fields are ignored.

Field CA EU US Notes
id     C Required when type is ADDITIONAL_LOCATION or ADDITIONAL_ACCOUNT
type     M  
legalName     M  
registrationNumber     O  
taxIdentificationNumber     M  
description     O  
users     O  
achBankAccount     O  
bacsBankAccount     O

 

sepaBankAccount     O  
wireBankAccount     O  
eftBankAccount     O  
address     M  
businessDetails     M  
principals     M  

userIds

    O  

businessDetails object

The following fields are in the businessDetails object. If the type is ADDITIONAL_ACCOUNT, then only id is required and all other fields are ignored.

Field CA EU US Notes
averageTransactionAmount O O O Although averageTransactionAmount is optional when you create the merchant account, you must update the merchant account to add this element at some later point the merchant account can be activated.
yearlyVolumeRange O O O Although yearlyVolumeRange is optional when you create the merchant account, you must update the merchant account to add this element at some later point the merchant account can be activated.
refundPolicy O O O  
refundPolicyDescription C C C If refundPolicy is true then refundPolicyDescription is mandatory.
id     C Required if the type is ADDITIONAL_ACCOUNT
tradeName     O  
tradeAddress     O  
category     M  
mcc     O  
website     O  
phoneNumber     M  
email     O  
users     O  
achBankAccount     O  
bacsBankAccount     O  
sepaBankAccount     O  
wireBankAccount     O  
eftBankAccount     O  
accounts     O  
contacts     O  
userIds     O  

address and tradeAddress objects

The following fields are in the address (of businessLegalEntity) and tradeAddress (of businessDetails) objects:

Field CA EU US Notes
street     M  
street2     O  
city     M  
state     M  
country     M  
zip     M  

phoneNumber object

The following fields are in the phoneNumber object:

Field CA EU US Notes
countryCode     C Required if phoneNumber is provided
number     C Required if phoneNumber is provided

accounts object

The following fields are in the accounts object:

Field CA EU US Notes
type     O  
paymentType     M  
currency     M  
settlementCurrency     M  
statementDescriptor     M  
terminalType     O  
cardTypes     O  
processingOptions     O  
users     O  
achBankAccount     O  
bacsBankAccount     O  
sepaBankAccount     O  
wireBankAccount     O  
eftBankAccount     O  
userIds     O  

statementDescriptor object

The following fields are in the statementDescriptor object present in accounts object.

Field CA EU US Notes
descriptor     M  
phone     M  

processingOptions object

The following fields are in the processingOptions object. This information is required only for Gateway merchants.

Field CA EU US Notes
cardType     NA  
mid     NA  
tids     NA  

users object

The following fields are in the users Object:

Field CA EU US Notes
email     M  
fullName     O

 

loginName     M  
password     M

 

achBankAccount object

The following fields are in the achBankAccount object:

Field CA EU US Notes
accountNumber     M  
routingNumber     M  

bacsBankAccount object

The following fields are in the bacsBankAccount object:

Field CA EU US Notes
accountNumber     NA  
beneficiaryAccountName     NA  
beneficiaryBankCountry     NA  
sortCode     NA  

sepaBankAccount object

The following fields are in the sepaBankAccount object:

Field CA EU US Notes
beneficiaryAccountName     NA  
beneficiaryBankCountry     NA  
swiftNumber     NA  
ibanNumber     NA  

wireBankAccount object

The following fields are in the wireBankAccount object:

Field CA EU US Notes
accountNumber     NA  
routingNumber     NA  
sortCode     NA

 

swiftNumber     NA  
ibanNumber     NA  
beneficiaryAccountName     NA  
beneficiaryCountry     NA  
beneficiaryAddress     NA  
beneficiaryCity     NA  
beneficiaryRegion     NA  
beneficiaryPostCode     NA  
beneficiaryBankName     NA  
beneficiaryBankAddress     NA  
beneficiaryBankCountry     NA  
beneficiaryBankCity     NA  
beneficiaryBankRegion     NA  
beneficiaryBankPostCode     NA  

eftBankAccount object

The following fields are in the eftBankAccount object:

Field CA EU US Notes
accountNumber     NA  
transitNumber     NA  
institutionId     NA  
paymentToken        

principals object

The following fields are in the principals object:

Field CA EU US Notes
isApplicant     O  
isControlProng     O  
isDirector     O  
title     O  
firstName     M  
lastName     M  
middleName     O  
previousLastName     O  
dateOfBirth     M  
ssn     C If the ssn is provided then it should be nine digits and numeric. Note: The SSN parameter is not required when the type parameter in the usAccountDetails object is set to NPCORP, CHARITY or GOV. This object is included when you create a merchant account.
sin     O  
nationality     O  
positionInCompany     O  
type     O  
percentageShareholding     O  
address     M  

dateOfBirth object

The following fields are in the dateOfBirth object:

Field CA EU US Notes
day     C Required if dateOfBirth is provided
month     C Required if dateOfBirth is provided
year     C Required if dateOfBirth is provided

contacts object

The following fields are in the contacts object:

Field CA EU US Notes
type     O  
title     O  
firstName     M  
lastName     O  
middleName     O  
phoneNumber     O  
email     O  

Get Application fields

GET /merchant/v1/applications/{appId}

No fields required.

Get Terms & Conditions fields

GET /merchant/v1/applications/{appId}/termsandconditions

No fields required.

Submit Application fields

PATCH /merchant/v1/applications/{appId}

Field CA EU US Notes
acceptTermsAndConditions     M  
submit     M  

Update Application fields

PUT /merchant/v1/applications/{appId}

Name Endpoint Field CA EU US Notes
Update Application /merchant/v1/applications/{appId}       NA Same fields present in create application API (/merchant/v1/applications)