Paths
/v1/servicing/disputes/credit-cards/transactions/validate
LOB: Cards, Feature: Disputes, Functionality: Creation
This api is to perform the first and second attempt to validate the dispute in order to know if the gathered data is valid to create a dispute in the digital services.
Client ID generated during application registration
The Authorization Token received during login
Content-Types that are acceptable for the response
128 bit UUID that you generate for every request
List of acceptable human languages for response
Content-Types that are sent in the request
Country code in 2 character ISO 3166 format
Business code identified during application registration
Channel where request originated
SessionId sent by Consumer
Successful operation.
Type | Code | Details |
error | invalidRequest | Missing or invalid Parameters |
Type | Code | Details |
error | unAuthorized | Authorization credentials are missing or invalid |
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 |
Type | Code | Details | More Info |
error | resourceNotFound | The requested resource was not found | Empty resource/resource not found |
Type | Code | Details |
error | businessValidationFailed | Business validation error occured on one or more parameters |
Type | Code | Details |
fatal | serverUnavailable | The request failed due to an internal error/server unavailability |
/v1/servicing/disputes/credit-cards/transaction
LOB: Cards, Feature: Disputes, Functionality: Creation
This service is to create a dispute about some transactions that the customer doesn't recognize as own.
Client ID generated during application registration
The Authorization Token received during login
Content-Types that are acceptable for the response
128 bit UUID that you generate for every request
List of acceptable human languages for response
Content-Types that are sent in the request
Country code in 2 character ISO 3166 format
Business code identified during application registration
Channel where request originated
SessionId sent by Consumer
Successful operation.
Type | Code | Details |
error | invalidRequest | Missing or invalid Parameters |
Type | Code | Details |
error | unAuthorized | Authorization credentials are missing or invalid |
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 |
Type | Code | Details | More Info |
error | resourceNotFound | The requested resource was not found | Empty resource/resource not found |
Type | Code | Details |
error | businessValidationFailed | Business validation error occured on one or more parameters |
Type | Code | Details |
fatal | serverUnavailable | The request failed due to an internal error/server unavailability |
Definitions
{
"type": "object",
"properties": {
"transactionId": {
"description": "Transaction ID refers to an identifier or code which uniquely identifies a specific Transaction across Citi globally.",
"type": "string",
"example": "28984673s32"
},
"accountId": {
"description": "AccountId will be an ID used to represent an account number uniquely. This could be a random number (surrogate ids) or an Id generated using any hashing algorithm. Also, this could be confined to a session or stay with an account number for its life time.",
"type": "string",
"example": "278926158923"
},
"disputeReasonCode": {
"description": "The code of the main reason configured in the One Disputes Database.",
"type": "string",
"example": "F-FD4"
},
"firstQuestion": {
"$ref": "#/definitions/Question"
}
},
"required": [
"transactionId",
"accountId",
"disputeReasonCode",
"firstQuestion"
]
}
{
"type": "object",
"properties": {
"questionId": {
"description": "Unique identifier assigned for each question.",
"type": "string",
"example": "BC0100"
},
"answerId": {
"description": "The code value related to the answer in the answer set for the question.",
"type": "string",
"example": "1"
}
},
"required": [
"questionId",
"answerId"
]
}
{
"type": "object",
"properties": {
"oneDisputeValidationId": {
"description": "Folio number from the one disputes service.",
"type": "string",
"example": "3068432"
},
"posEntryMode": {
"description": "Entry mode of the transaction, could be magnetic band, chip and pin or manual",
"type": "string",
"example": "05",
"maxLength": 2
},
"questionnaireId": {
"description": "Unique Identifier associated with the questionnary.",
"type": "string",
"example": "1234"
},
"questionnaire": {
"type": "array",
"items": {
"$ref": "#/definitions/QuestionSet"
}
}
},
"required": [
"questionnaireId"
]
}
{
"type": "object",
"properties": {
"questionId": {
"description": "Unique identifier assigned for each question.",
"type": "string",
"example": "BC0100"
},
"questionText": {
"description": "This is the text of the question for dispute reason.",
"type": "string",
"example": "What is the problem with your transaction by phone?"
},
"answerDataType": {
"description": "The data type required for the answer.",
"type": "string",
"example": "A"
},
"questionType": {
"description": "The display type required for the question. Example-multiple choice question- single selection, multiple selection or free form etc.",
"type": "string",
"example": "2"
},
"answers": {
"type": "array",
"items": {
"$ref": "#/definitions/AnswerSetInfo"
}
}
},
"required": [
"questionId",
"questionType",
"answers"
]
}
{
"type": "object",
"properties": {
"answerId": {
"description": "The code value related to the answer in the answer set for the question.",
"type": "string",
"example": "1"
},
"answerText": {
"description": "The description of the code value related to the answer in the answer set.",
"type": "string",
"example": "Recurring charge canceled"
}
},
"required": [
"answerId",
"answerText"
]
}
{
"type": "object",
"properties": {
"dispute": {
"$ref": "#/definitions/DisputeDetail"
}
}
}
{
"type": "object",
"properties": {
"oneDisputeValidationId": {
"description": "Folio number from the one dispute service.",
"type": "string",
"example": "286348390"
},
"encryptedCustomerPhone": {
"description": "Encrypted phone number of the customer registered during the dispute creation.",
"type": "string",
"example": "k9d03ks75nf7"
},
"encryptedCustomerEmail": {
"description": "Encrypted email of the customer registered during the dispute creation",
"type": "string",
"example": "k17ddh57d85j"
},
"cardBlockCode": {
"description": "Card block Codes. Possibles values are in AMCR file (AMCR-LB-LM-BLK).",
"type": "string",
"example": "L"
},
"questionnaire": {
"type": "array",
"items": {
"$ref": "#/definitions/Question"
}
}
},
"required": [
"oneDisputeValidationId",
"encryptedCustomerPhone",
"encryptedCustomerEmail",
"cardBlockCode",
"questionnaire"
]
}
{
"type": "object",
"properties": {
"disputeId": {
"description": "Unique identifier of the dispute created",
"type": "string",
"example": "3829202"
},
"disputeAmount": {
"description": "Dispute Amount",
"type": "number",
"format": "double",
"example": 29393.32
},
"responseDueDate": {
"description": "Expected date when case can be resolved or the next response in relation to its resolution would be received.",
"type": "string",
"format": "date",
"example": "2020-12-12"
},
"disputeReasonText": {
"description": "Description of the main reason of the dispute",
"type": "string",
"example": "Charge not recognized"
},
"merchantName": {
"description": "Name of the merchant related to the dispute",
"type": "string",
"example": "Amazon"
},
"disputeDate": {
"description": "Date when the Dispute happened",
"type": "string",
"format": "date",
"example": "2020-12-12"
},
"benefitDescription": {
"description": "Customer benefit according to the dispute",
"type": "string",
"example": "NO",
"maxLength": 40
},
"caseStatus": {
"description": "Case Status refers to the present stage or status of the case.It can have following values:-Case Creation , Retrieval ,CHGBK, FRAUD,ADJS,ARBIT,WRTOFF",
"type": "string",
"example": "CHGBK"
}
},
"required": [
"disputeId",
"disputeAmount",
"responseDueDate",
"disputeReasonText",
"merchantName",
"disputeDate",
"benefitDescription",
"caseStatus"
]
}
{
"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 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"
]
}