Core Card Api Quick Start

Get Pending Dispute Transaction History

Action: POST

Endpoint: /api/CoreCredit/Dispute/GetPendingDisputeTransactionHistory

Use this API to obtain transaction details for cases in which disputes have not yet been resolved. The API retrieves details such as dispute initiated date, last updated date, transaction amount, dispute amount, dispute status, account number, transaction ID, and total number of records present in an array.

Note

This API can be used to get request with multiple filters. If the filters are used, then CoreCARD returns the transactions which are falling within applied filters. In case filters are not applied, then by default CoreCARD returns all the transactions for an account on which dispute is yet to be resolved.

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
InstitutionID integer Mandatory	Description: Unique identification number for Institution Valid Values: 0-9 Format: XXXX Example: Fixed value needs to pass which is provided by Corecard.
AccountNumber string Optional	Description: Account number of cardholder. Valid Values: 0-9 Format: XXXXXXXXXX Example: 7314145404 Condition: At least one account identifier is required. Allowable Values: 19
CardNumberLast4Digit string Optional	Description: Last 4 digits of card number Valid Values: 0 - 9 Format: XXXX Example: 1234 Allowable Values: 10
FromDate datetime Optional	Description: Starting date of transaction search.Used as a criteria for Transaction Filter. Valid Values: 0 - 9 Format: MMDDYYY Example: 02012020
ToDate datetime Optional	Description: End date of transaction search.Used as a criteria for Transaction Filter Valid Values: 0 - 9 Format: MMDDYYY Example: 02012020
DisputeStage string Optional	Description: Code of the stage of Dispute case . Valid Values: 0-9 Example: 0,2 Allowable Values: 5
ProductID integer Optional	Description: Product ID Valid Values: 0-9 Format: XXXX Example: 1234
ClientID integer Optional	Description - Client ID of the client. Valid Values: 1422245 Format: XXXXX Example: 5558547
TransactionAmount decimal Optional	Description - Amount of Transaction Valid Values: 0 - 9 Format: XXX.XX Example: 200.00
BatchSize integer Optional	Description: Number of Transaction which can be view in one Batch Valid Values: 0-9 Format: XX Example: 20
PageIndex integer Optional	Description: Number of page Valid Values: 0 - 9 Format: XX Example: 12
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
InstitutionID integer Mandatory	Unique identification number for Institution Valid Values: 0-9 Format: XXXX Example: Fixed value needs to pass which is provided by Corecard.
AccountNumber string Optional	Account number of cardholder. Valid Values: 0-9 Format: XXXXXXXXXX Example: 7314145404 Condition: At least one account identifier is required. Allowable Values: 19
CardNumberLast4Digit string Optional	Last 4 digits of card number Valid Values: 0 - 9 Format: XXXX Example: 1234 Allowable Values: 4
FromDate datetime Optional	Starting date of transaction search.Used as a criteria for Transaction Filter. Valid Values: 0 - 9 Format: MMDDYYY Example: 02012020
ToDate datetime Optional	End date of transaction search.Used as a criteria for Transaction Filter Valid Values: 0 - 9 Format: MMDDYYY Example: 02012020
DisputeStage string Optional	Code of the stage of Dispute case . Valid Values: 0-9 Example: 0,2 Allowable Values: 5
ProductID integer Optional	Product ID Valid Values: 0-9 Format: XXXX Example: 1234
ClientID integer Optional	Client ID of the client. Valid Values: 1422245 Format: XXXXX Example: 5558547
TransactionAmount decimal Optional	Amount of Transaction Valid Values: 0 - 9 Format: XXX.XX Example: 200.00
BatchSize integer Optional	Number of Transaction which can be view in one Batch Valid Values: 0-9 Format: XX Example: 20
PageIndex integer Optional	Number of page Valid Values: 0 - 9 Format: XX Example: 12
WarehousedAutoWriteOff integer Optional	AutoWriteOff Transaction which is warehoused as per warehousing days Valid Values: 0 - 1 Format: X Example: 1

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

InstitutionID

integer

Mandatory

Description: Unique identification number for Institution Valid Values: 0-9 Format: XXXX Example: Fixed value needs to pass which is provided by Corecard.

AccountNumber

string

Optional

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

Allowable Values:

CardNumberLast4Digit

string

Optional

Description: Last 4 digits of card number Valid Values: 0 - 9 Format: XXXX Example: 1234

Allowable Values:

FromDate

datetime

Optional

Description: Starting date of transaction search.Used as a criteria for Transaction Filter. Valid Values: 0 - 9 Format: MMDDYYY Example: 02012020

