production
development
https://sandbox.externalapib2b.wlb.nam.nsroot.net:7101/mx-gcgapi-uat/sandbox2
Paths
/v1/servicing/disputes/cases/retrieve
post /v1/servicing/disputes/cases/retrieve
retrieve-case-information
retrieve-case-information
This API retrieves the detail of the created cases related to an account Id between a selected period
OAuth2 Application Flow
OAuth2 Application Flow
(oauth2 application)
Token URL
https://sandbox.externalapib2b.wlb.nam.nsroot.net:7101/mx-gcgapi-uat/sandbox2/api/v1/oauth/token
Scopes
/api/v1
Client ID
X-IBM-Client-Id
(apiKey located in header)
client_id
Required in header
string
Client ID generated during application registration
Authorization
Required in header
string
The Authorization Token received during login
Accept
Required in header
string
Content-Types that are acceptable for the response
uuid
Required in header
string
128 bit UUID that you generate for every request
Accept-Language
Optional in header
string
List of acceptable human languages for response
Content-Type
Required in header
string
Content-Types that are sent in the request
countryCode
Required in header
string
Country code in 2 character ISO 3166 format
businessCode
Required in header
string
Business code identified during application registration
ChannelId
Required in header
string
Channel where request originated
sid
Required in header
string
SessionId sent by Consumer
retrieveCaseInformationRequest
Optional in body
object
200
Successful operation.
400
| Type | Code | Details |
| error | invalidRequest | Missing or invalid Parameters |
401
| Type | Code | Details |
| error | unAuthorized | Authorization credentials are missing or invalid |
403
| Type | Code | Details | More Info |
| error | accessNotConfigured | The request operation is not configured to access this resource | Channel/Country/Business provided in the request is not supported currently |
404
| Type | Code | Details | More Info |
| error | resourceNotFound | The requested resource was not found | Empty resource/resource not found |
422
| Type | Code | Details |
| error | businessValidationFailed | Business validation error occured on one or more parameters |
500
| Type | Code | Details |
| fatal | serverUnavailable | The request failed due to an internal error/server unavailability |
Example Request
Example Response
POST https://sandbox.externalapib2b.wlb.nam.nsroot.net:7101/mx-gcgapi-uat/sandbox2/api/v1/servicing/disputes/cases/retrieve
/v2/servicing/disputes/cases/retrieve
post /v2/servicing/disputes/cases/retrieve
retrieve-case-information-v2
retrieve-case-information
This API retrieves the detail of the created cases related to an account Id between a selected period
OAuth2 Application Flow
OAuth2 Application Flow
(oauth2 application)
Token URL
https://sandbox.externalapib2b.wlb.nam.nsroot.net:7101/mx-gcgapi-uat/sandbox2/api/v1/oauth/token
Scopes
/api/v1
Client ID
X-IBM-Client-Id
(apiKey located in header)
client_id
Required in header
string
Client ID generated during application registration
Authorization
Required in header
string
The Authorization Token received during login
Accept
Required in header
string
Content-Types that are acceptable for the response
uuid
Required in header
string
128 bit UUID that you generate for every request
Accept-Language
Optional in header
string
List of acceptable human languages for response
Content-Type
Required in header
string
Content-Types that are sent in the request
countryCode
Required in header
string
Country code in 2 character ISO 3166 format
businessCode
Required in header
string
Business code identified during application registration
ChannelId
Required in header
string
Channel where request originated
sid
Required in header
string
SessionId sent by Consumer
retrieveCaseInformationRequest
Optional in body
object
200
Successful operation.
400
| Type | Code | Details |
| error | invalidRequest | Missing or invalid Parameters |
401
| Type | Code | Details |
| error | unAuthorized | Authorization credentials are missing or invalid |
403
| Type | Code | Details | More Info |
| error | accessNotConfigured | The request operation is not configured to access this resource | Channel/Country/Business provided in the request is not supported currently |
404
| Type | Code | Details | More Info |
| error | resourceNotFound | The requested resource was not found | Empty resource/resource not found |
422
| Type | Code | Details |
| error | businessValidationFailed | Business validation error occured on one or more parameters |
500
| Type | Code | Details |
| fatal | serverUnavailable | The request failed due to an internal error/server unavailability |
Example Request
Example Response
POST https://sandbox.externalapib2b.wlb.nam.nsroot.net:7101/mx-gcgapi-uat/sandbox2/api/v2/servicing/disputes/cases/retrieve
Definitions
{
"type": "object",
"properties": {
"account": {
"$ref": "#/definitions/Account"
},
"startDate": {
"description": "Start date of the query",
"type": "string",
"format": "date",
"example": "2020-01-01"
},
"endDate": {
"description": "Final date of the query",
"type": "string",
"format": "date",
"example": "2020-12-31"
}
},
"required": [
"startDate",
"endDate"
]
}
{
"type": "array",
"items": {
"$ref": "#/definitions/CaseData"
}
}
{
"type": "object",
"properties": {
"deviceAccessUniqueId": {
"description": "Unique ID used by front end to identify the account as a device access",
"type": "string",
"example": "23234"
},
"complaintDate": {
"description": "Date when the complaint was registered by the user or customer. Format YYYY-MM-DD",
"type": "string",
"format": "date",
"example": "2016-10-01"
},
"caseDetail": {
"$ref": "#/definitions/CaseDetail"
}
},
"required": [
"deviceAccessUniqueId"
]
}
{
"type": "object",
"properties": {
"caseNumber": {
"description": "Unique number assigned to the case for identification.",
"type": "string",
"example": "I8092510496",
"maxLength": 11
},
"caseStatus": {
"description": "Case Status refers to the present stage or status of the case, possible values WIP CIF CIB",
"type": "string",
"example": "WIP",
"maxLength": 3
},
"caseStatusDescription": {
"description": "Description of case Status",
"type": "string",
"example": "Work In Progress",
"maxLength": 15
},
"closedDate": {
"description": "Close date of the case, Format YYYY-MM-DD",
"type": "string",
"format": "date",
"example": "2016-10-01"
},
"resolvedDate": {
"description": "Date when the case got resolved.",
"type": "string",
"format": "date",
"example": "2016-10-01"
},
"caseReopenedFlag": {
"description": "Flag indicating, If the case is reopened.",
"type": "boolean",
"example": true
},
"dispute": {
"$ref": "#/definitions/DisputeDetail"
}
},
"required": [
"caseNumber",
"caseStatus",
"caseStatusDescription",
"closedDate"
]
}
{
"type": "object",
"properties": {
"disputeAmount": {
"description": "Dispute Amount",
"type": "number",
"format": "double",
"example": 200.5
},
"transactionAmount": {
"description": "Refers to the total amount of transaction",
"type": "number",
"format": "double",
"example": 200.5
},
"transactionDate": {
"description": "Transaction date. Format YYYY-MM-DD",
"type": "string",
"format": "date",
"example": "2016-10-01"
},
"merchantName": {
"description": "Name of the merchant against whom dispute have been raised.",
"type": "string",
"example": "Walmart",
"maxLength": 30
},
"disputeType": {
"description": "Type of dispute",
"type": "string",
"example": "DIS"
}
},
"required": [
"transactionAmount",
"transactionDate"
]
}
{
"type": "object",
"properties": {
"accountId": {
"description": "Account Id of the customer who is creating a dispute.",
"type": "string",
"example": "3999279922",
"maxLength": 12
}
}
}
{
"type": "object",
"properties": {
"account": {
"$ref": "#/definitions/AccountV2"
},
"startDate": {
"description": "Start date of the query",
"type": "string",
"format": "date",
"example": "2020-01-01"
},
"endDate": {
"description": "Final date of the query",
"type": "string",
"format": "date",
"example": "2020-12-31"
}
},
"required": [
"startDate",
"endDate"
]
}
{
"type": "object",
"properties": {
"accounts": {
"type": "array",
"items": {
"$ref": "#/definitions/AccountDisputeV2"
}
}
}
}
{
"type": "object",
"properties": {
"deviceAccessUniqueId": {
"description": "Unique ID used by front end to identify the account as a device access",
"type": "string",
"example": "23234"
},
"displayDeviceAccessNumber": {
"description": "The last digits of the Access Media Id",
"type": "string",
"example": "12345",
"maxLength": 5
},
"deviceAccessStatus": {
"description": "Device access status active, inactive, canceled, blocked, etc.",
"type": "integer",
"format": "int32",
"example": 10
},
"deviceAccessStatusDescription": {
"description": "description of access media status",
"type": "string",
"example": "ACTIVE UNTIL EXPIRATION"
},
"bankIdentificationNumber": {
"description": "A bank identification number (BIN) is the initial four to six numbers that appear on a credit card",
"type": "string",
"example": "123456"
},
"productName": {
"description": "Name by which the Product is known across enterprise",
"type": "string",
"example": "Checking Account"
},
"cardType": {
"description": "Type of the card- Debit/ Credit",
"type": "string",
"example": "Debit"
},
"cardHolderType": {
"description": "Identifies the type of card user such as Primary or Suplementary.",
"type": "string",
"example": "PRIMARY"
},
"cases": {
"type": "array",
"items": {
"$ref": "#/definitions/CaseDataV2"
}
}
},
"required": [
"deviceAccessUniqueId",
"displayDeviceAccessNumber",
"bankIdentificationNumber"
]
}
{
"type": "object",
"properties": {
"complaintDate": {
"description": "Date when the complaint was registered by the user or customer. Format YYYY-MM-DD",
"type": "string",
"format": "date",
"example": "2016-10-01"
},
"caseDetail": {
"$ref": "#/definitions/CaseDetailV2"
}
}
}
{
"type": "object",
"properties": {
"caseNumber": {
"description": "Unique number assigned to the case for identification.",
"type": "string",
"example": "I8092510496",
"maxLength": 11
},
"caseStatus": {
"description": "Case Status refers to the present stage or status of the case, possible values WIP CIF CIB",
"type": "string",
"example": "WIP",
"maxLength": 3
},
"caseStatusDescription": {
"description": "Description of case Status",
"type": "string",
"example": "Work In Progress",
"maxLength": 15
},
"closedDate": {
"description": "Close date of the case, Format YYYY-MM-DD",
"type": "string",
"format": "date",
"example": "2016-10-01"
},
"resolvedDate": {
"description": "Date when the case got resolved.",
"type": "string",
"format": "date",
"example": "2016-10-01"
},
"caseReopenedFlag": {
"description": "Flag indicating, If the case is reopened.",
"type": "boolean",
"example": true
},
"dispute": {
"$ref": "#/definitions/DisputeDetailV2"
}
},
"required": [
"caseNumber",
"caseStatus",
"caseStatusDescription",
"closedDate"
]
}
{
"type": "object",
"properties": {
"disputeAmount": {
"description": "Dispute Amount",
"type": "number",
"format": "double",
"example": 200.5
},
"transactionAmount": {
"description": "Refers to the total amount of transaction",
"type": "number",
"format": "double",
"example": 200.5
},
"transactionDate": {
"description": "Transaction date. Format YYYY-MM-DD",
"type": "string",
"format": "date",
"example": "2016-10-01"
},
"merchantName": {
"description": "Name of the merchant against whom dispute have been raised.",
"type": "string",
"example": "Walmart",
"maxLength": 30
},
"disputeType": {
"description": "Type of dispute",
"type": "string",
"example": "DIS"
}
},
"required": [
"transactionAmount",
"transactionDate"
]
}
{
"type": "object",
"properties": {
"accountId": {
"description": "Account Id of the customer who is creating a dispute.",
"type": "string",
"example": "3999279922",
"maxLength": 12
}
}
}
{
"properties": {
"type": {
"type": "string",
"description": "Invalid - Request did not confirm to the specification and was unprocessed and rejected. Please fix the value and try again",
"enum": [
"error",
"warn",
"invalid",
"fatal"
]
},
"code": {
"description": "Error code which qualifies the error",
"type": "string"
},
"details": {
"description": "Human readable explanation specific to the occurrence of the problem",
"type": "string"
},
"location": {
"description": "The name of the field that resulted in the error",
"type": "string"
},
"moreInfo": {
"description": "URI to human readable documentation or detailed description of the error",
"type": "string"
},
"uuid": {
"description": "128 bit UUID that you generate for every request",
"type": "string"
},
"timestamp": {
"description": "Timestamp of the error",
"type": "string"
}
},
"required": [
"type",
"code"
]
}