Core Card Api Quick Start

Create MSR

Action: POST

Endpoint: /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 details

Fields	Description
Source string Mandatory	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 Mandatory	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 Mandatory	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 Optional	Type of Account to be created Valid Values: 0 = Merchant,1 = Store,2 = Register Example:1 Allowable Values: 1
MSRNumber string Optional	Identifier for Merchant/Store/Register Account to be created Valid Values:A-Z, 0-9 Allowable Values: 9
ParentMSRNumber string Optional	Identifier for Parent account under which Merchant/Store/Register Account to be created. Valid Values:A-Z,0-9 Allowable Values: 9
MSRName string Optional	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 Optional	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 Optional	Unique identification number for Institution. Example:Fixed value needs to pass which is provided by Corecard.
AddressLine1 string Optional	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 Optional	City Name of the MSR address Example:Los Angeles Allowable Values: 25
PostalCode string Optional	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 Optional	Country Name of the MSR address Example:USA Allowable Values: 5
CustomerID string Optional	This Tag reflects the customer ID Allowable Values: 100
CompanyName string Optional	Company Name Allowable Values: 50
FirstName string Optional	Card holder's First name. Valid Values:A-Z Example:User Allowable Values: 50
LastName string Optional	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 Optional	Biiling cycle Valid Values: Refer Appendix Section 5.13 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
MerchantLogo string Optional	File Name for the Logo File Valid Values:0-1 A-Z Format:XXXX Example:LogoFile1 Allowable Values: 50
TimeToContactFrom string Optional	Time To Contact From Valid Values:0-1 Format:XXXXXX Example:083045 Allowable Values: 25
TimeToContactTo string Optional	Time To Contact To Valid Values:0-1 Format:XXXXXX Example:063322 Allowable Values: 25
SiteURL string Optional	URL of the site Valid Values:0-1 A-Z Format:XXXX Example:mysite.com/card Allowable Values: 50
Motto string Optional	Motto Valid Values:0-1 A-Z Format:XXXX Example:Be Independent Allowable Values: 30
CardActivationURL string Optional	Card Activation URL Valid Values:0-1 A-Z Format:XXXX Example:mysite.com/card/activation Allowable Values: 50
Disclosure string Optional	Disclosure Valid Values:0-1 A-Z Format:XXXX Example:Disclosure Text Allowable Values: 1500
WeekDayHours string Optional	Description: Weekday hours Valid Values:0-9, a-z Example:Weekdays 6 AM to 7 PM PST Allowable Values: 40
WeekendHours string Optional	Description: Weekend hours Valid Values:0-9, a-z Example:Saturday 7 AM to 12 PM PST Allowable Values: 40
CardActivationSiteURL string Optional	Card Activation URL Valid Values:0-1 A-Z Format:XXXX Example:mysite.com/card/activation Allowable Values: 50
CardDescription string Optional	Description of the Card Valid Values:0-1 A-Z Example: Platinum Card Allowable Values: 50
NameOnCard string Optional	Name on the Card Valid Values:0-1 A-Z Example: John Smith Allowable Values: 50
ContactNumber string Optional	Contact Number of the Distribution Partner Valid Values: 0-1 Example: 02245879654 Allowable Values: 11
Tran_CompanyID string Optional	Unique ID of Company Valid Values: 0-9 Example: 1234 Allowable Values: 200
Tran_CompanyName string Optional	Company Name Valid Values: A-Z Example: abc Allowable Values: 50

Fields

Description

Source

string

Mandatory

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

Allowable Values:

IPAddress

string

Optional

IP Address of Client / Application Hosting Server Example: 10.206.0.204

Allowable Values:

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:

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:

CurrencySymbolType

string

Optional

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

Allowable Values:

Language

string

Optional

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

Allowable Values:

ExternalIP

string

Mandatory

IP Address of end user of API

Allowable Values:

SessionID

string

Optional

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

Allowable Values:

100

APIVersion

string

Mandatory

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

Allowable Values:

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:

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:

RequestTime

datetime

Optional

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

MSRLevel

string

Optional

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

Allowable Values:

MSRNumber

string

Optional

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

Allowable Values:

ParentMSRNumber

string

Optional

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

Allowable Values:

MSRName

string

Optional

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:

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:

MerchantState

string

Optional

Merchantâ€™s State Valid Values:A-Z,0-9 Example:Alabama

Allowable Values:

MSRNumber1

string

Optional

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

Allowable Values:

MSRNumber2

string

Optional

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

Allowable Values:

MSRNumber3

string

Optional

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

Allowable Values:

MSRFaxNumber

string

Optional

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

Allowable Values:

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:

MSRDBAName

string

Optional

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

Allowable Values:

MSRTaxIdentificationNumber

string

Optional

Organizationâ€™s Tax Id Number Valid Values:0-9 Format:XXXXXXXXXXXX Example:547896865689

Allowable Values:

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:

MSRACHCheckingAccnum

string

Conditional

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

Allowable Values:

MSRACHAccName

string

Conditional

Account Name Condition:Required when SettlementLevel = 0

Allowable Values:

100

MSRTermOverrideInd

string

Optional

Merchant TermOverride Indicator

Allowable Values:

MSROverrideFeeRate

decimal

Optional

Override Fee Rate

MSROverrideReserveRate

decimal

Optional

Override Reserve Rate

MSRCreditFirstName

string

Optional

Credit First Name

Allowable Values:

MSRCreditLastName

string

Optional

Credit Last Name

Allowable Values:

MSRCreditWorkPhone

string

Optional

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

Allowable Values:

MSRCreditMobilePhone

string

Optional

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

Allowable Values:

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:

MSRAccountingLastName

string

Optional

Accounting Last Name

Allowable Values:

MSRAccountingWorkPhone

string

Optional

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

Allowable Values:

MSRAccountingMobilePhone

string

Optional

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

Allowable Values:

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:

MSRSalesLastName

string

Optional

Sales Last Name

Allowable Values:

MSRSalesWorkPhone

string

Optional

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

Allowable Values:

MSRSalesMobilePhone

string

Optional

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

Allowable Values:

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:

MSRAccountManagerLastName

string

Optional

Account Manager Last Name

Allowable Values:

ParentMSRSalesFirstName

string

Optional

Parent Merchant Sales First Name

Allowable Values:

ParentMSRSalesLastName

string

Optional

Parent Merchant Sales Last Name

Allowable Values:

MSRExternalCustomerID

string

Optional

External CustomerID

Allowable Values:

200

MSRExternalID

string

Optional

External MerchantID

Allowable Values:

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:

MSRCreditLimitMaxAmount

decimal

Optional

Credit Limit Max Amount

MSRDirectBatchInd

string

Optional

Direct Batch Indicator

Allowable Values:

MSRApplicationTypeOverride

string

Optional

Application Type Override

Allowable Values:

MSRFeeWaiver

string

Optional

Fee Waiver

Allowable Values:

MSRFeeDays

string

Optional

Fee Days

Allowable Values:

200

MSRBillingFrequency

string

Optional

Billing Frequency

Allowable Values:

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:

MSRServiceAreaAddLine1

string

Optional

Service Area Address Line1

Allowable Values:

MSRServiceAreaAddLine2

string

Optional

Service Area Address Line2

Allowable Values:

MSRServiceAreaCity

string

Optional

Service Area City

Allowable Values:

MSRServiceAreaState

string

Optional

Service Area State

Allowable Values:

MSRServiceAreaZip

string

Optional

Service Area Zip

Allowable Values:

MSRServiceWebsite

string

Optional

Service Website

Allowable Values:

300

MSRServiceAreaRadius

string

Optional

Service Area Radius

Allowable Values:

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:

MSRProgram

string

Optional

Program (ProductName)

Allowable Values:

100

MSRVersion

string

Optional

Version

Allowable Values:

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:

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:

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:

MSRTemplateID

string

Optional

TemplateID of Merchant Offering Template. Example:MOT1001

Allowable Values:

100

InstitutionID

integer

Optional

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

AddressLine1

string

Optional

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

Allowable Values:

AddressLine2

string

Optional

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

Allowable Values:

City

string

Optional

City Name of the MSR address Example:Los Angeles

Allowable Values:

PostalCode

string

Optional

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

Allowable Values:

County

string

Optional

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

Allowable Values:

Country

string

Optional

Country Name of the MSR address Example:USA

Allowable Values:

CustomerID

string

Optional

This Tag reflects the customer ID

Allowable Values:

100

CompanyName

string

Optional

Company Name

Allowable Values:

FirstName

string

Optional

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

Allowable Values:

LastName

string

Optional

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

Allowable Values:

Position

string

Optional

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

BillingCycle

string

Optional

Biiling cycle Valid Values: Refer Appendix Section 5.13 Example:Monthly10

Allowable Values:

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:

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:

MerchantLogo

string

Optional

File Name for the Logo File Valid Values:0-1 A-Z Format:XXXX Example:LogoFile1

Allowable Values:

TimeToContactFrom

string

Optional

Time To Contact From Valid Values:0-1 Format:XXXXXX Example:083045

Allowable Values:

TimeToContactTo

string

Optional

Time To Contact To Valid Values:0-1 Format:XXXXXX Example:063322

Allowable Values:

SiteURL

string

Optional

URL of the site Valid Values:0-1 A-Z Format:XXXX Example:mysite.com/card

Allowable Values:

Motto

string

Optional

Motto Valid Values:0-1 A-Z Format:XXXX Example:Be Independent

Allowable Values:

CardActivationURL

string

Optional

Card Activation URL Valid Values:0-1 A-Z Format:XXXX Example:mysite.com/card/activation

Allowable Values:

Disclosure

string

Optional

Disclosure Valid Values:0-1 A-Z Format:XXXX Example:Disclosure Text

Allowable Values:

1500

WeekDayHours

string

Optional

Description: Weekday hours Valid Values:0-9, a-z Example:Weekdays 6 AM to 7 PM PST

Allowable Values:

WeekendHours

string

Optional

Description: Weekend hours Valid Values:0-9, a-z Example:Saturday 7 AM to 12 PM PST

Allowable Values:

CardActivationSiteURL

string

Optional

Card Activation URL Valid Values:0-1 A-Z Format:XXXX Example:mysite.com/card/activation

Allowable Values:

CardDescription

string

Optional

Description of the Card Valid Values:0-1 A-Z Example: Platinum Card

Allowable Values:

NameOnCard

string

Optional

Name on the Card Valid Values:0-1 A-Z Example: John Smith

Allowable Values:

ContactNumber

string

Optional

Contact Number of the Distribution Partner Valid Values: 0-1 Example: 02245879654

Allowable Values:

Tran_CompanyID

string

Optional

Unique ID of Company Valid Values: 0-9 Example: 1234

Allowable Values:

200

Tran_CompanyName

string

Optional

Company Name Valid Values: A-Z Example: abc

Allowable Values:

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,
  "MerchantLogo": null,
  "WeekDayHours": null,
  "WeekendHours": null,
  "SiteURL": null,
  "Motto": null,
  "CardActivationSiteURL": null,
  "Disclosure": null,
  "CardDescription": null,
  "NameOnCard": null,
  "ContactNumber": null,
  "Tran_CompanyID": null,
  "Tran_CompanyName": null
}

Response fields details

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

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:

Sample response body

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