ToDate

datetime

Optional

Description: End date of transaction search.Used as a criteria for Transaction Filter Valid Values: 0 - 9 Format: MMDDYYY Example: 02012020

DisputeStage

string

Optional

Description: Code of the stage of Dispute case . Valid Values: 0-9 Example: 0,2

Allowable Values:

ProductID

integer

Optional

Description: Product ID Valid Values: 0-9 Format: XXXX Example: 1234

ClientID

integer

Optional

Description - Client ID of the client. Valid Values: 1422245 Format: XXXXX Example: 5558547

TransactionAmount

decimal

Optional

Description - Amount of Transaction Valid Values: 0 - 9 Format: XXX.XX Example: 200.00

BatchSize

integer

Optional

Description: Number of Transaction which can be view in one Batch Valid Values: 0-9 Format: XX Example: 20

PageIndex

integer

Optional

Description: Number of page Valid Values: 0 - 9 Format: XX Example: 12

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

InstitutionID

integer

Mandatory

Unique identification number for Institution Valid Values: 0-9 Format: XXXX Example: Fixed value needs to pass which is provided by Corecard.

AccountNumber

string

Optional

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

Allowable Values:

CardNumberLast4Digit

string

Optional

Last 4 digits of card number Valid Values: 0 - 9 Format: XXXX Example: 1234

Allowable Values:

FromDate

datetime

Optional

Starting date of transaction search.Used as a criteria for Transaction Filter. Valid Values: 0 - 9 Format: MMDDYYY Example: 02012020

ToDate

datetime

Optional

End date of transaction search.Used as a criteria for Transaction Filter Valid Values: 0 - 9 Format: MMDDYYY Example: 02012020

DisputeStage

string

Optional

Code of the stage of Dispute case . Valid Values: 0-9 Example: 0,2

Allowable Values:

ProductID

integer

Optional

Product ID Valid Values: 0-9 Format: XXXX Example: 1234

ClientID

integer

Optional

Client ID of the client. Valid Values: 1422245 Format: XXXXX Example: 5558547

TransactionAmount

decimal

Optional

Amount of Transaction Valid Values: 0 - 9 Format: XXX.XX Example: 200.00

BatchSize

integer

Optional

Number of Transaction which can be view in one Batch Valid Values: 0-9 Format: XX Example: 20

PageIndex

integer

Optional

Number of page Valid Values: 0 - 9 Format: XX Example: 12

WarehousedAutoWriteOff

integer

Optional

AutoWriteOff Transaction which is warehoused as per warehousing days Valid Values: 0 - 1 Format: X Example: 1

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": 3185,
  "AccountNumber": null,
  "CardNumberLast4Digit": null,
  "FromDate": null,
  "ToDate": null,
  "DisputeStage": null,
  "ProductID": null,
  "ClientID": null,
  "TransactionAmount": null,
  "BatchSize": 50,
  "PageIndex": 0,
  "WarehousedAutoWriteOff": 0
}

Response fields details

Fields	Description
PendingDisputeTransactionList array	Description: List all the dispute transactions.
TotalRecordCount integer	Description: Total number of records in an Array. Valid Values: 0-9 Example: 10
PendingDisputeTransactionList array	Description: List all the dispute transactions.
TotalRecordCount integer	Description: Total number of records in an Array. Valid Values: 0-9 Example: 10

Sample response body

{
  "Message": "Success.",
  "Status": true,
  "ErrorCode": "Err00017",
  "ResponseData": {
    "PendingDisputeTransactionList": [
      {
        "TransactionID": 23654789,
        "DisputeAutoResolveDate": "03/31/2016 00:00:00",
        "TransactionPostTime": "03/31/2016 00:00:00",
        "TransactionDescription": "Purchase/Payment.",
        "TransactionCurrencyCode": "840",
        "TransactionAmount": 200.0,
        "TransactionSource": "Retail = 23(Manual Auth)",
        "CardAcceptorNameLocation": null,
        "AccountNumber": "7000000000000070",
        "CardNumberLast4Digits": "1234",
        "DisputeStatus": "Resolve in favor of Cardholder",
        "DisputeInitiateDate": "03/31/2016 00:00:00",
        "LastUpdatedDate": "03/31/2016 00:00:00",
        "DisputeAmount": 20.0,
        "UserID": "John",
        "MerchantID": 12345,
        "DisputeReason": "This is Test",
        "TokenWalletID": null
      }
    ],
    "TotalRecordCount": null
  }
}