Category links

API Links

Merchant/Store/Register

CoreCard is a dedicated API that you can use to create a merchant establishment and hierarchies, as required. You can create a child hierarchy under a merchant establishment by inputting the merchant ID.

Update MSR

Action: POST

Endpoint: /api/CoreCredit/MerchantManagement/UpdateMSR

POST /api/CoreCredit/MerchantManagement/UpdateMSR

Use this API to update details of a merchant, store, or register for an institution based on MSR-level input. A user may update the merchant, store, or register names, as well as address details, bank account numbers, and ACH routing numbers.

Request fields detail
Fields Description

Source

string

Source of API Consumer For external system expected sources will be WEB.

Allowable Values:

50

IPAddress

string

Optional

IP Address of Client / Application Hosting Server Example: 10.206.0.204

Allowable Values:

15

DateFormat

string

Optional

Place Holder for Future Use. Values are: 1 : MM/dd/yyyy HH:MM:SS (Default) 2 : MM/dd/yy HH:MM:SS 3 : dd/MM/yyyy HH:MM:SS

Allowable Values:

25

CurrencyCode

string

Optional

Currency Code Place Holder for Future Use. Valid Values: Refer Appendix Section - Currency Code Example:840 = US Dollar Condition:If no value is passed, default value = 840

Allowable Values:

10

CurrencySymbolType

string

Optional

Place Holder for Future Use. CurrencySymbolType: 1: Currency Sign like $ 2: 3 ALPHA Currency Code like USD

Allowable Values:

10

Language

string

Optional

Place Holder for Future Use. Language: en: means use English Default: en - English

Allowable Values:

10

ExternalIP

string

IP Address of end user of API

Allowable Values:

50

SessionID

string

Optional

Session identifier of the API Example: 000028;026;1349906692

Allowable Values:

100

APIVersion

string

Version of the API to be invoked. Example: 2.0 API Version Current Version 2.0

Allowable Values:

10

CallerID

string

Optional

Caller ID of source from where API is initiated it is End User Caller ID Example: 7204454214 (phone number applicable in Case of IVR)

Allowable Values:

20

CalledID

string

Optional

Called ID of destination for which API is initiated It is Destination Called ID Example: 7314145404 (phone number applicable in Case of IVR)

Allowable Values:

20

RequestTime

datetime

Optional

Request Date Time of API Format: MM/dd/yyyy HH:mm:ss Example:01/15/2020 10:05:23

InstitutionID

integer

Mandatory

Unique identification number for Institution. Example:Fixed value needs to pass which is provided by Corecard.

MSRLevel

integer

Mandatory

Type of Account to be Updated Valid Values: 0 = Merchant,1 = Store,2 = Register Example:1

Allowable Values:

1

MSRNumber

integer

Mandatory

Identifier for Merchant/Store/Register Account to be created Valid Values:0-9

Allowable Values:

5

ParentMSRNumber

integer

Mandatory

Identifier for Parent account under which Merchant/Store/Register Account to be Updated. Valid Values:0-9

Allowable Values:

5

MSRName

string

Mandatory

Name of the Merchant. Valid Values:A-Z,0-9 Example:ABC LLC

Allowable Values:

100

MerchantDescription

string

Conditional

Description of Account Valid Values:A-Z,0-9 Example:ABC LLC Condition : Required for Merchant and Ignored for Stored/Register

Allowable Values:

30

ContactType

integer

Mandatory

Type of contact of Merchant Valid Values: 0 = None 1 = Billing 2 = Settlement 3 = Administration 4 = Department 5 = Division Example:3

Allowable Values:

50

MerchantState

string

Mandatory

State code to which merchant belongs Valid Values:A-Z,0-9 Example:Alabama

Allowable Values:

5

MSRWorkNumber

string

Optional

MSR Work Phone Number Valid Values:0-9 Format:XXXXXXXXX Example:547896865

Allowable Values:

20

MSRHomePhone

string

Optional

MSR Home Phone Number Valid Values:0-9 Format:XXXXXXXXX Example:547896865

Allowable Values:

20

MSRMobilePhone

string

Optional

MSR Mobile Phone Number Valid Values:0-9 Format:XXXXXXXXXXXX Example:547896865689

Allowable Values:

20

MSRFaxNumber

string

Optional

MSR Fax Number Valid Values:0-9 Format:XXXXXXXXXXXX Example:547896865689

Allowable Values:

20

MSREmail1

string

Optional

MSR Email1 Format:abc@cc.com Example:user1@gmail.com

Allowable Values:

100

MSREmail2

string

Optional

MSR Email2 Format:abc@cc.com Example:user1@gmail.com

Allowable Values:

100

MSRLegalEntityName

string

Optional

Name of the Legal Entity Valid Values:A-Z,0-9 Example:ABC LLC

Allowable Values:

30

MSRDBAName

string

Optional

Do Business As Name Valid Values:A-Z,0-9 Example:ABC LLC

Allowable Values:

50

MSRTaxIdentificationNumber

string

Optional

Organization’s Tax Id Number Valid Values:0-9 Format:XXXXXXXXXXXX Example:547896865689

Allowable Values:

25

MSRReserveTable

integer

Optional

Merchant Reserve Table Account Id Valid Values:0-9 Format:XXXXXXXXXXXX Example:4785

MSRACHROUTINGNUMBER

string

Conditional

ABA Routing Number Valid Values:0-9 Format:XXXXXX Example:5478968

Allowable Values:

9

MSRACHCHECKINGACCNUM

string

Conditional

Bank Account Number Valid Values:0-9 Format:XXXXXXXXXXXX Example:547896865689 Condition:Required when SettlementLevel = 0

Allowable Values:

19

MSRACHACCNAME

string

Conditional

Account Name Condition:Required when SettlementLevel = 0

Allowable Values:

100

MSRTermOverrideInd

string

Optional

Merchant TermOverride Indicator

Allowable Values:

5

MSROverrideFeeRate

decimal

Optional

Override Fee Rate

MSROverrideReserveRate

decimal

Optional

Override Reserve Rate

MSRCreditFirstName

string

Optional

Credit First Name

Allowable Values:

50

MSRCreditLastName

string

Optional

Credit Last Name

Allowable Values:

50

MSRCreditWorkPhone

string

Optional

Credit Work Phone Valid Values:0-9 Format:XXXXXX Example:5478968

Allowable Values:

20

MSRCreditMobilePhone

string

Optional

Credit Mobile Phone Valid Values:0-9 Format:XXXXXXXXXXXX Example:547896865689

Allowable Values:

20

MSRCreditEmail1

string

Optional

Credit Email 1 Valid Values:A-Z,0-9 Format:abc@cc.com Example:user1@cc.com

Allowable Values:

100

MSRAccountingFirstName

string

Optional

Accounting First Name

Allowable Values:

50

MSRAccountingLastName

string

Optional

Accounting Last Name

Allowable Values:

50

MSRAccountingWorkPhone

string

Optional

Accounting Work Phone Valid Values:0-9 Format:XXXXXXXX Example:54789686

Allowable Values:

20

MSRAccountingMobilePhone

string

Optional

Accounting Mobile Phone Valid Values:0-9 Format:XXXXXXXXX Example:547896865

Allowable Values:

20

MSRAccountingEmail1

string

Optional

Accounting Email1 Valid Values:A-Z,0-9 Format:abc@cc.com Example:user1@cc.com

Allowable Values:

100

MSRSalesFirstName

string

Optional

Sales First Name

Allowable Values:

50

MSRSalesLastName

string

Optional

Sales Last Name

