Onboarding Fields

The following table provides an overview of the mandatory and optional fields that are required for each call to the new Account Management API. You can find complete details about each field in the API section.

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.

Currently, only US region is supported. The fields for Canada and EU are left blank for now. They will be populated when the corresponding regions are supported.

The Onboarding Fields table is a large one. Navigating it could be a bit tricky. The horizontal scroll bar is at the bottom of the table.

Name Endpoint Field CA EU US Notes
Create Merchant /merchant/v1/applications name O
merchantRefNum M
OnboardingConfigId M
locale O
type O
acceptTermsAndConditions M
termsVersion M
addendum O

submit M
businessLegalEntity M 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.
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
amexMid O
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
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
The following fields are in the address (of businessLegalEntity) and tradeAddress (of businessDetails) object.
street M
street2 O
city M
state M
country M
zip M
The following fields are in the phoneNumber object.
countryCode C Required if phoneNumber is provided
number C Required if phoneNumber is provided
The following fields are in the accounts object.
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
The following fields are in the statementDescriptor object present in accounts object.
descriptor M
phone M
The following fields are in the processingOptions object. This information is required only for Gateway merchants.
cardType NA
mid NA
tids NA
The following fields are in the users Object.
email M
fullName O

loginName M
password M

The following fields are in the achBankAccount object.
accountNumber M
routingNumber M
The following fields are in the bacsBankAccount object.
accountNumber NA
beneficiaryAccountName NA
beneficiaryBankCountry NA
sortCode NA
The following fields are in the sepaBankAccount object.
beneficiaryAccountName NA
beneficiaryBankCountry NA
swiftNumber NA
ibanNumber NA
The following fields are in the wireBankAccount object.
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
The following fields are in the eftBankAccount object.
accountNumber NA
transitNumber NA
institutionId NA
paymentToken
The following fields are in the principals object.
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
The following fields are in the dateOfBirth object.
day C Required if dateOfBirth is provided
month C Required if dateOfBirth is provided
year C Required if dateOfBirth is provided
The following fields are in the contacts object.
type O
title O
firstName M
lastName O
middleName O
phoneNumber O
email O
Get Application /merchant/v1/applications/{appId} No fields required
Get Terms & Conditions /merchant/v1/applications/{appId}/termsandconditions No fields required
Submit Application /merchant/v1/applications/{appId} acceptTermsAndConditions M
submit M
Update Application /merchant/v1/applications/{appId} NA Same fields present in create application API (/merchant/v1/applications)
Did you find this page useful?