Core Card Api Quick Start

Update Merchant Account Parameter

Action: POST

Endpoint: /api/CoreCredit/MerchantManagement/UpdateMerchantAccountParameter

Use this API to update the configured parameters for a merchant account, such as billing cycle, statement form, and credit limit.

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
MerchantID integer Conditional	Unique number of merchant account Valid Values:0-9 Format:XXXXX Example:12345 Condition: Mandatory If MerchantNumber not Inputted in API Request
MerchantNumber string Conditional	Merchant Number which is assgined to a Merchant Valid Values:0-9 Format:XXXXX Example:205136549 Condition: Mandatory If MerchantNumber not Inputted in API Request
BillingCycle integer Optional	The Billing Cycle Assigned for the Merchant Valid Values: refer the Appendix section 5.13 Billing Cycle
StatementPrintingSequence integer Optional	Indicates in what Sequence/order the Statement must be Printed Valid Values: '0' = Account Number Order and '1' = ZIP Code Order Format: X Example: 0 Condition: If kept Blank Default Value will be considered as '0' = Account Number Order
StatementForm integer Optional	Indicates the Statement printed will be as a Form or Custom Made Valid Values: '0' = Form and '1' = Custom Format: X Example: 0
CreditLimitOTBDisplay integer Optional	Determines if the Credit Limit and OTB will be Displayed on Merchant Statement or Not. Valid Values: 0-Display on Statement 1-Do not display on Statement Format: X Example: 0 Condition: If kept Blank Default Value will be considered as '0' = Display on Statement
DefaultCreditLimit decimal Optional	Default Credit Limit Assigned for the Merchant Valid Values: 0-9 Format: XXX.XX Example: 1000.00
MSRPolicyIdentifier integer Optional	Credit Policy on the Merchant Valid Values: '1' = Grandfathered and '2' = Standard Format: X Example: 0 Condition: If kept Blank Default Value will be considered as '1' = Grandfathered
MSRLineAssignmentPolicy integer Optional	Line Assignment Policy on the Merchant Valid Values: '1' = Grandfathered and '2' = Standard Format: X Example: 0
ProductMapping string Mandatory	Determine the Products Mapped on the Merchant, Multiple Products can be mapped on the Merchant by Inputting Product IDs comma Seperated Check the Product IDs provided by CoreCARD Valid Values: 0-9 Format:XXXXXX, XXXXX Example: 12345, 5432 Allowable Values: 100
HoldAccountStatus1 integer Optional	Account with status set on the Field, the Statement generated for Account with this Status will be Sent to the Merchant and Not the Account Holder and such Accounts will be eligible of Reserve Calculation, Reserve Calculation conditon, the same status must be in the Included Status Field and also Add Unmailed to Reserve Filed must be set to Yes in Merchant Reserve Parameters Valid Values: Refer Appendix Section 5.21 Card/Account Statuses
HoldAccountStatus2 integer Optional	Account with status set on the Field, the Statement generated for Account with this Status will be Sent to the Merchant and Not the Account Holder and such Accounts will be eligible of Reserve Calculation, Reserve Calculation conditon, the same status must be in the Included Status Field and also Add Unmailed to Reserve Filed must be set to Yes in Merchant Reserve Parameters Valid Values: Refer Appendix Section 5.21 Card/Account Statuses
HoldAccountStatus3 integer Optional	Account with status set on the Field, the Statement generated for Account with this Status will be Sent to the Merchant and Not the Account Holder and such Accounts will be eligible of Reserve Calculation, Reserve Calculation conditon, the same status must be in the Included Status Field and also Add Unmailed to Reserve Filed must be set to Yes in Merchant Reserve Parameters Valid Values: Refer Appendix Section 5.21 Card/Account Statuses
HoldAccountStatus4 integer Optional	Account with status set on the Field, the Statement generated for Account with this Status will be Sent to the Merchant and Not the Account Holder and such Accounts will be eligible of Reserve Calculation, Reserve Calculation conditon, the same status must be in the Included Status Field and also Add Unmailed to Reserve Filed must be set to Yes in Merchant Reserve Parameters Valid Values: Refer Appendix Section 5.21 Card/Account Statuses
HoldCreditBalances integer Optional	If Set to Yes then if All account available under the Merchant with Negative Current Balance will be Eligible for Reserve calculations, Condition this field will be honoured for the Account only if the status of the Account is not in one of the HoldAccountStatus fields in Merchant Account Parameters and also in IncludedStatus fields in Merchant Reserve Parameters Valid Values: '0' = Yes and '1' = No Format: X Example: 0 Condition: If kept Blank Default Value will be considered as '0' = Yes
DebitBalancesUnder decimal Optional	If any Account has Current Balance Greater than 0 and Lower than the Amount set this field/tag, then it will be Eligible for Reserve calculations, Condition this field will be honoured if HoldCreditBalances is set to No and if the status of the Account is not in one of the HoldAccountStatus fields in Merchant Account Parameters and also in IncludedStatus fields in Merchant Reserve Parameters. Valid Values:0-9 Format: XXX.XX Example: 500.00
FromAccountNumber string Optional	If any Account Number falls between from This Account Number to Account Number set in ToAccountNumber, it will be eligible for Reserve calculations, Condition this field will be honoured if HoldCreditBalances is set to 'No' and if the status of the Account is not in one of the 'HoldAccountStatus' fields in Merchant Account Parameters and also in 'IncludedStatus' fields in Merchant Reserve Parameters Valid Values:0-9 Format: XXXXXXXXXXXXXXXXXXXX Example: 9000000111111222222333 Allowable Values: 19
ToAccountNumber string Optional	If any Account Number falls between the Account Number in FromAccountNUmber to Account Number set in ToAccountNumber, it will be eligible for Reserve calculations, Condition this field will be honoured if HoldCreditBalances is set to No and if the status of the Account is not in one of the HoldAccountStatus fields in Merchant Account Parameters and also in IncludedStatus fields in Merchant Reserve Parameters Valid Values:0-9 Format: XXXXXXXXXXXXXXXXXXXX Example: 90000001111112222 Allowable Values: 19
AccountNumberGenerationFlag integer Optional	If Set To Yes then Account Number will be Auto Generated for the Accounts Created Under this Merchant Valid Values: '0' = Yes and '1' = No Format: X Example: 0
AccountNumberBegin string Conditional	For internally-generated account numbers, this is the first account number that can be issued for this Merchant. This number is added to the number in the Increment By field to generate the first account number. Valid Values:0-9 Format: XXXXXXXXXXXXXXX Example: 0000000000001000 Condition:Required only if AccountNumberGenerationflag is Set to Yes Allowable Values: 19
AccountNumberEnd string Conditional	For internally-generated card numbers, this is the last account number that can be issued for this Merchant Valid Values:0-9 Format: XXXXXXXXXXXXXXX Example: 0000000000001000 Condition:Required only if AccountNumberGenerationflag is Set to Yes Allowable Values: 19
AccountNumberIncrementBy integer Conditional	The Begin Number is added to this number to generate the first account number. Subsequent account numbers are generated by adding the Last Used Account Number to this number. Condition:Required only if AccountNumberGenerationflag is Set to Yes
AccountNumberLastUsed string Conditional	The last generated account number displays in this field/Tag, which is used to generate the next account number by adding the value in the Increment By field to this number. Valid Values:0-9 Format: XXXXXXXXXXXXXXX Example: 0000000000001000 Condition:Required only if AccountNumberGenerationflag is Set to Yes Allowable Values: 19
AccountNumberCheckDigitRoutine integer Conditional	Determines the Modulous formula applied for Check Digit Routine Valid Values: '0'= Mod10, '1' = Mod11 and '2' = None Format: X Example: 2 Condition:Required only if AccountNumberGenerationflag is Set to Yes
IsForwardedToUCA boolean Optional	Field : MerchantPLAccounts.IsForwardedToUCA LookUp: CCardLookup; LutId = 'IsForwardedToUCA '
TransactionDescriptionMandatory boolean Optional	Field : MerchantPLAccounts.TransactionDescriptionMandatory
AccountActivationEnabled string Optional	Field : MerchantPLAccounts.AccountActivationEnabled
ExcludeFlashScreen string Optional	Field : MerchantPLAccounts.ExcludeFlashScreen
SuppressPrequalReminderMails boolean Optional	Field : MerchantPLAccounts.SuppressPrequalReminderMails LookUp: CCardLookup; LutId = 'SuppressPrequalReminderMails '
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	Contact Number of the Distribution Partner Valid Values:0-1 Format:XXXX Example:8:30 Allowable Values: 25
TimeToContactTo string Optional	Contact Number of the Distribution Partner Valid Values:0-1 Format:XXXX Example:6 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	Motto Valid Values:0-1 A-Z Format:XXXX Example:Be Independent Allowable Values: 30
Disclosure string Optional	Motto Valid Values:0-1 A-Z Format:XXXX Example:Be Independent Allowable Values: 30
ContactNumber string Optional	Contact Number of the Distribution Partner Valid Values:0-1 Format:XXXX Example:02245879654 Allowable Values: 11
WeekDayHours string Optional	Contact Number of the Distribution Partner Valid Values:0-1 Format:XXXX Example:8:30 Allowable Values: 40
WeekendHours string Optional	Contact Number of the Distribution Partner Valid Values:0-1 Format:XXXX Example:6 Allowable Values: 40
CardDescription string Optional	This field will be used to provide the description of the card Allowable Values: 30
DaystoDisplaySplashPage string Optional	DaystoDisplaySplashPage Valid Values:0-1 Format:XX Example:30 Allowable Values: 5
CompanyID string Optional	Will determine Unique ID of Company Valid Values:0-9 Example:1234 Allowable Values: 10
CompanyName string Optional	Company Name Valid Values:A-Z Example: abc Allowable Values: 16

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