Allowable Values:

50

MSRSalesWorkPhone

string

Optional

Sales Work Phone Valid Values:0-9 Format:XXXXXXXXX Example:547896865

Allowable Values:

20

MSRSalesMobilePhone

string

Optional

Sales Mobile Phone Valid Values:0-9 Format:XXXXXXXXX Example:547896865

Allowable Values:

20

MSRSalesEmail1

string

Optional

Sales Email1 Valid Values:A-Z,0-9 Format:abc@cc.com Example:user1@cc.com

Allowable Values:

100

MSRSponserID

string

Optional

Merchant Sponser ID

Allowable Values:

200

MSRArrangementID

string

Optional

Arrangement ID

Allowable Values:

200

MSRAccountManagerFirstName

string

Optional

Account Manager First Name

Allowable Values:

50

MSRAccountManagerLastName

string

Optional

Account Manager Last Name

Allowable Values:

50

ParentMSRSalesFirstName

string

Optional

Parent Merchant Sales First Name

Allowable Values:

50

ParentMSRSalesLastName

string

Optional

Parent Merchant Sales Last Name

Allowable Values:

50

MSRExternalCustomerID

string

Optional

External CustomerID

Allowable Values:

200

MSRExternalID

string

Optional

External MerchantID

Allowable Values:

50

MSRPIN

string

Optional

Merchant PIN

Allowable Values:

200

MSREnrollmentDate

datetime

Optional

Enrollment Date Format: MM/DD/YYYY HH:MM:SS Example: 01/01/2020 11:05:05

MSRCreditLimitInd

string

Optional

Credit Limit Indicator

Allowable Values:

50

MSRCreditLimitMaxAmount

decimal

Optional

Credit Limit Max Amount

MSRDirectBatchInd

string

Optional

Direct Batch Indicator

Allowable Values:

50

MSRApplicationTypeOverride

string

Optional

Application Type Override

Allowable Values:

50

MSRFeeWaiver

string

Optional

Fee Waiver

Allowable Values:

10

MSRFeeDays

string

Optional

Fee Days

Allowable Values:

200

MSRBillingFrequency

string

Optional

Billing Frequency

Allowable Values:

50

MSRGSDInd

string

Optional

Merchant GSD Indicator

Allowable Values:

200

MSRExternalInd

string

Optional

External Merchant Indicator

Allowable Values:

200

MSRExtCompanyID

string

Optional

External Company ID

Allowable Values:

200

MSRConsumerDirectOptIn

string

Optional

Consumer Direct Opt-In

Allowable Values:

200

MSRMemail2

string

Optional

Merchant Email 2 Valid Values:A-Z,0-9 Format:abc@cc.com Example:user1@cc.com

Allowable Values:

100

MSRContactPhone

string

Optional

ContactPhone Valid Values:0-9 Format:XXXXXXXXXXXX Example:547896865689

Allowable Values:

20

MSRServiceAreaAddLine1

string

Optional

Service Area Address Line1

Allowable Values:

50

MSRServiceAreaAddLine2

string

Optional

Service Area Address Line2

Allowable Values:

50

MSRServiceAreaCity

string

Optional

Service Area City

Allowable Values:

40

MSRServiceAreaState

string

Optional

Service Area State

Allowable Values:

5

MSRServiceAreaZip

string

Optional

Service Area Zip

Allowable Values:

10

MSRServiceWebsite

string

Optional

Service Website

Allowable Values:

300

MSRServiceAreaRadius

string

Optional

Service Area Radius

Allowable Values:

15

MSRServiceLocationLongitude

string

Optional

Service Location Longitude

Allowable Values:

200

MSRServiceLocationLatitude

string

Optional

Service Location Latitude

Allowable Values:

200

MSRLogoID

string

Optional

ProductID (Logo ID) of Merchant.

Allowable Values:

200

MSRServiceLocationPoint

string

Optional

Service Location Point

Allowable Values:

200

MSRServiceLocationRadiusMiles

string

Optional

Service Location Radius Miles

Allowable Values:

15

MSRProgram

string

Optional

Program (ProductName)

Allowable Values:

100

MSRVersion

string

Optional

Version

Allowable Values:

25

MSRPolicyIdentifier

integer

Conditional

PolicyIdentifier, will result in digits only Ie. 1 or 2. Possible Value: 1=Grandfathered, 2=Standard Condition:Required when MSRLevel = 0

Allowable Values:

1

MSRHighLinePolicy

integer

Conditional

HighLinePolicy, will result in digits only Ie. 0 or 1. Possible Values: 0 = No, 1 = Yes Condition:Required when MSRLevel = 0

Allowable Values:

1

MSRLineAssignmentPolicy

integer

Optional

Line Assigned Policy of Merchant Possible Value: 1=Grandfathered, 2=Standard

MSRWebServicesPassword

string

Optional

Merchant Web Services Password.

Allowable Values:

120

MSRCreationDate

datetime

Optional

Merchant Creation Date. Format: MM/DD/YYYY HH:MM:SS Example: 01/01/2020 11:05:05

MSRSplitFee

integer

Optional

SplitFee for Merchant Settlement 1 = YES (for seperate credit and debit amount) 0 = NO/NULL (for combine credit and debit amount)

Allowable Values:

10

MSRTemplateID

string

Optional

TemplateID of Merchant Offering Template. Example:MOT1001

Allowable Values:

100

AddressLine1

string

Mandatory

Address Line 1 of Merchant. Valid Values:A-Z,0-9 Example:123 HWY

Allowable Values:

50

AddressLine2

string

Optional

Address Line 2 of Merchant. Valid Values:A-Z,0-9 Example:Park Avenue

Allowable Values:

50

City

string

Mandatory

City of Merchant Valid Values:A-Z Format:XXXX Example:Atlanta

Allowable Values:

40

PostalCode

string

Mandatory

Postal Code for merchant address Valid Values:0-9 Format:XXXXXX Example:1234

Allowable Values:

10

County

string

Optional

County of MSR Valid Values:0-9 Format:XXXXX Example:54789

Allowable Values:

40

Country

string

Mandatory

Country Name of the MSR address Example:USA

Allowable Values:

5

CustomerID

string

Mandatory

Id Number for Contact/Merchant/Store/Register

Allowable Values:

100

CompanyName

string

Mandatory

Company Name

Allowable Values:

50

FirstName

string

Mandatory

Card holder's First name. Valid Values:A-Z Example:User

Allowable Values:

50

LastName

string

Mandatory

Card holder's Last name. Valid Values:A-Z Example:Smith

Allowable Values:

50

Position

integer

Optional

Employment position of the card holder Valid Values: 0 - None 1 - President 2 - Vice 3 - Director 4 - Manager 5 - Administrator Example: 4

MerchantCategory

string

Optional

Merchant Category

Allowable Values:

200

ServiceDescription

string

Optional

Service Description

Allowable Values:

256

NetworkName

string

Optional

Name of Network from which Merchant needed to be associated

Allowable Values:

50

NetworkID

int64

Optional

NetworkID of Network from which Merchant needed to be associated Valid Values:0-9 Format:XXXXXXXXXXXX Example:547896865689

MTAcode

string

Optional

MTA Code will determine if Transaction Authorization is required for the Purchase posted under this Merchant or not Valid Values:"0000" – MTA not applicable, "3000" – MTA Applicable default value should be "0000" Format:XXXX Example:0000

Allowable Values:

