Disputes

Cards

Disputes

No matter what type of card you use, increase your odds of winning a card dispute through an efficient and seamless way to raise disputes against credit card transactions from a Partner platform.

India

Raise disputes

Raise disputes against Citi credit card transactions in an easy and convenient way through Partner platform. Submit a case, and easily check the status of it later. 
Zoom In

Identify yourself securely

Customers are redirected to a modal window (triggered by the OAuth API)where they are asked to log in to their Citi account in order to verify the identity.
Zoom In

API(s) Callout

View Api Callout 1 >
×

Use Case Callout

Authorization Code Grant: Retrieve Authorization Code

This API gets invoked by a web browser redirection and requires user interaction. It is used to retrieve an authorization code by redirecting the user to a login page followed by the consent approval page. At the end of this flow, this endpoint returns to the redirect_uri configured for the associated application.

Endpoint

India: GET /authCode/oauth2/authorize

Parameters

PATH

NA

Query

response_type

client_id

scope

countryCode

businessCode

locale

state

redirect_uri

Customers validate the one-time password

Customers validate the one-time password sent to the registered mobile number. In the three-legged OAuth flow, OTP validation is based on a fraud and risk recommendation, which is not mandatory.
Zoom In

Customer consent

Customers are then presented with Citi’s consent page where they can read the Terms and Conditions as well as what account information will be shared with the third-party application. If they agree, customers can click "Authorize".
Zoom In

API(s) Callout

View Api Callout 1 >
×

Use Case Callout

Authorization Code Grant: Retrieve Access Token

Get an access token issued by calling our token endpoint and passing the authorization code from the previous call. The issued access token will have an expiry, and it will be valid only for the scope for which the consent has been provided by the customer. You can call the APIs by passing this token in Authorization header.

You also get a refresh token that can be used to get a new access token in case the original one expires.

Endpoint

Australia: POST /authCode/oauth2/token/<countryCode>/<businessCode>

India: POST /authCode/oauth2/token/<countryCode>/<businessCode>

Parameters

PATH

NA

Query

response_type

client_id

scope

countryCode

businessCode

locale

state

redirect_uri

Card selection

From the list of eligible cards, customers can select the card they wish to raise the dispute for.

 

There is a variation of API callouts for the listing of cards on this screen for aggregrators and co-brand partners. Please refer to whichever applies.

 

Once the card is selected, the eligible transactions are displayed on the next screen.

Zoom In

API(s) Callout

View Api Callout 1 >
×

Use Case Callout

Retrieve All Cards - For Aggregators

This API is used to retrieve all the credit card numbers and corresponding details of the customers who authorized the application.

Endpoint

India : GET /v1/cards

Parameters

PATH

NA

Query

cardFunction

View Api Callout 2 >
×

Use Case Callout

Retrieve All Cards - For Cobrand Partners

This API is used to list all the cards held by a customer with Citi partner.

Endpoint

India : GET /partner/v1/cards

Parameters

PATH

NA

Query

cardFunction

View Api Callout 3 >
×

Use Case Callout

Retrieve Dispute Eligible Transactions List

This API is used to fetch the dispute eligible transactions list.

Endpoint

India: GET /v1/disputes/transactions/eligibility

Parameters

Query

cardId

transactionStatus (optional)

statementCycleMonth (optional)

transactionAuthorizationCode (optional)

transactionAmount (optional)

transactionDate (optional)

transactionReferenceId (optional)

Eligible credit card transactions

Customers can view the list of credit card transactions that they can raise a dispute for on the third-party application.

 

By default, unbilled transactions are displayed. 

 

In the case that customers want to raise disputes against statement transactions, they need to select the statement period from the drop-down menu.

 

Customers need to select one of the transactions to continue.

Zoom In

Selection of dispute type

Customers can select the dispute type and raise a dispute against the selected credit card transaction by providing all the relevant information.

 

The Dispute Eligible Transactions List API gets invoked again after the selection of the dispute type using the same transaction authorization code which returns the duplicate transactions.

 

After this API is called, the Dispute Questionnaire API gets invoked to return the questions and answers based on the selected dispute type.

Zoom In

API(s) Callout

View Api Callout 1 >
×

Use Case Callout

Retrieve Dispute Eligible Transactions List

This API is used to fetch the dispute eligible transactions list.

Endpoint

India: GET /v1/disputes/transactions/eligibility

Parameters

Query

cardId

transactionStatus (optional)

statementCycleMonth (optional)

transactionAuthorizationCode

transactionAmount (optional)

transactionDate (optional)

transactionReferenceId (optional)

View Api Callout 2 >
×

Use Case Callout

Dispute Questionnaire Inquiry

This API retrieves the list of questions for the dispute type selected by the customer.

Endpoint

India: GET /v1/disputes/{disputeTypeCode}/questionnaires

Parameters

PATH

disputeTypeCode

Query

cardId

Selection of duplicate entries

Customers can select any duplicate entries for the selected credit card transaction.
Zoom In

Answer additional questions and upload documents

Customers can answer additional questions and upload police complaints, if available.

 

Only PDF documents are supported.

Zoom In

API(s) Callout

View Api Callout 1 >
×

Use Case Callout

Upload Dispute Documents

This API allows customer to upload the document via Channels for service related queries in his/her CASA account or credit card or loans or deposits and create entry in CITI.

Endpoint

India: POST /v1/servicing/documents

Parameters

PATH

Body

serviceRequestType

documentFormat

binaryData

View Api Callout 2 >
×

Use Case Callout

Dispute Case Initiation

This API will accept the case details, create the case and return the Case Number.

Endpoint

India: POST /v1/disputes/cases

Parameters

PATH

Body

cardId

disputeTypeCode

transaction (transactionAuthorizationCode)

questionnaire (questionId, answerText)

Acknowledgement of a raised dispute

Customers receive confirmation that their dispute was submitted successfully along with transaction reference number to be able to track the status of the dispute later.
Zoom In

Card selection to view list of disputes

From the list of eligible cards, customers can select one of the cards to view the list of disputes raised against that card's transactions.

 

There is a variation in API callouts for the listing of cards on this screen for aggregrators and co-brand partners. Please refer to whichever applies.

 

Once the card is selected, the disputes raised by the customer are displayed on the next screen.

Zoom In

API(s) Callout

View Api Callout 1 >
×

Use Case Callout

Retrieve All Cards - For Aggregators

This API is used to retrieve all the credit card numbers and corresponding details of the customers who authorized the application.

Endpoint

India : GET /v1/cards

Parameters

PATH

NA

Query

cardFunction

View Api Callout 2 >
×

Use Case Callout

Retrieve All Cards - For Cobrand Partners

This API is used to list all the cards held by a customer with Citi partner.

Endpoint

India : GET /partner/v1/cards

Parameters

PATH

NA

Query

cardFunction

View Api Callout 3 >
×

Use Case Callout

Retrieve Dispute List

This API is used to get the list of disputes associated to a card.

Endpoint

India: GET /v1/disputes

Parameters

PATH

Query

cardId

Transaction selection to view the dispute status

Customers can view the list of disputed transactions and can select a particular disputed transaction to view its status in more detail.
Zoom In

API(s) Callout

View Api Callout 1 >
×

Use Case Callout

Dispute Case Details

This API is used to get the list of questions and answers as well as the document list required for the dispute.

Endpoint

India: GET /v1/disputes/{disputeCaseNumber}

Parameters

PATH

disputeCaseNumber

Customers view the dispute status

Customers can view the status of the dispute raised against the selected credit card transaction.
Zoom In