MerchantID

integer

Conditional

Unique number of merchant account Valid Values:0-9 Format:XXXXX Example:12345 Condition: Mandatory If MerchantNumber not Inputted in API Request

MerchantNumber

string

Conditional

Merchant Number which is assgined to a Merchant Valid Values:0-9 Format:XXXXX Example:205136549 Condition: Mandatory If MerchantNumber not Inputted in API Request

BillingCycle

integer

Optional

The Billing Cycle Assigned for the Merchant Valid Values: refer the Appendix section 5.13 Billing Cycle

StatementPrintingSequence

integer

Optional

Indicates in what Sequence/order the Statement must be Printed Valid Values: '0' = Account Number Order and '1' = ZIP Code Order Format: X Example: 0 Condition: If kept Blank Default Value will be considered as '0' = Account Number Order

StatementForm

integer

Optional

Indicates the Statement printed will be as a Form or Custom Made Valid Values: '0' = Form and '1' = Custom Format: X Example: 0

CreditLimitOTBDisplay

integer

Optional

Determines if the Credit Limit and OTB will be Displayed on Merchant Statement or Not. Valid Values: 0-Display on Statement 1-Do not display on Statement Format: X Example: 0 Condition: If kept Blank Default Value will be considered as '0' = Display on Statement

DefaultCreditLimit