4
Sample request body 
{
  "Source": "WEB",
  "IPAddress": "10.120.0.1",
  "DateFormat": null,
  "CurrencyCode": null,
  "CurrencySymbolType": null,
  "Language": null,
  "ExternalIP": "10.120.0.0",
  "SessionID": null,
  "APIVersion": "2.0",
  "CallerID": null,
  "CalledID": null,
  "RequestTime": null,
  "InstitutionID": 3235,
  "MSRLevel": 1,
  "MSRNumber": 6000,
  "ParentMSRNumber": 11607,
  "MSRName": "M 6000",
  "MerchantDescription": "M 6000",
  "ContactType": 1,
  "MerchantState": "AL",
  "MSRWorkNumber": null,
  "MSRHomePhone": null,
  "MSRMobilePhone": null,
  "MSRFaxNumber": "45577777",
  "MSREmail1": "abc@xyz.com",
  "MSREmail2": null,
  "MSRLegalEntityName": null,
  "MSRDBAName": null,
  "MSRTaxIdentificationNumber": null,
  "MSRReserveTable": 4785,
  "MSRACHROUTINGNUMBER": "011000015",
  "MSRACHCHECKINGACCNUM": "12457857875",
  "MSRACHACCNAME": null,
  "MSRTermOverrideInd": null,
  "MSROverrideFeeRate": null,
  "MSROverrideReserveRate": null,
  "MSRCreditFirstName": null,
  "MSRCreditLastName": null,
  "MSRCreditWorkPhone": null,
  "MSRCreditMobilePhone": null,
  "MSRCreditEmail1": null,
  "MSRAccountingFirstName": null,
  "MSRAccountingLastName": null,
  "MSRAccountingWorkPhone": null,
  "MSRAccountingMobilePhone": null,
  "MSRAccountingEmail1": null,
  "MSRSalesFirstName": null,
  "MSRSalesLastName": null,
  "MSRSalesWorkPhone": null,
  "MSRSalesMobilePhone": null,
  "MSRSalesEmail1": null,
  "MSRSponserID": null,
  "MSRArrangementID": null,
  "MSRAccountManagerFirstName": null,
  "MSRAccountManagerLastName": null,
  "ParentMSRSalesFirstName": null,
  "ParentMSRSalesLastName": null,
  "MSRExternalCustomerID": null,
  "MSRExternalID": null,
  "MSRPIN": null,
  "MSREnrollmentDate": null,
  "MSRCreditLimitInd": null,
  "MSRCreditLimitMaxAmount": null,
  "MSRDirectBatchInd": null,
  "MSRApplicationTypeOverride": null,
  "MSRFeeWaiver": null,
  "MSRFeeDays": null,
  "MSRBillingFrequency": null,
  "MSRGSDInd": null,
  "MSRExternalInd": null,
  "MSRExtCompanyID": null,
  "MSRConsumerDirectOptIn": null,
  "MSRMemail2": null,
  "MSRContactPhone": null,
  "MSRServiceAreaAddLine1": null,
  "MSRServiceAreaAddLine2": null,
  "MSRServiceAreaCity": null,
  "MSRServiceAreaState": null,
  "MSRServiceAreaZip": null,
  "MSRServiceWebsite": null,
  "MSRServiceAreaRadius": null,
  "MSRServiceLocationLongitude": null,
  "MSRServiceLocationLatitude": null,
  "MSRLogoID": null,
  "MSRServiceLocationPoint": null,
  "MSRServiceLocationRadiusMiles": null,
  "MSRProgram": null,
  "MSRVersion": null,
  "MSRPolicyIdentifier": null,
  "MSRHighLinePolicy": null,
  "MSRLineAssignmentPolicy": null,
  "MSRWebServicesPassword": null,
  "MSRCreationDate": null,
  "MSRSplitFee": null,
  "MSRTemplateID": null,
  "AddressLine1": "Address Line 1",
  "AddressLine2": "Address Line 2",
  "City": "New York",
  "PostalCode": "45678",
  "County": null,
  "Country": "USA",
  "CustomerID": null,
  "CompanyName": null,
  "FirstName": null,
  "LastName": null,
  "Position": 4,
  "MerchantCategory": "1",
  "ServiceDescription": null,
  "NetworkName": "Network_2",
  "NetworkID": 1002,
  "MTAcode": null
}
Response fields detail
Fields Description

ResponseID

string

This number indicates that API responded. Response ID is unique.

Sample response body 

{
  "application/json": {
    "Message": "Request processed successfully",
    "Status": true,
    "ErrorCode": "ERR01155",
    "ResponseData": {
      "ResponseID": "57324863"
    }
  }
}

Create MSR

Action: POST

Endpoint: /api/CoreCredit/MerchantManagement/CreateMSR

POST /api/CoreCredit/MerchantManagement/CreateMSR

Use this API to create merchant, store, or register (i.e., merchant and its hierarchy) entities in the CoreCARD system. The API is used to create one entity at a time based on input MSR-level information.

Note

A merchant entity should be created before creating a store entity and a store entity should be created before creating a register in the system.

Request fields detail
Fields Description

Source

string

Source of API Consumer For external system expected sources will be WEB.

Allowable Values:

50

IPAddress

string

Optional

IP Address of Client / Application Hosting Server Example: 10.206.0.204

Allowable Values:

15

DateFormat

string

Optional

Place Holder for Future Use. Values are: 1 : MM/dd/yyyy HH:MM:SS (Default) 2 : MM/dd/yy HH:MM:SS 3 : dd/MM/yyyy HH:MM:SS

Allowable Values:

25

CurrencyCode

string

Optional

Currency Code Place Holder for Future Use. Valid Values: Refer Appendix Section - Currency Code Example:840 = US Dollar Condition:If no value is passed, default value = 840

Allowable Values:

10

CurrencySymbolType

string

Optional

Place Holder for Future Use. CurrencySymbolType: 1: Currency Sign like $ 2: 3 ALPHA Currency Code like USD

Allowable Values:

10

Language

string

Optional

Place Holder for Future Use. Language: en: means use English Default: en - English

Allowable Values:

10

ExternalIP

string

IP Address of end user of API

Allowable Values:

50

SessionID

string

Optional

Session identifier of the API Example: 000028;026;1349906692

Allowable Values:

100

APIVersion

string

Version of the API to be invoked. Example: 2.0 API Version Current Version 2.0

Allowable Values:

10

CallerID

string

Optional

Caller ID of source from where API is initiated it is End User Caller ID Example: 7204454214 (phone number applicable in Case of IVR)

Allowable Values:

20

CalledID

string

Optional

Called ID of destination for which API is initiated It is Destination Called ID Example: 7314145404 (phone number applicable in Case of IVR)

Allowable Values:

20

RequestTime

datetime

Optional

Request Date Time of API Format: MM/dd/yyyy HH:mm:ss Example:01/15/2020 10:05:23

MSRLevel

string

Mandatory

Type of Account to be created Valid Values: 0 = Merchant,1 = Store,2 = Register Example:1

Allowable Values:

1

MSRNumber

string

Mandatory

Identifier for Merchant/Store/Register Account to be created Valid Values:A-Z, 0-9

Allowable Values:

9

ParentMSRNumber

string

Mandatory

Identifier for Parent account under which Merchant/Store/Register Account to be created. Valid Values:A-Z,0-9

Allowable Values:

9

MSRName

string

Mandatory

Name of the Merchant. Valid Values:A-Z,0-9 Example:ABC LLC

Allowable Values:

100

MerchantDescription

string

Conditional

Description of Account Valid Values:A-Z,0-9 Example:ABC LLC Condition : Required for Merchant and Ignored for Stored/Register

Allowable Values:

30

ContactType

string

Mandatory

Type of contact of Merchant Valid Values: 0 = None 1 = Billing 2 = Settlement 3 = Administration 4 = Department 5 = Division Example:3

Allowable Values:

50

MerchantState

string

Mandatory

Merchant’s State Valid Values:A-Z,0-9 Example:Alabama

Allowable Values:

5

MSRNumber1

string

Optional

MSR Contact number Valid Values:0-9 Format:XXXXXXXXX Example:547896865

Allowable Values:

20

MSRNumber2

string

Optional

MSR Contact number Valid Values:0-9 Format:XXXXXXXXX Example:547896865

Allowable Values:

20

MSRNumber3

string

Optional

MSR Contact number Valid Values:0-9 Format:XXXXXXXXXXXX Example:547896865689

Allowable Values:

20

MSRFaxNumber

string

Optional

MSR Fax Number Valid Values:0-9 Format:XXXXXXXXXXXX Example:547896865689

Allowable Values:

20

MSREmail1

string

Optional

MSR Email1 Format:abc@cc.com Example:user1@gmail.com

Allowable Values:

100

MSREmail2

string

Optional

MSR Email2 Format:abc@cc.com Example:user1@gmail.com

Allowable Values:

100

MSRLegalEntityName

string

Optional

Name of the Legal Entity Valid Values:A-Z,0-9 Example:ABC LLC

Allowable Values:

30

MSRDBAName

string

Optional

Do Business As Name Valid Values:A-Z,0-9 Example:ABC LLC

Allowable Values:

50

MSRTaxIdentificationNumber

string

Optional

Organization’s Tax Id Number Valid Values:0-9 Format:XXXXXXXXXXXX Example:547896865689

Allowable Values:

25

MSRReserveTable

integer

Optional

Merchant Reserve Table Account Id Valid Values:0-9 Format:XXXXXXXXXXXX Example:547896865689

MSRACHRoutingNumber

string

Conditional

ABA Routing Number Valid Values:0-9 Format:XXXXXX Example:5478968

Allowable Values:

9

MSRACHCheckingAccnum

string

Conditional

Bank Account Number Valid Values:0-9 Format:XXXXXXXXXXXX Example:547896865689 Condition:Required when SettlementLevel = 0

Allowable Values:

19

MSRACHAccName

string

Conditional

Account Name Condition:Required when SettlementLevel = 0

Allowable Values:

100

MSRTermOverrideInd

string

Optional

Merchant TermOverride Indicator

Allowable Values:

5

MSROverrideFeeRate

decimal

Optional

Override Fee Rate

MSROverrideReserveRate

decimal

Optional

Override Reserve Rate

MSRCreditFirstName

string

Optional

Credit First Name

Allowable Values:

50

MSRCreditLastName

string

Optional

Credit Last Name

Allowable Values:

50

MSRCreditWorkPhone

string

Optional

Credit Work Phone Valid Values:0-9 Format:XXXXXX Example:5478968

Allowable Values:

20

MSRCreditMobilePhone

string

Optional

Credit Mobile Phone Valid Values:0-9 Format:XXXXXXXXXXXX Example:547896865689

Allowable Values:

20

MSRCreditEmail1

string

Optional

Credit Email 1 Valid Values:A-Z,0-9 Format:abc@cc.com Example:user1@cc.com

Allowable Values:

100

MSRAccountingFirstName

string

Optional

Accounting First Name

Allowable Values:

50

MSRAccountingLastName

string

Optional

Accounting Last Name

Allowable Values:

50

MSRAccountingWorkPhone

string

Optional

Accounting Work Phone Valid Values:0-9 Format:XXXXXXXX Example:54789686

Allowable Values:

20

MSRAccountingMobilePhone

string

Optional

Accounting Mobile Phone Valid Values:0-9 Format:XXXXXXXXX Example:547896865

Allowable Values:

20

MSRAccountingEmail1

string

Optional

Accounting Email1 Valid Values:A-Z,0-9 Format:abc@cc.com Example:user1@cc.com

Allowable Values:

100

MSRSalesFirstName

string

Optional

Sales First Name

Allowable Values:

50

MSRSalesLastName

string

Optional

Sales Last Name

Allowable Values:

50

MSRSalesWorkPhone

string

Optional

Sales Work Phone Valid Values:0-9 Format:XXXXXXXXX Example:547896865

Allowable Values:

20

MSRSalesMobilePhone

string

Optional

Sales Mobile Phone Valid Values:0-9 Format:XXXXXXXXX Example:547896865

Allowable Values:

20

MSRSalesEmail1

string

Optional

Sales Email1 Valid Values:A-Z,0-9 Format:abc@cc.com Example:user1@cc.com

Allowable Values:

100

MSRSponserID

string

Optional

Merchant Sponser ID

Allowable Values:

200

MSRArrangementID

string

Optional

Arrangement ID

Allowable Values:

200

MSRAccountManagerFirstName

string

Optional

Account Manager First Name

Allowable Values:

50

MSRAccountManagerLastName

string

Optional

Account Manager Last Name

Allowable Values:

50

ParentMSRSalesFirstName

string

Optional

Parent Merchant Sales First Name

Allowable Values:

50

ParentMSRSalesLastName

string

Optional

Parent Merchant Sales Last Name

Allowable Values:

50

MSRExternalCustomerID

string

Optional

External CustomerID

Allowable Values:

200

MSRExternalID

string

Optional

External MerchantID

Allowable Values:

50

MSRPIN

string

Optional

Merchant PIN

Allowable Values:

200

MSREnrollmentDate

datetime

Optional

Enrollment Date Format: MM/DD/YYYY HH:MM:SS Example: 01/01/2020 11:05:05

MSRCreditLimitInd

string

Optional

Credit Limit Indicator

Allowable Values:

50

MSRCreditLimitMaxAmount

decimal

Optional

Credit Limit Max Amount

MSRDirectBatchInd

string

Optional

Direct Batch Indicator

Allowable Values:

50

MSRApplicationTypeOverride

string

Optional

Application Type Override

Allowable Values:

50

MSRFeeWaiver

string

Optional

Fee Waiver

Allowable Values:

10

MSRFeeDays

string

Optional

Fee Days

Allowable Values:

200

MSRBillingFrequency

string

Optional

Billing Frequency

Allowable Values:

50

MSRGSDInd

string

Optional

Merchant GSD Indicator

Allowable Values:

200

MSRExternalInd

string

Optional

External Merchant Indicator

Allowable Values:

200

MSRExtCompanyID

string

Optional

External Company ID

Allowable Values:

200

MSRConsumerDirectOptIn

string

Optional

Consumer Direct Opt-In

Allowable Values:

200

MSRMemail2

string

Optional

Merchant Email 2 Valid Values:A-Z,0-9 Format:abc@cc.com Example:user1@cc.com

Allowable Values:

100

MSRContactPhone

string

Optional

ContactPhone Valid Values:0-9 Format:XXXXXXXXXXXX Example:547896865689

Allowable Values:

20

MSRServiceAreaAddLine1

string

Optional

Service Area Address Line1

Allowable Values:

50

MSRServiceAreaAddLine2

string

Optional

Service Area Address Line2

Allowable Values:

50

MSRServiceAreaCity

string

Optional

Service Area City

Allowable Values:

40

MSRServiceAreaState

string

Optional

Service Area State

Allowable Values:

5

MSRServiceAreaZip

string

Optional

Service Area Zip

Allowable Values:

10

MSRServiceWebsite

string

Optional

Service Website

Allowable Values:

300

MSRServiceAreaRadius

string

Optional

Service Area Radius

Allowable Values:

15

MSRServiceLocationLongitude

string

Optional

Service Location Longitude

Allowable Values:

200

MSRServiceLocationLatitude

string

Optional

Service Location Latitude

Allowable Values:

200

MSRLogoID

string

Optional

ProductID (Logo ID) of Merchant.

Allowable Values:

200

MSRServiceLocationPoint

string

Optional

Service Location Point

Allowable Values:

200

MSRServiceLocationRadiusMiles

string

Optional

Service Location Radius Miles

Allowable Values:

15

MSRProgram

string

Optional

Program (ProductName)

Allowable Values:

100

MSRVersion

string

Optional

Version

Allowable Values:

25

MSRSettlementLevel

integer

Conditional

Merchant Settlement Level. Only one merchant can have settlement level 'Yes' in any hierarchy tree. Possible Values:0 = No , 1 = Yes Condition:Required when MSRLevel = 0

MSRPolicyIdentifier

string

Conditional

PolicyIdentifier, will result in digits only Ie. 1 or 2. Possible Value: 1=Grandfathered,2=Standard Condition:Required when MSRLevel = 0

Allowable Values:

1

MSRHighLinePolicy

string

Conditional

HighLinePolicy, will result in digits only Ie. 0 or 1. Possible Values:0 = No , 1 = Yes Condition:Required when MSRLevel = 0

Allowable Values:

1

MSRLineAssignmentPolicy

string

Optional

Line Assigned Policy of Merchant Possible Value: 1=Grandfathered,2=Standard

MSRWebServicesPassword

string

Optional

Merchant Web Services Password.

Allowable Values:

120

MSRCreationDate

datetime

Optional

Merchant Creation Date. Format: MM/DD/YYYY HH:MM:SS Example: 01/01/2020 11:05:05

MSRSplitFee

string

Optional

SplitFee for Merchant Settlement 1= YES “or seperate credit and debit amount” 0 = NO/NULL ”for combine credit and debit amount”

Allowable Values:

10

MSRTemplateID

string

Optional

TemplateID of Merchant Offering Template. Example:MOT1001

Allowable Values:

100

InstitutionID

integer

Mandatory

Unique identification number for Institution. Example:Fixed value needs to pass which is provided by Corecard.

AddressLine1

string

Mandatory

MSR Address Line 1. Valid Values:A-Z,0-9 Example:123 HWY

Allowable Values:

50

AddressLine2

string

Optional

MSR Address Line 2. Valid Values:A-Z,0-9 Example:Park Avenue

Allowable Values:

50

City

string

Mandatory

City Name of the MSR address Example:Los Angeles

Allowable Values:

25

PostalCode

string

Mandatory

Postal code of MSR address Valid Values:0-9 Format:XXXXXX Example:5478968

Allowable Values:

10

County

string

Optional

County of MSR Valid Values:0-9 Format:XXXXX Example:54789

Allowable Values:

40

Country

string

Mandatory

Country Name of the MSR address Example:USA

Allowable Values:

5

CustomerID

string

Mandatory

This Tag reflects the customer ID

Allowable Values:

100

CompanyName

string

Mandatory

Company Name

Allowable Values:

50

FirstName

string

Mandatory

Card holder's First name. Valid Values:A-Z Example:User

Allowable Values:

50

LastName

string

Mandatory

Card holder's Last name. Valid Values:A-Z Example:Smith

Allowable Values:

50

Position

string

Optional

Employement position of the card holder Valid Values:A-Z,0-9 Example:Manager

BillingCycle

string

Mandatory

Biiling cycle Valid Values:Monthly1 - Monthly28 Example:Monthly10

Allowable Values:

9

MerchantCategory

string

Optional

Merchant Category

Allowable Values:

200

ServiceDescription

string

Optional

Service Description

Allowable Values:

256

NetworkName

string

Optional

Name of Network from which Merchant needed to be associated

Allowable Values:

50

NetworkID

int64

Optional

NetworkID of Network from which Merchant needed to be associated Valid Values:0-9 Format:XXXXXXXXXXXX Example:547896865689

MTAcode

string

Optional

MTA Code will determine if Transaction Authorization is required for the Purchase posted under this Merchant or not Valid Values:"0000" – MTA not applicable, "3000" – MTA Applicable default value should be 0000 Format:XXXX Example:0000

Allowable Values:

4
Sample request body 
{
  "Source": "Web",
  "IPAddress": "10.120.0.0",
  "DateFormat": null,
  "CurrencyCode": null,
  "CurrencySymbolType": null,
  "Language": null,
  "ExternalIP": "10.120.0.0",
  "SessionID": null,
  "APIVersion": "2.0",
  "CallerID": null,
  "CalledID": null,
  "RequestTime": null,
  "MSRLevel": null,
  "MSRNumber": null,
  "ParentMSRNumber": null,
  "MSRName": null,
  "MerchantDescription": null,
  "ContactType": null,
  "MerchantState": null,
  "MSRNumber1": null,
  "MSRNumber2": null,
  "MSRNumber3": null,
  "MSRFaxNumber": null,
  "MSREmail1": null,
  "MSREmail2": null,
  "MSRLegalEntityName": null,
  "MSRDBAName": null,
  "MSRTaxIdentificationNumber": null,
  "MSRReserveTable": null,
  "MSRACHRoutingNumber": null,
  "MSRACHCheckingAccnum": null,
  "MSRACHAccName": null,
  "MSRTermOverrideInd": null,
  "MSROverrideFeeRate": null,
  "MSROverrideReserveRate": null,
  "MSRCreditFirstName": null,
  "MSRCreditLastName": null,
  "MSRCreditWorkPhone": null,
  "MSRCreditMobilePhone": null,
  "MSRCreditEmail1": null,
  "MSRAccountingFirstName": null,
  "MSRAccountingLastName": null,
  "MSRAccountingWorkPhone": null,
  "MSRAccountingMobilePhone": null,
  "MSRAccountingEmail1": null,
  "MSRSalesFirstName": null,
  "MSRSalesLastName": null,
  "MSRSalesWorkPhone": null,
  "MSRSalesMobilePhone": null,
  "MSRSalesEmail1": null,
  "MSRSponserID": null,
  "MSRArrangementID": null,
  "MSRAccountManagerFirstName": null,
  "MSRAccountManagerLastName": null,
  "ParentMSRSalesFirstName": null,
  "ParentMSRSalesLastName": null,
  "MSRExternalCustomerID": null,
  "MSRExternalID": null,
  "MSRPIN": null,
  "MSREnrollmentDate": null,
  "MSRCreditLimitInd": null,
  "MSRCreditLimitMaxAmount": null,
  "MSRDirectBatchInd": null,
  "MSRApplicationTypeOverride": null,
  "MSRFeeWaiver": null,
  "MSRFeeDays": null,
  "MSRBillingFrequency": null,
  "MSRGSDInd": null,
  "MSRExternalInd": null,
  "MSRExtCompanyID": null,
  "MSRConsumerDirectOptIn": null,
  "MSRMemail2": null,
  "MSRContactPhone": null,
  "MSRServiceAreaAddLine1": null,
  "MSRServiceAreaAddLine2": null,
  "MSRServiceAreaCity": null,
  "MSRServiceAreaState": null,
  "MSRServiceAreaZip": null,
  "MSRServiceWebsite": null,
  "MSRServiceAreaRadius": null,
  "MSRServiceLocationLongitude": null,
  "MSRServiceLocationLatitude": null,
  "MSRLogoID": null,
  "MSRServiceLocationPoint": null,
  "MSRServiceLocationRadiusMiles": null,
  "MSRProgram": null,
  "MSRVersion": null,
  "MSRSettlementLevel": 0,
  "MSRPolicyIdentifier": null,
  "MSRHighLinePolicy": null,
  "MSRLineAssignmentPolicy": null,
  "MSRWebServicesPassword": null,
  "MSRCreationDate": null,
  "MSRSplitFee": null,
  "MSRTemplateID": null,
  "InstitutionID": null,
  "AddressLine1": null,
  "AddressLine2": null,
  "City": null,
  "PostalCode": null,
  "County": null,
  "Country": null,
  "CustomerID": null,
  "CompanyName": null,
  "FirstName": null,
  "LastName": null,
  "Position": null,
  "BillingCycle": null,
  "MerchantCategory": null,
  "ServiceDescription": null,
  "NetworkName": null,
  "NetworkID": null,
  "MTAcode": null
}
Response fields detail
Fields Description

