Core Card Api Quick Start

Get Fee Details By Plan

Action: POST

Endpoint: /api/CoreCredit/AccountManagement/GetFeeDetailsByPlan

Use this API to retrieve the number and details of fees applicable for an account. The user may enter a plan range and transaction code to view specific fees with details.

Request fields details

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
AccountNumber string Mandatory	Account number of cardholder/AccountHolder. Valid Values:0-9 Format:XXXXXXXXXX Example:7314145404 Condition: At least one account identifier is required. Allowable Values: 19
TransactionCode string Conditional	Unique Code for any Transactions Valid Values:0-9 Format:XXXXX Example: 86221 = AUTO ACH PAYMENT Allowable Values: 20
FromCPSID integer Conditional	ID of the from plan who's Fee detail need to retrieve Valid Values: 0 - 9 Format: xxxx Example: 72456
ToPlanID int64 Conditional	ID of the to plan who's Fee detail need to retrieve Valid Values: 0 - 9 Format: xxxx Example: 72456
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
AccountNumber string Mandatory	Account number of cardholder/AccountHolder. Valid Values:0-9 Format:XXXXXXXXXX Example:7314145404 Condition: At least one account identifier is required. Allowable Values: 19
TransactionCode string Conditional	Unique Code for any Transactions Valid Values:0-9 Format:XXXXX Example: 86221 = AUTO ACH PAYMENT Allowable Values: 20
FromCPSID integer Conditional	ID of the from plan who's Fee detail need to retrieve Valid Values: 0 - 9 Format: xxxx Example: 72456
ToPlanID int64 Conditional	ID of the to plan who's Fee detail need to retrieve Valid Values: 0 - 9 Format: xxxx Example: 72456

Fields

Description

Source

string

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

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

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 ---- es: means Spanish

Allowable Values:

ExternalIP

string

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

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:

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

AccountNumber

string

Mandatory

Account number of cardholder/AccountHolder. Valid Values:0-9 Format:XXXXXXXXXX Example:7314145404 Condition: At least one account identifier is required.

Allowable Values:

TransactionCode

string

Conditional

Unique Code for any Transactions Valid Values:0-9 Format:XXXXX Example: 86221 = AUTO ACH PAYMENT

Allowable Values:

FromCPSID

integer

Conditional

ID of the from plan who's Fee detail need to retrieve Valid Values: 0 - 9 Format: xxxx Example: 72456

ToPlanID

int64

Conditional

ID of the to plan who's Fee detail need to retrieve Valid Values: 0 - 9 Format: xxxx Example: 72456

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

AccountNumber

string

Mandatory

Account number of cardholder/AccountHolder. Valid Values:0-9 Format:XXXXXXXXXX Example:7314145404 Condition: At least one account identifier is required.

Allowable Values:

TransactionCode

string

Conditional

Unique Code for any Transactions Valid Values:0-9 Format:XXXXX Example: 86221 = AUTO ACH PAYMENT

Allowable Values:

FromCPSID

integer

Conditional

ID of the from plan who's Fee detail need to retrieve Valid Values: 0 - 9 Format: xxxx Example: 72456

ToPlanID

int64

Conditional

ID of the to plan who's Fee detail need to retrieve Valid Values: 0 - 9 Format: xxxx Example: 72456

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,
  "AccountNumber": "9000000900001737",
  "TransactionCode": null,
  "FromCPSID": null,
  "ToPlanID": null
}

Response fields details

Fields	Description
FeeCalculationMethod string	Identifies the calculation method for this transaction fee. Valid Values: Assess Flat Amount, Assess Percentage Format: xxxxx
FixedAmount string	Fixed amount on which fee will be applied Valid Values: 0-9 Format: $XX.XX Example: $150.25
FixedPercent string	Fixed percent on which fee will be applied Valid Values: 0-9 Format: $XX.XX Example: $150.25
ResponseID string	This number indicates that API responded. Response ID is unique. This value will be null if no authentication information was passed. Response ID can be used for tracking Valid Values: 0-9, a-z Format: xxx Example: 200
FeeCalculationMethod string	Identifies the calculation method for this transaction fee. Valid Values: Assess Flat Amount, Assess Percentage Format: xxxxx
FixedAmount string	Fixed amount on which fee will be applied when calculation method is via amount Valid Values: 0-9 Format: XXX.XX Example: 150.25
FixedPercent string	Fixed percent on which fee will be applied when calculation method is via Percent Valid Values: 0-9 Format: XX.XX Example: 12%
ResponseID string	This number indicates that API responded. Response ID is unique. This value will be null if no authentication information was passed. Response ID can be used for tracking Valid Values: 0-9, a-z Format: xxx Example: 200

Sample response body

{
  "Message": "Fee Details have been returned successfully.",
  "Status": true,
  "ErrorCode": "ERR01094",
  "ResponseData": {
    "FeeCalculationMethod": "Assess Flat Amount",
    "FixedAmount": "10.25",
    "FixedPercent": "50",
    "ResponseID": "10.25"
  }
}