decimal

Optional

Default Credit Limit Assigned for the Merchant Valid Values: 0-9 Format: XXX.XX Example: 1000.00

MSRPolicyIdentifier

integer

Optional

Credit Policy on the Merchant Valid Values: '1' = Grandfathered and '2' = Standard Format: X Example: 0 Condition: If kept Blank Default Value will be considered as '1' = Grandfathered

MSRLineAssignmentPolicy

integer

Optional

Line Assignment Policy on the Merchant Valid Values: '1' = Grandfathered and '2' = Standard Format: X Example: 0

ProductMapping

string

Mandatory

Determine the Products Mapped on the Merchant, Multiple Products can be mapped on the Merchant by Inputting Product IDs comma Seperated Check the Product IDs provided by CoreCARD Valid Values: 0-9 Format:XXXXXX, XXXXX Example: 12345, 5432

Allowable Values:

100

HoldAccountStatus1

integer

Optional

Account with status set on the Field, the Statement generated for Account with this Status will be Sent to the Merchant and Not the Account Holder and such Accounts will be eligible of Reserve Calculation, Reserve Calculation conditon, the same status must be in the Included Status Field and also Add Unmailed to Reserve Filed must be set to Yes in Merchant Reserve Parameters Valid Values: Refer Appendix Section 5.21 Card/Account Statuses