ResponseID

string

This number will ensure that API hit our internal servers. This will always be unique. It can also be null when API is returned from our external servers example – If we pass blank User Id and Password in input then this will be null. This ID can be used for tracking purpose of any request hit the corecard internal servers. Example:12365478

Allowable Values:

15

Sample response body 

{
  "application/json": {
    "Message": "Request processed successfully.",
    "Status": true,
    "ErrorCode": "ERR01155",
    "ResponseData": {
      "ResponseID": "65687878"
    }
  }
}

Get MSR

Action: POST

Endpoint: /api/CoreCredit/MerchantManagement/GetMSR

POST /api/CoreCredit/MerchantManagement/GetMSR

Use this API to retrieve information about a specific merchant, store, or register within an Institution or a specific merchant, store, or register and all associated hierarchies within it.

Request fields detail
Fields Description

Source

string

Source of API Consumer For external system expected sources will be WEB.

Allowable Values:

50

IPAddress

string

Optional

IP Address of Client / Application Hosting Server Example: 10.206.0.204

Allowable Values:

15

DateFormat

string

Optional

Place Holder for Future Use. Values are: 1 : MM/dd/yyyy HH:MM:SS (Default) 2 : MM/dd/yy HH:MM:SS 3 : dd/MM/yyyy HH:MM:SS

Allowable Values:

25

CurrencyCode

string

Optional

Currency Code Place Holder for Future Use. Valid Values: Refer Appendix Section - Currency Code Example:840 = US Dollar Condition:If no value is passed, default value = 840

Allowable Values:

10

CurrencySymbolType

string

Optional

Place Holder for Future Use. CurrencySymbolType: 1: Currency Sign like $ 2: 3 ALPHA Currency Code like USD

Allowable Values:

10

Language

string

Optional

Place Holder for Future Use. Language: en: means use English Default: en - English

Allowable Values:

10

ExternalIP

string

IP Address of end user of API

Allowable Values:

50

SessionID

string

Optional

Session identifier of the API Example: 000028;026;1349906692

Allowable Values:

100

APIVersion

string

Version of the API to be invoked. Example: 2.0 API Version Current Version 2.0

Allowable Values:

10

CallerID

string

Optional

Caller ID of source from where API is initiated it is End User Caller ID Example: 7204454214 (phone number applicable in Case of IVR)

Allowable Values:

20

CalledID

string

Optional

Called ID of destination for which API is initiated It is Destination Called ID Example: 7314145404 (phone number applicable in Case of IVR)

Allowable Values:

20

RequestTime

datetime

Optional

Request Date Time of API Format: MM/dd/yyyy HH:mm:ss Example:01/15/2020 10:05:23

InstitutionID

integer

Mandatory

Unique identification number for Institution. Example:Fixed value needs to pass which is provided by Corecard.

MSRLevel

string

Mandatory

Type of Account to be created Valid Values: 0 = Merchant,1 = Store,2 = Register Example:1

Allowable Values:

1

MSRNumber

string

Mandatory

Identifier for Merchant/Store/Register Account to be created Valid Values:A-Z, 0-9

Allowable Values:

12

GetSubTree

string

Optional

GetSubTree Possible Values 0: No(default) To get only Matching Store/Merchant/Registers 1: Yes, To get All Stores, Merchants, Registers under the merchant.Will display all Store and register hierarchy.

Allowable Values:

5
Sample request body 
{
  "Source": "Web",
  "IPAddress": "10.120.0.0",
  "DateFormat": null,
  "CurrencyCode": null,
  "CurrencySymbolType": null,
  "Language": null,
  "ExternalIP": "10.120.0.0",
  "SessionID": null,
  "APIVersion": "2.0",
  "CallerID": null,
  "CalledID": null,
  "RequestTime": null,
  "InstitutionID": null,
  "MSRLevel": null,
  "MSRNumber": null,
  "GetSubTree": null
}
Response fields detail
Fields Description

ResponseID

string

This number will ensure that API hit our internal servers. This will always be unique. It can also be null when API is returned from our external servers example – If we pass blank User Id and Password in input then this will be null. This ID can be used for tracking purpose of any request hit the corecard internal servers. Example:12365478

Allowable Values:

15

MSRList

array

List Containing matching records

Sample response body 

{
  "application/json": {
    "Message": "Request processed successfully.",
    "Status": true,
    "ErrorCode": "ERR01155",
    "ResponseData": {
      "ResponseID": "65687878",
      "MSRList": [
        {
          "InstitutionID": null,
          "ParentMSRNumber": null,
          "MSRLevel": null,
          "MSRNumber": null,
          "MSRName": null,
          "MerchantDescription": null,
          "MerchantRateTable": null,
          "BillingCycle": null,
          "MerchantReserveTable": null,
          "ContactType": null,
          "FirstName": null,
          "LastName": null,
          "AddressLine1": null,
          "AddressLine2": null,
          "City": null,
          "State": null,
          "PostalCode": null,
          "County": null,
          "Country": null,
          "CustomerID": null,
          "MSRNumber1": null,
          "MSRNumber2": null,
          "MSRNumber3": null,
          "MSRFaxNumber": null,
          "MSREmail1": null,
          "MSREmail2": null,
          "MSRLegalEntityName": null,
          "MSRDBAName": null,
          "CompanyName": null,
          "Position": null,
          "MSRTaxIdentificationNumber": null,
          "MSRACHRoutingNumber": null,
          "MSRACHCheckingAccnum": null,
          "MSRACHAccName": null,
          "LastUpdateDate": null,
          "LastUpdateUserID": null,
          "MSRTermOverrideInd": null,
          "MSRWebServicesPassword": null,
          "MSRCreationDate": null,
          "MSROverrideFeeRate": null,
          "MSROverrideReserveRate": null,
          "MSRCreditFirstName": null,
          "MSRCreditLastName": null,
          "MSRCreditWorkPhone": null,
          "MSRCreditMobilePhone": null,
          "MSRCreditEmail1": null,
          "MSRAccountingFirstName": null,
          "MSRAccountingLastName": null,
          "MSRAccountingWorkPhone": null,
          "MSRAccountingMobilePhone": null,
          "MSRAccountingEmail1": null,
          "MSRSalesFirstName": null,
          "MSRSalesLastName": null,
          "MSRSalesWorkPhone": null,
          "MSRSalesMobilePhone": null,
          "MSRSalesEmail1": null,
          "MSRSponserID": null,
          "MSRArrangementID": null,
          "MSRAccountManagerFirstName": null,
          "MSRAccountManagerLastName": null,
          "ParentMSRSalesFirstName": null,
          "ParentMSRSalesLastName": null,
          "MSRExternalID": null,
          "MSRExternalCustomerID": null,
          "MSRPIN": null,
          "MSREnrollmentDate": null,
          "MerchantCategory": null,
          "MSRCreditLimitInd": null,
          "MSRCreditLimitMaxAmount": null,
          "MSRDirectBatchInd": null,
          "MSRApplicationTypeOverride": null,
          "MSRFeeWaiver": null,
          "MSRFeeDays": null,
          "MSRBillingFrequency": null,
          "MSRGSDInd": null,
          "MSRExternalInd": null,
          "MSRExtCompanyID": null,
          "MSRConsumerDirectOptIn": null,
          "MSRMemail2": null,
          "MSRContactPhone": null,
          "MSRServiceAreaAddLine1": null,
          "MSRServiceAreaAddLine2": null,
          "MSRServiceAreaCity": null,
          "MSRServiceAreaState": null,
          "MSRServiceAreaZip": null,
          "ServiceDescription": null,
          "MSRServiceWebsite": null,
          "MSRServiceAreaRadius": null,
          "MSRServiceLocationLongitude": null,
          "MSRServiceLocationLatitude": null,
          "MSRLogoID": null,
          "MSRServiceLocationPoint": null,
          "MSRServiceLocationRadiusMiles": null,
          "MSRProgram": null,
          "MSRVersion": null,
          "MSRSettlementLevel": 0,
          "MSRPolicyIdentifier": null,
          "MSRHighLinePolicy": null,
          "MSRLineAssignmentPolicy": null,
          "NetworkID": null,
          "NetworkName": null,
          "MSRSplitFee": null
        }
      ]
    }
  }
}

