Core Card Api Quick Start

Dispute OTB Release

Action: POST

Endpoint: /api/CoreCredit/Dispute/DisputeOTBRelease

Use this API to release a hold placed on the Open to Buy (OTB) credit limit amount by using the dispute case ID. When a transaction is marked as disputed for a non-fraudulent reason, an OTB amount equivalent to the disputed amount is kept on hold. In such a case, if the benefit is to be given to the cardholder, the API can release the held OTB amount. Additionally, the API can release the held OTB amount at any dispute life cycle stage before resolution.

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
AccountNumber string Conditional	Account number of cardholder. Valid Values:0-9 Format:XXXXXXXXXX Example:7314145404 Condition: At least one account identifier is required. Allowable Values: 19
CardNumber string Conditional	Card Number of account holder Valid Values: 0-9 Format:XXXXXXXXXXXXXXXX Example:1236547896325874 Condition: At least one account identifier is required. Allowable Values: 19
AdminNumber int64 Conditional	Details can be obtained by admin number (Embossing Acctid) Valid Values:0-9 Format:XXXXX Example:12345 Condition: At least one account identifier is required.
AccountUniversalUniqueID string Optional	Unique additional Identification Number generated by system for an Account. Example:a585f533-0d33-4282-ab98-4852146e5e17 Allowable Values: 50
AdminUniversalUniqueID string Optional	EmbossingAccount's Universal Unique Id. Valid Values:0-9, A-Z Format:xxxxxxx Example:123456 Allowable Values: 64
CaseID int64 Mandatory	Case which is generated against the Dispute request. Valid Values: 0-9 Format: XXXXXXX Example:9856198

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

AccountNumber

string

Conditional

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

Allowable Values:

CardNumber

string

Conditional

Card Number of account holder Valid Values: 0-9 Format:XXXXXXXXXXXXXXXX Example:1236547896325874 Condition: At least one account identifier is required.

Allowable Values:

AdminNumber

int64

Conditional

Details can be obtained by admin number (Embossing Acctid) Valid Values:0-9 Format:XXXXX Example:12345 Condition: At least one account identifier is required.

AccountUniversalUniqueID

string

Optional

Unique additional Identification Number generated by system for an Account. Example:a585f533-0d33-4282-ab98-4852146e5e17

Allowable Values:

AdminUniversalUniqueID

string

Optional

EmbossingAccount's Universal Unique Id. Valid Values:0-9, A-Z Format:xxxxxxx Example:123456

Allowable Values:

CaseID

int64

Mandatory

Case which is generated against the Dispute request. Valid Values: 0-9 Format: XXXXXXX Example:9856198

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": "8000000000000177",
  "CardNumber": null,
  "AdminNumber": null,
  "AccountUniversalUniqueID": null,
  "AdminUniversalUniqueID": null,
  "CaseID": 4453
}

Response fields details

Fields	Description
ReleasedOpenToBuy decimal	Amount of 'Open to Buy' which got released. Valid Values:0-9 Example: 123.50

Fields

Description

ReleasedOpenToBuy

decimal

Amount of 'Open to Buy' which got released. Valid Values:0-9 Example: 123.50

Sample response body

{
  "Message": "Dispute OTB Released Successfully",
  "Status": true,
  "ErrorCode": "ERR01174",
  "ResponseData": {
    "ReleasedOpenToBuy": 200.0
  }
}