HoldAccountStatus2

integer

Optional

HoldAccountStatus3

integer

Optional

HoldAccountStatus4

integer

Optional

HoldCreditBalances

integer

Optional

If Set to Yes then if All account available under the Merchant with Negative Current Balance will be Eligible for Reserve calculations, Condition this field will be honoured for the Account only if the status of the Account is not in one of the HoldAccountStatus fields in Merchant Account Parameters and also in IncludedStatus fields in Merchant Reserve Parameters Valid Values: '0' = Yes and '1' = No Format: X Example: 0 Condition: If kept Blank Default Value will be considered as '0' = Yes

DebitBalancesUnder

decimal

Optional

If any Account has Current Balance Greater than 0 and Lower than the Amount set this field/tag, then it will be Eligible for Reserve calculations, Condition this field will be honoured if HoldCreditBalances is set to No and if the status of the Account is not in one of the HoldAccountStatus fields in Merchant Account Parameters and also in IncludedStatus fields in Merchant Reserve Parameters. Valid Values:0-9 Format: XXX.XX Example: 500.00

FromAccountNumber

string

Optional

If any Account Number falls between from This Account Number to Account Number set in ToAccountNumber, it will be eligible for Reserve calculations, Condition this field will be honoured if HoldCreditBalances is set to 'No' and if the status of the Account is not in one of the 'HoldAccountStatus' fields in Merchant Account Parameters and also in 'IncludedStatus' fields in Merchant Reserve Parameters Valid Values:0-9 Format: XXXXXXXXXXXXXXXXXXXX Example: 9000000111111222222333

Allowable Values:

ToAccountNumber

string

Optional

If any Account Number falls between the Account Number in FromAccountNUmber to Account Number set in ToAccountNumber, it will be eligible for Reserve calculations, Condition this field will be honoured if HoldCreditBalances is set to No and if the status of the Account is not in one of the HoldAccountStatus fields in Merchant Account Parameters and also in IncludedStatus fields in Merchant Reserve Parameters Valid Values:0-9 Format: XXXXXXXXXXXXXXXXXXXX Example: 90000001111112222

Allowable Values:

AccountNumberGenerationFlag

integer

Optional

If Set To Yes then Account Number will be Auto Generated for the Accounts Created Under this Merchant Valid Values: '0' = Yes and '1' = No Format: X Example: 0

AccountNumberBegin

string

Conditional

For internally-generated account numbers, this is the first account number that can be issued for this Merchant. This number is added to the number in the Increment By field to generate the first account number. Valid Values:0-9 Format: XXXXXXXXXXXXXXX Example: 0000000000001000 Condition:Required only if AccountNumberGenerationflag is Set to Yes

Allowable Values:

AccountNumberEnd

string

Conditional

For internally-generated card numbers, this is the last account number that can be issued for this Merchant Valid Values:0-9 Format: XXXXXXXXXXXXXXX Example: 0000000000001000 Condition:Required only if AccountNumberGenerationflag is Set to Yes

Allowable Values:

AccountNumberIncrementBy

integer

Conditional

The Begin Number is added to this number to generate the first account number. Subsequent account numbers are generated by adding the Last Used Account Number to this number. Condition:Required only if AccountNumberGenerationflag is Set to Yes

AccountNumberLastUsed

string

Conditional