Get MSR Balances

Action: POST

Endpoint: /api/CoreCredit/MerchantManagement/GetMSRBalances

POST /api/CoreCredit/MerchantManagement/GetMSRBalances

Use this API to get all the balances of merchant, store, and register such as total sales volume, total sales amount, daily, weekly, monthly, yearly gross amount etc. other details along with merchant name and merchant number.

Request fields detail
Fields Description

Source

string

Source of API Consumer For external system expected sources will be WEB.

Allowable Values:

50

IPAddress

string

Optional

IP Address of Client / Application Hosting Server Example: 10.206.0.204

Allowable Values:

15

DateFormat

string

Optional

Place Holder for Future Use. Values are: 1 : MM/dd/yyyy HH:MM:SS (Default) 2 : MM/dd/yy HH:MM:SS 3 : dd/MM/yyyy HH:MM:SS

Allowable Values:

25

CurrencyCode

string

Optional

Place Holder for Future Use. Currency Code Ex. 840 = US Doller.

Allowable Values:

10

CurrencySymbolType

string

Optional

Place Holder for Future Use. CurrencySymbolType: 1: Currency Sign like $ 2: 3 ALPHA Currency Code like USD

Allowable Values:

10

Language

string

Optional

Place Holder for Future Use. Language == en: means use English ---- es: means Spanish

Allowable Values:

10

ExternalIP

string

IP Address of end user of API

Allowable Values:

50

SessionID

string

Optional

Session identifier of the API Example: 000028;026;1349906692

Allowable Values:

100

APIVersion

string

Version of the API to be invoked. Example: 2.0 API Version Current Version 2.0

CallerID

string

Optional

Caller ID of source from where API is initiated it is End User Caller ID Example: 7204454214 (phone number applicable in Case of IVR)

Allowable Values:

20

CalledID

string

Optional

Called ID of destination for which API is initiated It is Destination Called ID Example: 7314145404 (phone number applicable in Case of IVR)

Allowable Values:

20

RequestTime

datetime

Optional

Request Date Time of API Format: MM/dd/yyyy HH:mm:ss Example:01/15/2020 10:05:23

MSRNumber

string

Mandatory

Description - Identifier for Merchant/Store/Register Account to be created Valid Values: 0-9 Format: XXXX Example: 562489

Allowable Values:

12

MSRLevel

integer

Description - Type of Account to be created Valid Values: 0: Merchant, 1: Store 2: Register Format: XXXXXX Example: 1

Source

string

Source of API Consumer For external system expected sources will be WEB.

Allowable Values:

50

IPAddress

string

Optional

IP Address of Client / Application Hosting Server Example: 10.206.0.204

Allowable Values:

15

DateFormat

string

Optional

Place Holder for Future Use. Values are: 1 : MM/dd/yyyy HH:MM:SS (Default) 2 : MM/dd/yy HH:MM:SS 3 : dd/MM/yyyy HH:MM:SS

Allowable Values:

25

CurrencyCode

string

Optional

Currency Code Place Holder for Future Use. Valid Values: Refer Appendix Section - Currency Code Example:840 = US Dollar Condition:If no value is passed, default value = 840

Allowable Values:

10

CurrencySymbolType

string

Optional

Place Holder for Future Use. CurrencySymbolType: 1: Currency Sign like $ 2: 3 ALPHA Currency Code like USD

Allowable Values:

10

Language

string

Optional

Place Holder for Future Use. Language: en: means use English Default: en - English

Allowable Values:

10

ExternalIP

string

IP Address of end user of API

Allowable Values:

50

SessionID

string

Optional

Session identifier of the API Example: 000028;026;1349906692

Allowable Values:

100

APIVersion

string

Version of the API to be invoked. Example: 2.0 API Version Current Version 2.0

Allowable Values:

10

CallerID

string

Optional

Caller ID of source from where API is initiated it is End User Caller ID Example: 7204454214 (phone number applicable in Case of IVR)

Allowable Values:

20

CalledID

string

Optional

Called ID of destination for which API is initiated It is Destination Called ID Example: 7314145404 (phone number applicable in Case of IVR)

Allowable Values:

20

RequestTime

datetime

Optional

Request Date Time of API Format: MM/dd/yyyy HH:mm:ss Example:01/15/2020 10:05:23

MSRNumber

string

Mandatory

Identifier for Merchant/Store/Register Account to be created Valid Values: 0-9 Format: XXXX Example: 562489

Allowable Values:

12

MSRLevel

integer

Type of Account to be created Valid Values: 0: Merchant, 1: Store 2: Register Format: XXXXXX Example: 1
Sample request body 
{
  "Source": "Web",
  "IPAddress": null,
  "DateFormat": null,
  "CurrencyCode": null,
  "CurrencySymbolType": null,
  "Language": null,
  "ExternalIP": "10.205.0.56",
  "SessionID": null,
  "APIVersion": "2.0",
  "CallerID": null,
  "CalledID": null,
  "RequestTime": null,
  "MSRNumber": "8831",
  "MSRLevel": 1
}
Response fields detail
Fields Description

Account

MerchantPLAccountModel

Account

MerchantPLAccountModel

Sample response body 

