Boarding API - API Document
API Name |
Name of the API. Click on the hyperlink to know about the endpoint URL and details about the API |
Description |
Tells about the purpose of the API |
Sample Data |
Get the list of API request and response parameters and parameter type (Mandatory/Optional/Conditional) |
API Type |
Tells about if the API is mandatory/optional/conditional. Click on why? Link to know more |
Sample Log |
Sample JSON string for request and response |
Error Codes |
Click on "View" link to get the list of error codes for the corresponding API |
API Name | Description | Sample Data | API Type | Sample Log | Error Codes |
---|---|---|---|---|---|
This API validates the external partner with the unique credentials shared with each of partner. This API respond back with a session token & expiry time for the session token. This token is required in header of each subsequent API triggered by partner. • Partner need to initiate a Login request to fetch session token before submitting any API to Fiserv Boarding platform. • Each session token is active for a specific amount of time as provided in ttl (time to live) field in response. • If partner tries to use the token beyond the expiry, Fiserv boarding platform will respond back with an error response. • Partner need to initiate another login request to fetch fresh token to submit any of the Boarding APIs. |
Mandatory |
||||
"This API creates a unique reference number (URN) for each new application that is onboarded onto Fiserv platform. Partner needs to use this unique value for all subsequent API requests where URN is a mandatory request parameter. Partner needs to create a URN for application before submitting any application request to Fiserv Boarding Platform" |
Mandatory |
||||
"There are two separate APIs to fetch Package Details Get Package List: This API responds back with an array of packages and its corresponding parameters based on the filtration criteria provided in the request API. This is an optional API which partner can use in a scenario wherein multiple packages are assigned to partner." Get Individual Package: Partner can use this API to fetch the package details of an individual package by passing the package id in request parameter |
|
Optional |
|||
Use this API to fetch the Document Matrix basis certain criteria sent in request message. The response will contain the possible set of documents which the Partner can provide as part of Funding proof, Partner POI, Partner POA, Other categories, etc This API is applicable for partners who would be submitting merchant documents to Fiserv for Partner Credit Underwriting process. This API has to be used to fetch the document matrix and use subsequent Upload Document API. |
|
Conditional: Only for partner who need underwriting by Fiserv |
|||
Use this API to upload documents for merchants. Application URN generated, as part of Create URN API has to be used in request API to tag the documents to a particular Application URN. Response of this API will give unique document ids for each document which has to be provided in subsequent application APIs This API would follow the Get Document matrix API and has to be submitted before Application Submit API. |
Conditional: Applicable if get document matrix API is invoked |
||||
Partner can use this API to fetch the details of existing MID which they would have boarded in past. This API would predominantly be used while boarding Additional Trading Location or Additional Device on an existing MID. Partner can use this API before submitting Additional Trading Location or Additional Device Application request. |
|
Optional |
|||
This API is used to submit the application details of a new merchant. Partner has to trigger this API post Create URN API. Below APIs can be optionally used to contribute to the data to be submitted as part of New Partner Application Submit API. • Get Packages • Get Document Matrix • Upload Document |
Optional |
||||
This API is used to submit the application details for additional trading location for an existing merchant. Payment Facilitators will use this API to board their sub-merchants under Payment Facilitator master MID created on Fiserv Platform Partner has to trigger this API post Create URN API. Below APIs can be optionally used to contribute to the data required to be submitted as part of Additional trading location application Submit API. • Get Packages • Get Document Matrix • Upload Document • MID Inquiry |
Mandatory |
||||
This API is used to submit the application details for additional device for an existing merchant. This is a common API for Additional Device for ISOs, ISVs & Payment Facilitators Partner has to trigger this API post Create URN API. Below APIs can be optionally used to contribute to data for required to be submitted as part of Additional device application Submit API. • Get Packages • MID Inquiry |
Mandatory |
||||
This API can be used to fetch the latest status of any application by giving the Application URN in request Message. This API has to be used post submit of a particular application. |
|
Optional |
Download
Digital Onboarding API | |
---|---|
Digital Onboarding APIs Document | Integration Pack Please Sign In to download |
Status Code | Message |
---|---|
200 | Ok |
400 | Generic Error |
401 | Unauthorized |
403 | Forbidden |
404 | Not Found |
UAT URL: https://www.uat.fdmerchantservices.com//Externalboarding/partner/login?
PROD URL: https://www.firstdatamerchantservices.com//Externalboarding/partner/login?
Query Parameters: ain=4700000&source=TAB
Header : Basic Authentication e.g. For a user Name 'TestABC' and Password 'Test1234' Basic authentication header value will be
Request Type: GET
UAT URL : https://www.uat.fdmerchantservices.com/Externalboarding/secure/create
PROD URL : https://www.firstdatamerchantservices.com/Externalboarding/secure/create
Request Type : POST
Field Name < Description > | M/O/C | Data Type | Length | Remarks |
---|---|---|---|---|
|
M | Alphanumeric | 8 | Fixed Value 'API' |
|
M | Alphanumeric | 70 | User Credential created for each partner |
|
- | |||
|
M | Alphanumeric | 20 | |
|
- | |||
|
M | Alphanumeric | 22 | |
|
M | Alphanumeric | 35 |
UAT URL : https://www.uat.fdmerchantservices.com/Externalboarding/secure/packages?
PROD URL : https://www.firstdatamerchantservices.com/Externalboarding/secure/packages?
Query Parameters:
Request Type : GET
Field Name < Description > | M/O/C | Data Type | Length | Remarks |
---|
UAT URL : https://www.uat.fdmerchantservices.com/Externalboarding/secure/document?
PROD URL : https://www.firstdatamerchantservices.com/Externalboarding/secure/document?
Query Parameters:
Request Type : GET
Field Name < Description > | M/O/C | Data Type | Length | Remarks |
---|
UAT URL : https://www.uat.fdmerchantservices.com/Externalboarding/secure/document/1000005126
PROD URL : https://www.firstdatamerchantservices.com/Externalboarding/secure/document/
Request Type : POST
Request Body : Multipart Request
Field Name < Description > | Form Data Type | M/O/C | Data Type | Length | Remarks |
---|---|---|---|---|---|
Request | |||||
appUrn | text | M | Alphanumeric | 8 | |
docType | text | Alphanumeric | 30 | Document Name of document being uploaded. This can be refered from tag documentName in Get Document Matrix API | |
fileType | text | M | Alphanumeric | 10 | |
principalNo | text | M | Numeric | 2 | "If there are 2 Principal Owners for
which the documents are uploaded, first set will have value as 1 and
the second set will have value as 2. If there are multiple set of UBO for which documents are uploaded, each set will have its respective number in sequential manner." |
file1 | file | M | Bytes of Multipart Request | - | Front copy of the document. If document has single part, same has to be uploaded as part of file1. |
file2 | file | O | Bytes of Multipart Request | - | Back copy of the document. If document has single part, file2 remains blank. |
categoryName | text | M | Alphanumeric | 30 | Category of document being uploaded. This can be refered from tag categoryName in Get Document Matrix API |
level | text | M | Numeric | 2 | Level of document being uploaded. This can be refered from tag level in Get Document Matrix API |
UAT URL : https://www.uat.fdmerchantservices.com/Externalboarding/secure/refmid/ADDLMID/99000154
PROD URL : https://www.firstdatamerchantservices.com/Externalboarding/secure/refmid/ADDLMID/
Request Type : GET
Field Name < Description > | M/O/C | Data Type | Length | Remarks |
---|
UAT URL : https://www.uat.fdmerchantservices.com/Externalboarding/secure/newmid
PROD URL : https://www.firstdatamerchantservices.com/Externalboarding/secure/newmid
Request Type : POST
Field Name | M/O/C | Data Type | Length | Remarks |
---|---|---|---|---|
appURN | M | Alphanumeric | 30 | App URN retured as part of Create URN API |
appType | M | Alphanumeric | 8 | Fixed Value 'API' |
salesId | M | Alphanumeric | 70 | User Credential created for each partner |
channelCode | C | Alphanumeric | 10 | Static Channel Code shared with each partner |
osvFlagValue | O | Alphanumeric | 1 | Original Seen & Verified flag. Applicable for entities where documents are uploaded. For entities not uploading documents, keep this field as blank. |
merchantDetails | - | - | ||
businessName | M | Alphanumeric | 22 | |
legalName | M | Alphanumeric | 35 | |
businessType | M | Alphanumeric | 50 | |
registrationNo | M | Alphanumeric | 100 | |
taxDetails | - | - | ||
taxidType | M | Alphanumeric | 50 | "Tax ID Type provided for the merchant. For India - PAN For AU - ABN " |
taxidValue | M | Alphanumeric | 100 | "Tax ID Type provided for the merchant. For India: Individual PAN for Individual/Soleprop merchants Corporate PAN for other type pf merchants For AU: ABN Value" |
dateIncorporated | M | Numeric | 8 | YYYYMMDD |
websiteURL | C | Alphanumeric | 100 | |
communicationEmail | M | Alphanumeric | 60 | |
merchantType | M | Alphanumeric | 20 | |
acceptanceType | M | Alphanumeric | 10 | POS/ECOM/FDMOBILE |
iciciMerchant | M | Alphanumeric | 20 | |
newFundingAc | M | Alphanumeric | 20 | |
legalAddress | - | - | ||
addressLine | M | Alphanumeric | 35 | |
addressLine2 | O | Alphanumeric | 35 | |
addressLine3 | O | Alphanumeric | 35 | |
city | M | Alphanumeric | 25 | |
state | M | Alphanumeric | 25 | |
pincode | M | Alphanumeric | 8 | |
country | M | Alphanumeric | 25 | |
mobileNo | M | Numeric | 15 | |
phone1 | O | Numeric | 15 | |
O | Numeric | 30 | ||
contactName | M | Alphanumeric | 35 | |
gstNo | C | Alphanumeric | 100 | Mandatory for Large merchants |
gstMerchantStateCode | O | Alphanumeric | 40 | Mandatory for Large Partners |
isdnFlag | C | Alphanumeric | 20 | "ID Doc Details section is a conditional tag and has to be mandatorily present if the user is uploding documents for a particular application. All documents uploaded under ""categoryInd"": ""E"" has to be included under merchantDetails.idDocDetails" |
entity | C | Alphanumeric | Static Value - 'Member' | |
idType | C | Alphanumeric | Value of docType received as response of uploaded document | |
idValue | C | Alphanumeric | ||
docId | C | Alphanumeric | Value of docID received as response of uploaded document | |
categoryName | C | Alphanumeric | Value of categoryName received as response of uploaded document | |
level | C | Numeric | Value of level received as response of uploaded document | |
mandatory | C | Alphanumeric | ||
entity | C | Static Value - 'Member' | ||
idType | C | Value of docType received as response of uploaded document | ||
idValue | C | |||
docId | C | Value of docID received as response of uploaded document | ||
categoryName | C | Value of categoryName received as response of uploaded document | ||
level | C | Value of level received as response of uploaded document | ||
mandatory | C | |||
geoLocation | - | - | ||
latitude | O | Numeric | 20 | |
longitude | O | Numeric | 20 | |
tradingLocations | M | - | "This section contains the trading
location details of merchants that is being onboarded. A maximum
upto 3 trading locations can be added under a single
Application. The entire trading location section needs to be repeated for multiple trading locations." |
|
locationNo | M | Numeric | 2 | |
tradingName | M | Alphanumeric | 22 | |
tradingAddress | M | - | ||
addressLine | M | Alphanumeric | 35 | |
addressLine2 | O | Alphanumeric | 35 | |
addressLine3 | O | Alphanumeric | 35 | |
city | M | Alphanumeric | 25 | |
state | M | Alphanumeric | 25 | |
pincode | M | Alphanumeric | 8 | |
country | M | Alphanumeric | 25 | |
mobileNo | M | Numeric | 15 | |
phone1 | O | Numeric | 15 | |
O | Numeric | 30 | ||
contactName | M | Alphanumeric | 35 | |
packageId | M | Numeric | 10 | |
autoSettlementTime | O | Numeric | 6 | HHMMSS |
cpvGroupId | O | Alphanumeric | 50 | |
regionalcpvGroupid | O | Alphanumeric | 50 | |
commerceConnectReferenceMID | O | Alphanumeric | 8 | |
terminals | - | - | ||
count | M | Numeric | 2 | |
preferedDate | M | Numeric | 8 | YYYYMMDD |
preferedTime | M | Numeric | 6 | HHMMSS |
discount | O | Numeric | 3 | |
userInstruction1 | O | Alphanumeric | 100 | |
userInstruction2 | O | Alphanumeric | 100 | |
surchargeAmount | - | - | Surcharge values currently selected by Partner on MVSI in AU | |
visaBase | C | Numeric | 11 | For AU Only |
visaPercent | C | Numeric | 11 | For AU Only |
mcBase | C | Numeric | 11 | For AU Only |
mcPercent | C | Numeric | 11 | For AU Only |
upiBase | C | Numeric | 11 | For AU Only |
upiPercent | C | Numeric | 11 | For AU Only |
eftposBase | C | Numeric | 11 | For AU Only |
eftposPercent | C | Numeric | 11 | For AU Only |
amexBase | C | Numeric | 11 | For AU Only |
amexPercent | C | Numeric | 11 | For AU Only |
jcbBase | C | Numeric | 11 | For AU Only |
jcbPercent | C | Numeric | 11 | For AU Only |
dinersBase | C | Numeric | 11 | For AU Only |
dinersPercent | C | Numeric | 11 | For AU Only |
altmerchCode | O | Alphanumeric | 20 | This is an optional field which has to be populated only if there is merchant MID or Dealer Code has to be captured at MID Level |
sameLocation | C | Alphanumeric | 1 | This flag has to be set to 'Y' if Partner wants multiple MIDs at the same location |
mid | C | Numeric | 15 | This is the reference Member MID which needs to be given in case of ADD MID/ ADD TID. |
parentmid | C | Numeric | 15 | This is the SG (parent MID) of the reference MID which needs to be given in case of ADD MID & ADD TID |
otpEnabled | O | Alphanumeric | 10 | |
principalDetails | - | - | This section is used to capture details of Principal Owner for the said merchant. The same section can be repeated for multiple Principal Owners. We can have upto maximum of 2 Principal Owners per merchant. | |
principalNo | M | Alphanumeric | 2 | |
position | M | Alphanumeric | 20 | |
title | M | Alphanumeric | 20 | |
firstName | M | Alphanumeric | 25 | |
lastName | M | Alphanumeric | 25 | |
middleName | O | Alphanumeric | 25 | |
gender | M | Alphanumeric | 10 | |
dateOfBirth | M | Numeric | 8 | YYYYMMDD |
kycDetails | - | - | ||
kycCategory | ||||
identityType | M | Alphanumeric | 50 | "Type of KYC Document submitted. For India - PAN/AADHAR For ASEAN - Passport/Driving Licence/HKID or SGID or MYID For AU - Passport/Driving Licence" |
identityValue | M | Alphanumeric | 100 | Value of the Kyc Document submitted |
identitymetaName1 | C | Alphanumeric | 100 | "Additional information pertaning to the KYC docuements submitted. For AU - Driving License State Code" |
identitymetaValue1 | C | Alphanumeric | 100 | "Additional information pertaning to the KYC docuements submitted. For AU - Value Driving License State Code" |
nationality | M | Alphanumeric | 35 | |
principalAddress | - | - | ||
addressLine | M | Alphanumeric | 35 | |
addressLine2 | O | Alphanumeric | 35 | |
addressLine3 | O | Alphanumeric | 35 | |
city | M | Alphanumeric | 25 | |
state | M | Alphanumeric | 25 | |
pincode | M | Alphanumeric | 8 | |
country | M | Alphanumeric | 25 | |
mobileNo | M | Numeric | 15 | |
phone1 | O | Numeric | 15 | |
contactName | M | Alphanumeric | 35 | |
idDocDetails | C | - | "ID Doc Details section is a
conditional tag and has to be mandatorily present if the user is
uploding documents for a particular application. All documents uploaded under ""categoryInd"": ""P"" has to be included under principalDetails.idDocDetails" |
|
entity | Static Value - 'Member' | |||
idType | Value of docType received as response of uploaded document | |||
idValue | ||||
docId | Value of docID received as response of uploaded document | |||
categoryName | Value of categoryName received as response of uploaded document | |||
level | Value of level received as response of uploaded document | |||
mandatory | ||||
entity | Static Value - 'Member' | |||
idType | Value of docType received as response of uploaded document | |||
idValue | ||||
docId | Value of docID received as response of uploaded document | |||
categoryName | Value of categoryName received as response of uploaded document | |||
level | Value of level received as response of uploaded document | |||
mandatory | ||||
uboDetails | - | - | This section is used to capture details of Ultimate Benefeciary Owner for the said merchant. The same section can be repeated for multiple UBOs. We can have upto maximum of 5 UBOs per merchant. | |
serialNo | C | Numeric | 2 | |
title | C | Alphanumeric | 20 | |
firstName | C | Alphanumeric | 25 | |
lastName | C | Alphanumeric | 25 | |
middleName | O | Alphanumeric | 25 | |
dateOfBirth | C | Numeric | 10 | Format - YYYYMMDD |
shareholderPercentage | C | Numeric | 8 | |
nationality | C | Alphanumeric | 35 | |
kycDetails | C | - | ||
kycCategory | ||||
identityType | C | Alphanumeric | 50 | "Type of KYC Document submitted for
UBO. For India - PAN/AADHAR For ASEAN - Passport/Driving Licence/HKID or SGID or MYID For AU - Passport/Driving Licence" |
identityValue | C | Alphanumeric | 100 | Value of the Kyc Document submitted |
identitymetaName1 | C | Alphanumeric | 100 | "Additional information pertaning to
the KYC docuements submitted for UBO. For AU - Driving License State Code" |
identitymetaValue1 | C | Alphanumeric | 100 | "Additional information pertaning to
the KYC docuements submitted. For AU - Value Driving License State Code" |
uboAddress | - | - | ||
addressLine | C | Alphanumeric | 35 | |
addressLine2 | O | Alphanumeric | 35 | |
addressLine3 | O | Alphanumeric | 35 | |
city | C | Alphanumeric | 25 | |
state | C | Alphanumeric | 25 | |
pincode | C | Alphanumeric | 8 | |
country | C | Alphanumeric | 25 | |
mobileNo | C | Numeric | 15 | |
phone1 | O | Numeric | 15 | |
contactName | C | Alphanumeric | 35 | |
bankDetails | - | - | This tag will contain the Bank account details of Partner/PayFac which needs to be configured at Fiserv End | |
uwaccountdetails | M | - | UW Account details are primarily the actual merchant account which will be used while underwriting the merchant | |
accountNo | M | Numeric | 100 | |
accountName | M | Alphanumeric | 35 | |
ifsc | M | Alphanumeric | 15 | |
bankName | M | Alphanumeric | 80 | |
currency | M | Alphanumeric | 3 | |
branch | O | Alphanumeric | 500 | |
bankAddress | M | Alphanumeric | 500 | |
accType | M | Alphanumeric | 30 | |
fundingaccountdetails | C | - | "Funding account will the details of
account to which Fiserv will process the funding on daily
basis. For PayFacs, this will be the PayFac account. For Normal Partners, UW Account & Funding account both will be the same" |
|
accountNo | C | Numeric | 100 | If different form UW details |
accountName | C | Alphanumeric | 35 | |
ifsc | C | Alphanumeric | 15 | |
bankName | C | Alphanumeric | 80 | |
currency | C | Alphanumeric | 3 | |
branch | O | Alphanumeric | 500 | |
bankAddress | C | Alphanumeric | 500 | |
accType | C | Alphanumeric | 30 | |
collectionaccountdetails | C | - | "This section will have details of account which needs to be used for collection of charges. This account may or may not be the same as UW account/Funding account." | |
accountNo | C | Numeric | 100 | If different form UW details |
accountName | C | Alphanumeric | 35 | |
ifsc | C | Alphanumeric | 15 | |
bankName | C | Alphanumeric | 80 | |
currency | C | Alphanumeric | 3 | |
branch | O | Alphanumeric | 500 | |
bankAddress | C | Alphanumeric | 500 | |
accType | C | Alphanumeric | 30 | |
submerchantDetails | - | - | This section is used to capture the sub Partner Details of the merchant | |
submerchantID | C | Numeric | 15 | "This is an optional field which the
Single MID PayFacs can use to pass their own MID to Fiserv. This field will be mandatory if the Channel level parameter for Payfac Provided SMID is set to Y. If the same is set to 'N', Boarding backend will generate its own MID for the merchant" |
businessSummary | - | - | This section is used to capture the summary of the merchant | |
briefSummary | M | Alphanumeric | 100 | |
salessrNumber | O | Alphanumeric | 100 | |
mccCode | M | Numeric | 20 | |
mccDescription | M | Alphanumeric | 200 | |
totalTurnover | M | Numeric | 20 | |
totalTurnoverPerMID | M | Numeric | 20 | |
cardTurnover | M | Numeric | 20 | |
avgTicketAmt | M | Numeric | 20 | |
dccTurnoverPerMID | M | Numeric | 20 | |
pgTurnover | M | Numeric | 20 | |
pgTurnoverPerMID | M | Numeric | 20 | |
avgEMITicketAmt | O | Numeric | 20 | |
tranVolumeInternet | M | Numeric | 20 | |
tranVolumeMoto | M | Numeric | 20 | |
tranVolumeinStore | M | Numeric | 20 | |
deliveryDays0 | M | Numeric | 20 | |
deliveryDays7 | M | Numeric | 20 | |
deliveryDays14 | M | Numeric | 20 | |
deliveryDays30 | M | Numeric | 20 | |
deliveryDaysOver30 | M | Numeric | 20 | |
tranTypeMagStrip | M | Numeric | 20 | |
tranTypeChip | M | Numeric | 20 | |
tranTypeKeyed | M | Numeric | 20 | |
creditSalesConsumer | M | Numeric | 20 | |
creditSalesBusiness | M | Numeric | 20 | |
firsReport | O | Alphanumeric | 20 | |
recurringTranFlag | O | Alphanumeric | 20 | |
refundPolicy | O | Alphanumeric | 20 | |
cardRefundDays | O | Alphanumeric | 20 | |
thirdPartyProcessorFlag | O | Alphanumeric | 20 | |
thirdPartyProcessorName | O | Alphanumeric | 40 |
UAT URL : https://www.uat.fdmerchantservices.com/Externalboarding/secure/addmid
PROD URL : https://www.firstdatamerchantservices.com/Externalboarding/secure/addmid
Request Type : POST
Field Name | M/O/C | Data Type | Length | Remarks |
---|---|---|---|---|
appURN | M | Alphanumeric | 30 | App URN retured as part of Create URN API |
appType | M | Alphanumeric | 8 | Fixed Value 'API' |
salesId | M | Alphanumeric | 70 | User Credential created for each partner |
channelCode | C | Alphanumeric | 10 | Static Channel Code shared with each partner |
osvFlagValue | O | Alphanumeric | 1 | Original Seen & Verified flag. Applicable for entities where documents are uploaded. For entities not uploading documents, keep this field as blank. |
merchantDetails | - | - | ||
businessName | M | Alphanumeric | 22 | |
legalName | M | Alphanumeric | 35 | |
businessType | M | Alphanumeric | 50 | |
registrationNo | M | Alphanumeric | 100 | |
taxDetails | - | - | ||
taxidType | M | Alphanumeric | 50 | "Tax ID Type provided for the merchant. For India - PAN For AU - ABN " |
taxidValue | M | Alphanumeric | 100 | "Tax ID Type provided for the merchant. For India: Individual PAN for Individual/Soleprop merchants Corporate PAN for other type pf merchants For AU: ABN Value" |
dateIncorporated | M | Numeric | 8 | YYYYMMDD |
websiteURL | C | Alphanumeric | 100 | |
communicationEmail | M | Alphanumeric | 60 | |
merchantType | M | Alphanumeric | 20 | |
acceptanceType | M | Alphanumeric | 10 | POS/ECOM/FDMOBILE |
iciciMerchant | M | Alphanumeric | 20 | |
newFundingAc | M | Alphanumeric | 20 | |
legalAddress | - | - | ||
addressLine | M | Alphanumeric | 35 | |
addressLine2 | O | Alphanumeric | 35 | |
addressLine3 | O | Alphanumeric | 35 | |
city | M | Alphanumeric | 25 | |
state | M | Alphanumeric | 25 | |
pincode | M | Alphanumeric | 8 | |
country | M | Alphanumeric | 25 | |
mobileNo | M | Numeric | 15 | |
phone1 | O | Numeric | 15 | |
O | Numeric | 30 | ||
contactName | M | Alphanumeric | 35 | |
gstNo | C | Alphanumeric | 100 | Mandatory for Large merchants |
gstMerchantStateCode | O | Alphanumeric | 40 | Mandatory for Large Merchants |
isdnFlag | C | Alphanumeric | 20 | "ID Doc Details section is a conditional tag and has to be mandatorily present if the user is uploding documents for a particular application. All documents uploaded under ""categoryInd"": ""E"" has to be included under merchantDetails.idDocDetails" |
entity | C | Alphanumeric | Static Value - 'Member' | |
idType | C | Alphanumeric | Value of docType received as response of uploaded document | |
idValue | C | Alphanumeric | ||
docId | C | Alphanumeric | Value of docID received as response of uploaded document | |
categoryName | C | Alphanumeric | Value of categoryName received as response of uploaded document | |
level | C | Numeric | Value of level received as response of uploaded document | |
mandatory | C | Alphanumeric | ||
entity | C | Static Value - 'Member' | ||
idType | C | Value of docType received as response of uploaded document | ||
idValue | C | |||
docId | C | Value of docID received as response of uploaded document | ||
categoryName | C | Value of categoryName received as response of uploaded document | ||
level | C | Value of level received as response of uploaded document | ||
mandatory | C | |||
geoLocation | - | - | ||
latitude | O | Numeric | 20 | |
longitude | O | Numeric | 20 | |
tradingLocations | M | - | "This section contains the trading
location details of merchants that is being onboarded. A maximum
upto 3 trading locations can be added under a single
Application. The entire trading location section needs to be repeated for multiple trading locations." |
|
locationNo | M | Numeric | 2 | |
tradingName | M | Alphanumeric | 22 | |
tradingAddress | M | - | ||
addressLine | M | Alphanumeric | 35 | |
addressLine2 | O | Alphanumeric | 35 | |
addressLine3 | O | Alphanumeric | 35 | |
city | M | Alphanumeric | 25 | |
state | M | Alphanumeric | 25 | |
pincode | M | Alphanumeric | 8 | |
country | M | Alphanumeric | 25 | |
mobileNo | M | Numeric | 15 | |
phone1 | O | Numeric | 15 | |
O | Numeric | 30 | ||
contactName | M | Alphanumeric | 35 | |
packageId | M | Numeric | 10 | |
autoSettlementTime | O | Numeric | 6 | HHMMSS |
cpvGroupId | O | Alphanumeric | 50 | |
regionalcpvGroupid | O | Alphanumeric | 50 | |
commerceConnectReferenceMID | O | Alphanumeric | 8 | |
terminals | - | - | ||
count | M | Numeric | 2 | |
preferedDate | M | Numeric | 8 | YYYYMMDD |
preferedTime | M | Numeric | 6 | HHMMSS |
discount | O | Numeric | 3 | |
userInstruction1 | O | Alphanumeric | 100 | |
userInstruction2 | O | Alphanumeric | 100 | |
surchargeAmount | - | - | Surcharge values currently selected by Merchant on MVSI in AU | |
visaBase | C | Numeric | 11 | For AU Only |
visaPercent | C | Numeric | 11 | For AU Only |
mcBase | C | Numeric | 11 | For AU Only |
mcPercent | C | Numeric | 11 | For AU Only |
upiBase | C | Numeric | 11 | For AU Only |
upiPercent | C | Numeric | 11 | For AU Only |
eftposBase | C | Numeric | 11 | For AU Only |
eftposPercent | C | Numeric | 11 | For AU Only |
amexBase | C | Numeric | 11 | For AU Only |
amexPercent | C | Numeric | 11 | For AU Only |
jcbBase | C | Numeric | 11 | For AU Only |
jcbPercent | C | Numeric | 11 | For AU Only |
dinersBase | C | Numeric | 11 | For AU Only |
dinersPercent | C | Numeric | 11 | For AU Only |
altmerchCode | O | Alphanumeric | 20 | This is an optional field which has to be populated only if there is merchant MID or Dealer Code has to be captured at MID Level |
sameLocation | C | Alphanumeric | 1 | This flag has to be set to 'Y' if Merchant wants multiple MIDs at the same location |
mid | C | Numeric | 15 | This is the reference Member MID which needs to be given in case of ADD MID/ ADD TID. |
parentmid | C | Numeric | 15 | This is the SG (parent MID) of the reference MID which needs to be given in case of ADD MID & ADD TID |
otpEnabled | O | Alphanumeric | 10 | |
principalDetails | - | - | This section is used to capture details of Principal Owner for the said merchant. The same section can be repeated for multiple Principal Owners. We can have upto maximum of 2 Principal Owners per merchant. | |
principalNo | M | Alphanumeric | 2 | |
position | M | Alphanumeric | 20 | |
title | M | Alphanumeric | 20 | |
firstName | M | Alphanumeric | 25 | |
lastName | M | Alphanumeric | 25 | |
middleName | O | Alphanumeric | 25 | |
gender | M | Alphanumeric | 10 | |
dateOfBirth | M | Numeric | 8 | YYYYMMDD |
kycDetails | - | - | ||
kycCategory | ||||
identityType | M | Alphanumeric | 50 | "Type of KYC Document submitted. For India - PAN/AADHAR For ASEAN - Passport/Driving Licence/HKID or SGID or MYID For AU - Passport/Driving Licence" |
identityValue | M | Alphanumeric | 100 | Value of the Kyc Document submitted |
identitymetaName1 | C | Alphanumeric | 100 | "Additional information pertaning to the KYC docuements submitted. For AU - Driving License State Code" |
identitymetaValue1 | C | Alphanumeric | 100 | "Additional information pertaning to the KYC docuements submitted. For AU - Value Driving License State Code" |
nationality | M | Alphanumeric | 35 | |
principalAddress | - | - | ||
addressLine | M | Alphanumeric | 35 | |
addressLine2 | O | Alphanumeric | 35 | |
addressLine3 | O | Alphanumeric | 35 | |
city | M | Alphanumeric | 25 | |
state | M | Alphanumeric | 25 | |
pincode | M | Alphanumeric | 8 | |
country | M | Alphanumeric | 25 | |
mobileNo | M | Numeric | 15 | |
phone1 | O | Numeric | 15 | |
contactName | M | Alphanumeric | 35 | |
idDocDetails | C | - | "ID Doc Details section is a
conditional tag and has to be mandatorily present if the user is
uploding documents for a particular application. All documents uploaded under ""categoryInd"": ""P"" has to be included under principalDetails.idDocDetails" |
|
entity | Static Value - 'Member' | |||
idType | Value of docType received as response of uploaded document | |||
idValue | ||||
docId | Value of docID received as response of uploaded document | |||
categoryName | Value of categoryName received as response of uploaded document | |||
level | Value of level received as response of uploaded document | |||
mandatory | ||||
entity | Static Value - 'Member' | |||
idType | Value of docType received as response of uploaded document | |||
idValue | ||||
docId | Value of docID received as response of uploaded document | |||
categoryName | Value of categoryName received as response of uploaded document | |||
level | Value of level received as response of uploaded document | |||
mandatory | ||||
uboDetails | - | - | This section is used to capture details of Ultimate Benefeciary Owner for the said merchant. The same section can be repeated for multiple UBOs. We can have upto maximum of 5 UBOs per merchant. | |
serialNo | C | Numeric | 2 | |
title | C | Alphanumeric | 20 | |
firstName | C | Alphanumeric | 25 | |
lastName | C | Alphanumeric | 25 | |
middleName | O | Alphanumeric | 25 | |
dateOfBirth | C | Numeric | 10 | Format - YYYYMMDD |
shareholderPercentage | C | Numeric | 8 | |
nationality | C | Alphanumeric | 35 | |
kycDetails | C | - | ||
kycCategory | ||||
identityType | C | Alphanumeric | 50 | "Type of KYC Document submitted for
UBO. For India - PAN/AADHAR For ASEAN - Passport/Driving Licence/HKID or SGID or MYID For AU - Passport/Driving Licence" |
identityValue | C | Alphanumeric | 100 | Value of the Kyc Document submitted |
identitymetaName1 | C | Alphanumeric | 100 | "Additional information pertaning to
the KYC docuements submitted for UBO. For AU - Driving License State Code" |
identitymetaValue1 | C | Alphanumeric | 100 | "Additional information pertaning to
the KYC docuements submitted. For AU - Value Driving License State Code" |
uboAddress | - | - | ||
addressLine | C | Alphanumeric | 35 | |
addressLine2 | O | Alphanumeric | 35 | |
addressLine3 | O | Alphanumeric | 35 | |
city | C | Alphanumeric | 25 | |
state | C | Alphanumeric | 25 | |
pincode | C | Alphanumeric | 8 | |
country | C | Alphanumeric | 25 | |
mobileNo | C | Numeric | 15 | |
phone1 | O | Numeric | 15 | |
contactName | C | Alphanumeric | 35 | |
bankDetails | - | - | This tag will contain the Bank account details of Merchant/PayFac which needs to be configured at Fiserv End | |
uwaccountdetails | M | - | UW Account details are primarily the actual merchant account which will be used while underwriting the merchant | |
accountNo | M | Numeric | 100 | |
accountName | M | Alphanumeric | 35 | |
ifsc | M | Alphanumeric | 15 | |
bankName | M | Alphanumeric | 80 | |
currency | M | Alphanumeric | 3 | |
branch | O | Alphanumeric | 500 | |
bankAddress | M | Alphanumeric | 500 | |
accType | M | Alphanumeric | 30 | |
fundingaccountdetails | C | - | "Funding account will the details of
account to which Fiserv will process the funding on daily
basis. For PayFacs, this will be the PayFac account. For Normal Merchants, UW Account & Funding account both will be the same" |
|
accountNo | C | Numeric | 100 | If different form UW details |
accountName | C | Alphanumeric | 35 | |
ifsc | C | Alphanumeric | 15 | |
bankName | C | Alphanumeric | 80 | |
currency | C | Alphanumeric | 3 | |
branch | O | Alphanumeric | 500 | |
bankAddress | C | Alphanumeric | 500 | |
accType | C | Alphanumeric | 30 | |
collectionaccountdetails | C | - | "This section will have details of account which needs to be used for collection of charges. This account may or may not be the same as UW account/Funding account." | |
accountNo | C | Numeric | 100 | If different form UW details |
accountName | C | Alphanumeric | 35 | |
ifsc | C | Alphanumeric | 15 | |
bankName | C | Alphanumeric | 80 | |
currency | C | Alphanumeric | 3 | |
branch | O | Alphanumeric | 500 | |
bankAddress | C | Alphanumeric | 500 | |
accType | C | Alphanumeric | 30 | |
submerchantDetails | - | - | This section is used to capture the sub Merchant Details of the merchant | |
submerchantID | C | Numeric | 15 | "This is an optional field which the
Single MID PayFacs can use to pass their own MID to Fiserv. This field will be mandatory if the Channel level parameter for Payfac Provided SMID is set to Y. If the same is set to 'N', Boarding backend will generate its own MID for the merchant" |
businessSummary | - | - | This section is used to capture the summary of the merchant | |
briefSummary | M | Alphanumeric | 100 | |
salessrNumber | O | Alphanumeric | 100 | |
mccCode | M | Numeric | 20 | |
mccDescription | M | Alphanumeric | 200 | |
totalTurnover | M | Numeric | 20 | |
totalTurnoverPerMID | M | Numeric | 20 | |
cardTurnover | M | Numeric | 20 | |
avgTicketAmt | M | Numeric | 20 | |
dccTurnoverPerMID | M | Numeric | 20 | |
pgTurnover | M | Numeric | 20 | |
pgTurnoverPerMID | M | Numeric | 20 | |
avgEMITicketAmt | O | Numeric | 20 | |
tranVolumeInternet | M | Numeric | 20 | |
tranVolumeMoto | M | Numeric | 20 | |
tranVolumeinStore | M | Numeric | 20 | |
deliveryDays0 | M | Numeric | 20 | |
deliveryDays7 | M | Numeric | 20 | |
deliveryDays14 | M | Numeric | 20 | |
deliveryDays30 | M | Numeric | 20 | |
deliveryDaysOver30 | M | Numeric | 20 | |
tranTypeMagStrip | M | Numeric | 20 | |
tranTypeChip | M | Numeric | 20 | |
tranTypeKeyed | M | Numeric | 20 | |
creditSalesConsumer | M | Numeric | 20 | |
creditSalesBusiness | M | Numeric | 20 | |
firsReport | O | Alphanumeric | 20 | |
recurringTranFlag | O | Alphanumeric | 20 | |
refundPolicy | O | Alphanumeric | 20 | |
cardRefundDays | O | Alphanumeric | 20 | |
thirdPartyProcessorFlag | O | Alphanumeric | 20 | |
thirdPartyProcessorName | O | Alphanumeric | 40 |
UAT URL : https://www.uat.fdmerchantservices.com/Externalboarding/secure/addtid
PROD URL : https://www.firstdatamerchantservices.com//Externalboarding/secure/addtid
Request Type : POST
Field Name | M/O/C | Data Type | Length | Remarks |
---|---|---|---|---|
appURN | M | Alphanumeric | 30 | App URN retured as part of Create URN API |
appType | M | Alphanumeric | 8 | Fixed Value 'API' |
salesId | M | Alphanumeric | 70 | User Credential created for each partner |
channelCode | C | Alphanumeric | 10 | Static Channel Code shared with each partner |
osvFlagValue | O | Alphanumeric | 1 | Original Seen & Verified flag. Applicable for entities where documents are uploaded. For entities not uploading documents, keep this field as blank. |
merchantDetails | - | - | ||
businessName | M | Alphanumeric | 22 | |
legalName | M | Alphanumeric | 35 | |
businessType | M | Alphanumeric | 50 | |
registrationNo | M | Alphanumeric | 100 | |
taxDetails | - | - | ||
taxidType | M | Alphanumeric | 50 | "Tax ID Type provided for the merchant. For India - PAN For AU - ABN " |
taxidValue | M | Alphanumeric | 100 | "Tax ID Type provided for the merchant. For India: Individual PAN for Individual/Soleprop merchants Corporate PAN for other type pf merchants For AU: ABN Value" |
dateIncorporated | M | Numeric | 8 | YYYYMMDD |
websiteURL | C | Alphanumeric | 100 | |
communicationEmail | M | Alphanumeric | 60 | |
merchantType | M | Alphanumeric | 20 | |
acceptanceType | M | Alphanumeric | 10 | POS/ECOM/FDMOBILE |
iciciMerchant | M | Alphanumeric | 20 | |
newFundingAc | M | Alphanumeric | 20 | |
legalAddress | - | - | ||
addressLine | M | Alphanumeric | 35 | |
addressLine2 | O | Alphanumeric | 35 | |
addressLine3 | O | Alphanumeric | 35 | |
city | M | Alphanumeric | 25 | |
state | M | Alphanumeric | 25 | |
pincode | M | Alphanumeric | 8 | |
country | M | Alphanumeric | 25 | |
mobileNo | M | Numeric | 15 | |
phone1 | O | Numeric | 15 | |
O | Numeric | 30 | ||
contactName | M | Alphanumeric | 35 | |
gstNo | C | Alphanumeric | 100 | Mandatory for Large merchants |
gstMerchantStateCode | O | Alphanumeric | 40 | Mandatory for Large Merchants |
isdnFlag | C | Alphanumeric | 20 | "ID Doc Details section is a conditional tag and has to be mandatorily present if the user is uploding documents for a particular application. All documents uploaded under ""categoryInd"": ""E"" has to be included under merchantDetails.idDocDetails" |
entity | C | Alphanumeric | Static Value - 'Member' | |
idType | C | Alphanumeric | Value of docType received as response of uploaded document | |
idValue | C | Alphanumeric | ||
docId | C | Alphanumeric | Value of docID received as response of uploaded document | |
categoryName | C | Alphanumeric | Value of categoryName received as response of uploaded document | |
level | C | Numeric | Value of level received as response of uploaded document | |
mandatory | C | Alphanumeric | ||
entity | C | Static Value - 'Member' | ||
idType | C | Value of docType received as response of uploaded document | ||
idValue | C | |||
docId | C | Value of docID received as response of uploaded document | ||
categoryName | C | Value of categoryName received as response of uploaded document | ||
level | C | Value of level received as response of uploaded document | ||
mandatory | C | |||
geoLocation | - | - | ||
latitude | O | Numeric | 20 | |
longitude | O | Numeric | 20 | |
tradingLocations | M | - | "This section contains the trading
location details of merchants that is being onboarded. A maximum
upto 3 trading locations can be added under a single
Application. The entire trading location section needs to be repeated for multiple trading locations." |
|
locationNo | M | Numeric | 2 | |
tradingName | M | Alphanumeric | 22 | |
tradingAddress | M | - | ||
addressLine | M | Alphanumeric | 35 | |
addressLine2 | O | Alphanumeric | 35 | |
addressLine3 | O | Alphanumeric | 35 | |
city | M | Alphanumeric | 25 | |
state | M | Alphanumeric | 25 | |
pincode | M | Alphanumeric | 8 | |
country | M | Alphanumeric | 25 | |
mobileNo | M | Numeric | 15 | |
phone1 | O | Numeric | 15 | |
O | Numeric | 30 | ||
contactName | M | Alphanumeric | 35 | |
packageId | M | Numeric | 10 | |
autoSettlementTime | O | Numeric | 6 | HHMMSS |
cpvGroupId | O | Alphanumeric | 50 | |
regionalcpvGroupid | O | Alphanumeric | 50 | |
commerceConnectReferenceMID | O | Alphanumeric | 8 | |
terminals | - | - | ||
count | M | Numeric | 2 | |
preferedDate | M | Numeric | 8 | YYYYMMDD |
preferedTime | M | Numeric | 6 | HHMMSS |
discount | O | Numeric | 3 | |
userInstruction1 | O | Alphanumeric | 100 | |
userInstruction2 | O | Alphanumeric | 100 | |
surchargeAmount | - | - | Surcharge values currently selected by Merchant on MVSI in AU | |
visaBase | C | Numeric | 11 | For AU Only |
visaPercent | C | Numeric | 11 | For AU Only |
mcBase | C | Numeric | 11 | For AU Only |
mcPercent | C | Numeric | 11 | For AU Only |
upiBase | C | Numeric | 11 | For AU Only |
upiPercent | C | Numeric | 11 | For AU Only |
eftposBase | C | Numeric | 11 | For AU Only |
eftposPercent | C | Numeric | 11 | For AU Only |
amexBase | C | Numeric | 11 | For AU Only |
amexPercent | C | Numeric | 11 | For AU Only |
jcbBase | C | Numeric | 11 | For AU Only |
jcbPercent | C | Numeric | 11 | For AU Only |
dinersBase | C | Numeric | 11 | For AU Only |
dinersPercent | C | Numeric | 11 | For AU Only |
altmerchCode | O | Alphanumeric | 20 | This is an optional field which has to be populated only if there is merchant MID or Dealer Code has to be captured at MID Level |
sameLocation | C | Alphanumeric | 1 | This flag has to be set to 'Y' if Merchant wants multiple MIDs at the same location |
mid | C | Numeric | 15 | This is the reference Member MID which needs to be given in case of ADD MID/ ADD TID. |
parentmid | C | Numeric | 15 | This is the SG (parent MID) of the reference MID which needs to be given in case of ADD MID & ADD TID |
otpEnabled | O | Alphanumeric | 10 | |
principalDetails | - | - | This section is used to capture details of Principal Owner for the said merchant. The same section can be repeated for multiple Principal Owners. We can have upto maximum of 2 Principal Owners per merchant. | |
principalNo | M | Alphanumeric | 2 | |
position | M | Alphanumeric | 20 | |
title | M | Alphanumeric | 20 | |
firstName | M | Alphanumeric | 25 | |
lastName | M | Alphanumeric | 25 | |
middleName | O | Alphanumeric | 25 | |
gender | M | Alphanumeric | 10 | |
dateOfBirth | M | Numeric | 8 | YYYYMMDD |
kycDetails | - | - | ||
kycCategory | ||||
identityType | M | Alphanumeric | 50 | "Type of KYC Document submitted. For India - PAN/AADHAR For ASEAN - Passport/Driving Licence/HKID or SGID or MYID For AU - Passport/Driving Licence" |
identityValue | M | Alphanumeric | 100 | Value of the Kyc Document submitted |
identitymetaName1 | C | Alphanumeric | 100 | "Additional information pertaning to the KYC docuements submitted. For AU - Driving License State Code" |
identitymetaValue1 | C | Alphanumeric | 100 | "Additional information pertaning to the KYC docuements submitted. For AU - Value Driving License State Code" |
nationality | M | Alphanumeric | 35 | |
principalAddress | - | - | ||
addressLine | M | Alphanumeric | 35 | |
addressLine2 | O | Alphanumeric | 35 | |
addressLine3 | O | Alphanumeric | 35 | |
city | M | Alphanumeric | 25 | |
state | M | Alphanumeric | 25 | |
pincode | M | Alphanumeric | 8 | |
country | M | Alphanumeric | 25 | |
mobileNo | M | Numeric | 15 | |
phone1 | O | Numeric | 15 | |
contactName | M | Alphanumeric | 35 | |
idDocDetails | C | - | "ID Doc Details section is a
conditional tag and has to be mandatorily present if the user is
uploding documents for a particular application. All documents uploaded under ""categoryInd"": ""P"" has to be included under principalDetails.idDocDetails" |
|
entity | Static Value - 'Member' | |||
idType | Value of docType received as response of uploaded document | |||
idValue | ||||
docId | Value of docID received as response of uploaded document | |||
categoryName | Value of categoryName received as response of uploaded document | |||
level | Value of level received as response of uploaded document | |||
mandatory | ||||
entity | Static Value - 'Member' | |||
idType | Value of docType received as response of uploaded document | |||
idValue | ||||
docId | Value of docID received as response of uploaded document | |||
categoryName | Value of categoryName received as response of uploaded document | |||
level | Value of level received as response of uploaded document | |||
mandatory | ||||
uboDetails | - | - | This section is used to capture details of Ultimate Benefeciary Owner for the said merchant. The same section can be repeated for multiple UBOs. We can have upto maximum of 5 UBOs per merchant. | |
serialNo | C | Numeric | 2 | |
title | C | Alphanumeric | 20 | |
firstName | C | Alphanumeric | 25 | |
lastName | C | Alphanumeric | 25 | |
middleName | O | Alphanumeric | 25 | |
dateOfBirth | C | Numeric | 10 | Format - YYYYMMDD |
shareholderPercentage | C | Numeric | 8 | |
nationality | C | Alphanumeric | 35 | |
kycDetails | C | - | ||
kycCategory | ||||
identityType | C | Alphanumeric | 50 | "Type of KYC Document submitted for
UBO. For India - PAN/AADHAR For ASEAN - Passport/Driving Licence/HKID or SGID or MYID For AU - Passport/Driving Licence" |
identityValue | C | Alphanumeric | 100 | Value of the Kyc Document submitted |
identitymetaName1 | C | Alphanumeric | 100 | "Additional information pertaning to
the KYC docuements submitted for UBO. For AU - Driving License State Code" |
identitymetaValue1 | C | Alphanumeric | 100 | "Additional information pertaning to
the KYC docuements submitted. For AU - Value Driving License State Code" |
uboAddress | - | - | ||
addressLine | C | Alphanumeric | 35 | |
addressLine2 | O | Alphanumeric | 35 | |
addressLine3 | O | Alphanumeric | 35 | |
city | C | Alphanumeric | 25 | |
state | C | Alphanumeric | 25 | |
pincode | C | Alphanumeric | 8 | |
country | C | Alphanumeric | 25 | |
mobileNo | C | Numeric | 15 | |
phone1 | O | Numeric | 15 | |
contactName | C | Alphanumeric | 35 | |
bankDetails | - | - | This tag will contain the Bank account details of Merchant/PayFac which needs to be configured at Fiserv End | |
uwaccountdetails | M | - | UW Account details are primarily the actual merchant account which will be used while underwriting the merchant | |
accountNo | M | Numeric | 100 | |
accountName | M | Alphanumeric | 35 | |
ifsc | M | Alphanumeric | 15 | |
bankName | M | Alphanumeric | 80 | |
currency | M | Alphanumeric | 3 | |
branch | O | Alphanumeric | 500 | |
bankAddress | M | Alphanumeric | 500 | |
accType | M | Alphanumeric | 30 | |
fundingaccountdetails | C | - | "Funding account will the details of
account to which Fiserv will process the funding on daily
basis. For PayFacs, this will be the PayFac account. For Normal Merchants, UW Account & Funding account both will be the same" |
|
accountNo | C | Numeric | 100 | If different form UW details |
accountName | C | Alphanumeric | 35 | |
ifsc | C | Alphanumeric | 15 | |
bankName | C | Alphanumeric | 80 | |
currency | C | Alphanumeric | 3 | |
branch | O | Alphanumeric | 500 | |
bankAddress | C | Alphanumeric | 500 | |
accType | C | Alphanumeric | 30 | |
collectionaccountdetails | C | - | "This section will have details of account which needs to be used for collection of charges. This account may or may not be the same as UW account/Funding account." | |
accountNo | C | Numeric | 100 | If different form UW details |
accountName | C | Alphanumeric | 35 | |
ifsc | C | Alphanumeric | 15 | |
bankName | C | Alphanumeric | 80 | |
currency | C | Alphanumeric | 3 | |
branch | O | Alphanumeric | 500 | |
bankAddress | C | Alphanumeric | 500 | |
accType | C | Alphanumeric | 30 | |
submerchantDetails | - | - | This section is used to capture the sub Merchant Details of the merchant | |
submerchantID | C | Numeric | 15 | "This is an optional field which the
Single MID PayFacs can use to pass their own MID to Fiserv. This field will be mandatory if the Channel level parameter for Payfac Provided SMID is set to Y. If the same is set to 'N', Boarding backend will generate its own MID for the merchant" |
businessSummary | - | - | This section is used to capture the summary of the merchant | |
briefSummary | M | Alphanumeric | 100 | |
salessrNumber | O | Alphanumeric | 100 | |
mccCode | M | Numeric | 20 | |
mccDescription | M | Alphanumeric | 200 | |
totalTurnover | M | Numeric | 20 | |
totalTurnoverPerMID | M | Numeric | 20 | |
cardTurnover | M | Numeric | 20 | |
avgTicketAmt | M | Numeric | 20 | |
dccTurnoverPerMID | M | Numeric | 20 | |
pgTurnover | M | Numeric | 20 | |
pgTurnoverPerMID | M | Numeric | 20 | |
avgEMITicketAmt | O | Numeric | 20 | |
tranVolumeInternet | M | Numeric | 20 | |
tranVolumeMoto | M | Numeric | 20 | |
tranVolumeinStore | M | Numeric | 20 | |
deliveryDays0 | M | Numeric | 20 | |
deliveryDays7 | M | Numeric | 20 | |
deliveryDays14 | M | Numeric | 20 | |
deliveryDays30 | M | Numeric | 20 | |
deliveryDaysOver30 | M | Numeric | 20 | |
tranTypeMagStrip | M | Numeric | 20 | |
tranTypeChip | M | Numeric | 20 | |
tranTypeKeyed | M | Numeric | 20 | |
creditSalesConsumer | M | Numeric | 20 | |
creditSalesBusiness | M | Numeric | 20 | |
firsReport | O | Alphanumeric | 20 | |
recurringTranFlag | O | Alphanumeric | 20 | |
refundPolicy | O | Alphanumeric | 20 | |
cardRefundDays | O | Alphanumeric | 20 | |
thirdPartyProcessorFlag | O | Alphanumeric | 20 | |
thirdPartyProcessorName | O | Alphanumeric | 40 |
UAT URL : https://www.uat.fdmerchantservices.com/Externalboarding/secure/appstatus/100000175
PROD URL : https://www.firstdatamerchantservices.com/Externalboarding/secure/appstatus/
Request Type : GET
Field Name < Description > | M/O/C | Data Type | Length | Remarks |
---|