The last generated account number displays in this field/Tag, which is used to generate the next account number by adding the value in the Increment By field to this number. Valid Values:0-9 Format: XXXXXXXXXXXXXXX Example: 0000000000001000 Condition:Required only if AccountNumberGenerationflag is Set to Yes

Allowable Values:

AccountNumberCheckDigitRoutine

integer

Conditional

Determines the Modulous formula applied for Check Digit Routine Valid Values: '0'= Mod10, '1' = Mod11 and '2' = None Format: X Example: 2 Condition:Required only if AccountNumberGenerationflag is Set to Yes

IsForwardedToUCA

boolean

Optional

Field : MerchantPLAccounts.IsForwardedToUCA LookUp: CCardLookup; LutId = 'IsForwardedToUCA '

TransactionDescriptionMandatory

boolean

Optional

Field : MerchantPLAccounts.TransactionDescriptionMandatory

AccountActivationEnabled

string

Optional

Field : MerchantPLAccounts.AccountActivationEnabled

ExcludeFlashScreen

string

Optional

Field : MerchantPLAccounts.ExcludeFlashScreen

SuppressPrequalReminderMails

boolean

Optional

Field : MerchantPLAccounts.SuppressPrequalReminderMails LookUp: CCardLookup; LutId = 'SuppressPrequalReminderMails '

MerchantLogo

string

Optional

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

Allowable Values:

TimeToContactFrom

string

Optional

Contact Number of the Distribution Partner Valid Values:0-1 Format:XXXX Example:8:30

Allowable Values:

TimeToContactTo

string

Optional

Contact Number of the Distribution Partner Valid Values:0-1 Format:XXXX Example:6

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

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

Allowable Values:

Disclosure

string

Optional

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

Allowable Values:

ContactNumber

string

Optional

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

Allowable Values:

WeekDayHours

string

Optional

Contact Number of the Distribution Partner Valid Values:0-1 Format:XXXX Example:8:30

Allowable Values:

WeekendHours

string

Optional

Contact Number of the Distribution Partner Valid Values:0-1 Format:XXXX Example:6

Allowable Values:

CardDescription

string

Optional

This field will be used to provide the description of the card

Allowable Values:

DaystoDisplaySplashPage

string

Optional

DaystoDisplaySplashPage Valid Values:0-1 Format:XX Example:30

Allowable Values:

CompanyID

string

Optional

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

Allowable Values:

CompanyName

string

Optional

Company Name Valid Values:A-Z Example: abc

Allowable Values:

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,
  "MerchantID": 11510,
  "MerchantNumber": null,
  "BillingCycle": null,
  "StatementPrintingSequence": null,
  "StatementForm": null,
  "CreditLimitOTBDisplay": null,
  "DefaultCreditLimit": null,
  "MSRPolicyIdentifier": null,
  "MSRLineAssignmentPolicy": null,
  "ProductMapping": null,
  "HoldAccountStatus1": null,
  "HoldAccountStatus2": null,
  "HoldAccountStatus3": null,
  "HoldAccountStatus4": null,
  "HoldCreditBalances": null,
  "DebitBalancesUnder": null,
  "FromAccountNumber": null,
  "ToAccountNumber": null,
  "AccountNumberGenerationFlag": null,
  "AccountNumberBegin": null,
  "AccountNumberEnd": null,
  "AccountNumberIncrementBy": null,
  "AccountNumberLastUsed": null,
  "AccountNumberCheckDigitRoutine": null,
  "MerchantLogo": null,
  "WeekDayHours": null,
  "WeekendHours": null,
  "SiteURL": null,
  "Motto": null,
  "CardDescription": null,
  "CardActivationURL": null,
  "Disclosure": null,
  "ContactNumber": null,
  "DaystoDisplaySplashPage": null,
  "CompanyID": null,
  "CompanyName": null
}

Response fields details

Fields	Description
CurrencySymbol string	This tag reflects the currency symbol

Fields

Description

CurrencySymbol

string

This tag reflects the currency symbol

Sample response body

{
  "Message": "Success.",
  "Status": true,
  "ErrorCode": "Err00017",
  "ResponseData": null
}