{
  "application/json": {
    "Message": "Success",
    "Status": true,
    "ErrorCode": "Err00017",
    "ResponseData": {
      "Account": {
        "MerchantID": 11639,
        "InstitutionID": 3235,
        "InstitutionName": "ABC, LLC",
        "MerchantName": "Merchant 6",
        "StoreName": null,
        "RegisterName": null,
        "MerchantDescription": "Desc",
        "MerchantNumber": "666666666",
        "NetworkName": null,
        "NetworkID": 0,
        "SplitFee": null,
        "TemplateName": null,
        "ProductMapping": "ABC Product",
        "SinceBillBalanceBroughtForward": 0.0,
        "SinceBillAdjustments": 0.0,
        "TotalNumberOfAccounts": 0,
        "AtLastBillPreviousBalance": 0.0,
        "SinceBillPreviousBalance": 0.0,
        "AtLastBillInStorePayments": 0.0,
        "SinceBillInStorePayments": 0.0,
        "AtLastBillDirectPayments": 0.0,
        "SinceBillDirectPayments": 0.0,
        "AtLastBillReturns": 0.0,
        "SinceBillReturns": 0.0,
        "AtLastBillSales": 0.0,
        "SinceBillSales": 0.0,
        "AtLastBillFinanceCharge": 0.0,
        "SinceBillFinanceCharge": 0.0,
        "AtLastBillNSFFees": 0.0,
        "SinceBillNSFFees": 0.0,
        "AtLastBillNSFFeeCredits": 0.0,
        "SinceBillNSFFeeCredits": 0.0,
        "AtLastBillOtherDebits": 0.0,
        "SinceBillOtherDebits": 0.0,
        "AtLastBillOtherCredits": 0.0,
        "SinceBillOtherCredits": 0.0,
        "AtLastBillInStoreOtherCredits": 0.0,
        "SinceBillInStoreOtherCredits": 0.0,
        "AtLastBillInStoreOtherDebits": 0.0,
        "SinceBillInStoreOtherDebits": 0.0,
        "AtLastBillNetOutstanding": 0.0,
        "SinceBillNetOutstanding": 0.0,
        "WeeklySalesCount": 0,
        "WeeklySalesAmount": 0.0,
        "WeeklyReturnsCount": 0,
        "WeeklyReturnsAmount": 0.0,
        "WeeklyDirectPaymentsCount": 0,
        "WeeklyDirectPaymentsAmount": 0.0,
        "WeeklyInStorePaymentsCount": 0,
        "WeeklyInStorePaymentsAmount": 0.0,
        "WeeklyTotalPaymentsCount": 0,
        "WeeklyTotalPaymentsAmount": 0.0,
        "WeeklyGrossVolumeCount": 0,
        "WeeklyGrossVolumeAmount": 0.0,
        "WeeklyNetVolumeCount": 0,
        "WeeklyNetVolumeAmount": 0.0,
        "WeeklyDiscount": 0.0,
        "MonthlyActiveAccounts": 0,
        "MonthlyActiveAccountsLastCycle": 0,
        "MonthlyAccountsFee": 0.0,
        "MonthlyCurrentReserve": 0.0,
        "MonthlyPreviousReserve": 0.0,
        "MonthlyMerchantFee": 0.0,
        "MonthlyPrimeRateAdjustment": 0.0,
        "MonthlyOtherCharges": 0.0,
        "MonthlyOutstandingBalanceAccounts": 0.0,
        "SettlementAmount": 0.0,
        "PreviousSettlementAmount": 0.0,
        "DisputeAmount": 0.0,
        "DisputeCount": 0,
        "DailySalesCount": 0,
        "DailySalesAmount": 0.0,
        "DailyReturnsCount": 0,
        "DailyReturnsAmount": 0.0,
        "DailyDirectPaymentsCount": 0,
        "DailyDirectPaymentsAmount": 0.0,
        "DailyInStorePaymentsCount": 0,
        "DailyInStorePaymentsAmount": 0.0,
        "DailyTotalPaymentsCount": 0,
        "DailyTotalPaymentsAmount": 0.0,
        "DailyGrossVolumeCount": 0,
        "DailyGrossVolumeAmount": 0.0,
        "DailyNetVolumeCount": 0,
        "DailyNetVolumeAmount": 0.0,
        "DailyNSFFees": 0.0,
        "DailyNSFFeeCredits": 0.0,
        "DailyOtherCredits": 0.0,
        "DailyOtherDebits": 0.0,
        "DailyDiscount": 0.0,
        "YearlySalesCount": 0,
        "YearlySalesAmount": 0.0,
        "YearlyReturnsCount": 0,
        "YearlyReturnsAmount": 0.0,
        "YearlyDirectPaymentsCount": 0,
        "YearlyDirectPaymentsAmount": 0.0,
        "YearlyInStorePaymentsCount": 0,
        "YearlyInStorePaymentsAmount": 0.0,
        "YearlyTotalPaymentsCount": 0,
        "YearlyTotalPaymentsAmount": 0.0,
        "YearlyDisputesCount": 0,
        "YearlyDisputesAmount": 0.0,
        "YearlyGrossVolumeCount": 0,
        "YearlyGrossVolumeAmount": 0.0,
        "YearlyNetVolumeCount": 0,
        "YearlyNetVolumeAmount": 0.0,
        "YearlyFinanceCharge": 0.0,
        "YearlyNSFFeeCredits": 0.0,
        "YearlyNSFFees": 0.0,
        "YearlyOtherDebits": 0.0,
        "YearlyOtherCredits": 0.0,
        "YearlyDiscount": 0.0,
        "YearlyBaseFee": 0.0,
        "YearlyAccountsFee": 0.0,
        "YearlyPrimeRateAdjustment": 0.0,
        "YearlyMerchantFee": 0.0,
        "YearlySettlementAmount": 0.0,
        "YearlyOtherCharges": 0.0,
        "LifetimeSalesCount": 0,
        "LifetimeSalesAmount": 0.0,
        "LifetimeReturnsCount": 0,
        "LifetimeReturnsAmount": 0.0,
        "LifetimeDirectPaymentsCount": 0,
        "LifetimeDirectPaymentsAmount": 0.0,
        "LifetimeInStorePaymentsCount": 0,
        "LifetimeInStorePaymentsAmount": 0.0,
        "LifetimeTotalPaymentsCount": 0,
        "LifetimeTotalPaymentsAmount": 0.0,
        "LifetimeDisputesCount": 0,
        "LifetimeDisputesAmount": 0.0,
        "LifetimeGrossVolumeCount": 0,
        "LifetimeGrossVolumeAmount": 0.0,
        "LifetimeNetVolumeCount": 0,
        "LifetimeNetVolumeAmount": 0.0,
        "LifetimeFinanceCharge": 0.0,
        "LifetimeNSFFees": 0.0,
        "LifetimeNSFFeeCredits": 0.0,
        "LifetimeOtherDebits": 0.0,
        "LifetimeOtherCredits": 0.0,
        "LifetimeDiscount": 0.0,
        "LifetimeBaseFee": 0.0,
        "LifetimeAccountsFee": 0.0,
        "LifetimePrimeRateAdjustment": 0.0,
        "LifetimeMerchantFee": 0.0,
        "LifetimeSettlementAmount": 0.0,
        "LifetimeOtherCharges": 0.0,
        "DelinquencyTotalDue": 0.0,
        "DelinquencyCurrentDue": 0.0,
        "DelinquencyPastDue": 0.0,
        "DelinquencyOneCyclePastDue": 0.0,
        "DelinquencyTwoCyclesPastDue": 0.0,
        "DelinquencyThreeCyclesPastDue": 0.0,
        "DelinquencyFourCyclesPastDue": 0.0,
        "DelinquencyFiveCyclesPastDue": 0.0,
        "DelinquencySixCyclesPastDue": 0.0,
        "DelinquencySevenCyclesPastDue": 0.0,
        "DelinquencyTotalPastDue": 0.0,
        "MPLMerchantStatus": 1000,
        "PolicyIdentifier": "Grandfathered",
        "LineAssignedPolicy": "Grandfathered",
        "IsChildFlag": 0,
        "MPLMerchantStatusName": null
      }
    }
  }
}