Disputes and chargebacks

Open a dispute against a transaction, attach the evidence, and cancel a case that should not have been raised.

Used to initiate spending disputes from multiple customer channels

POST

https://devcard.sim-ant.com/SandBox/IntegrationDigitalChannelCredit

/credit/api/createDisputeCase

Creates a new dispute case for a credit card transaction. Supports multiple dispute case details and DMS references. Returns the case number and related dispute transaction details.

Part of:

Journey 02 · Managing a card product — step 1, Open and evidence a case

Used to initiate spending disputes from multiple customer channels › Request Body

CreateDisputeCaseRequest

DisputeDate

string · date-time · required

Dispute Date - [Optional]

Channel

string | null

Channel - [Optional]

ShadowCardNumber

string | null

Shadow Card Number - [Optional]

CardRefNumber

string | null

Card Ref Number - [Optional]

EncryptedCardNumber

string | null

Encrypted Card Number - [Optional]

CardNumber

string | null

Card Number - [Optional]

CaseType

string | null

Case Type - [Optional]

DisputeReasonCode

string | null

Dispute Reason Code - [Optional]

DisputeExplanation

string | null

Dispute Explanation - [Optional]

array | null

Create Dispute Case Detail - [Optional]

array | null

Dms Reference - [Optional]

Used to initiate spending disputes from multiple customer channels › Responses

Success

CreateDisputeCaseResponse

CaseNumber

integer · int32 · required

Case Number - [Optional]

array | null

Dispute Transaction - [Optional]

POST/credit/api/createDisputeCase

curl https://devcard.sim-ant.com/SandBox/IntegrationDigitalChannelCredit/credit/api/createDisputeCase \
  --request POST \
  --header 'Content-Type: application/json' \
  --data '{
  "Channel": "Channel",
  "ShadowCardNumber": "ShadowCardNumber",
  "CardRefNumber": "CardRefNumber",
  "EncryptedCardNumber": "EncryptedCardNumber",
  "CardNumber": "CardNumber",
  "CaseType": "CaseType",
  "DisputeDate": "2024-08-25T15:00:00Z",
  "DisputeReasonCode": "DisputeReasonCode",
  "DisputeExplanation": "DisputeExplanation",
  "CreateDisputeCaseDetail": [
    {
      "UTID": "UTID",
      "CurrencyCode": "CurrencyCode",
      "DisputeAmount": 0
    }
  ],
  "DmsReference": [
    {
      "DmsReferenceId": "DmsReferenceId"
    }
  ]
}'

Example Request Body

{
  "Channel": "Channel",
  "ShadowCardNumber": "ShadowCardNumber",
  "CardRefNumber": "CardRefNumber",
  "EncryptedCardNumber": "EncryptedCardNumber",
  "CardNumber": "CardNumber",
  "CaseType": "CaseType",
  "DisputeDate": "2024-08-25T15:00:00Z",
  "DisputeReasonCode": "DisputeReasonCode",
  "DisputeExplanation": "DisputeExplanation",
  "CreateDisputeCaseDetail": [
    {
      "UTID": "UTID",
      "CurrencyCode": "CurrencyCode",
      "DisputeAmount": 0
    }
  ],
  "DmsReference": [
    {
      "DmsReferenceId": "DmsReferenceId"
    }
  ]
}

json

Example Responses

{
  "CaseNumber": 0,
  "DisputeTransaction": [
    {
      "UTID": "UTID",
      "DisputeTransactionId": 0
    }
  ]
}

json

application/json

Used in an ongoing dispute process when the customer withdraws their dispute request

POST

https://devcard.sim-ant.com/SandBox/IntegrationDigitalChannelCredit

/credit/api/cancelDisputeCase

Cancels a dispute case by calling the BKM batch service with case number, channel, description, dispute transaction ID, and UTID. Returns a response indicating whether the cancellation was successful.

Part of:

Journey 02 · Managing a card product — step 2, Track and manage

Used in an ongoing dispute process when the customer withdraws their dispute request › Request Body

CancelDisputeCaseRequest

CaseNumber

integer · int32 · required

Case Number - [Optional]

DisputeTransactionId

integer · int64 · required

Dispute Transaction Id - [Optional]

Channel

string | null

Channel - [Optional]

UTID

string | null

U T I D - [Optional]

Description

string | null

Description - [Optional]

Used in an ongoing dispute process when the customer withdraws their dispute request › Responses

Success

CancelDisputeCaseResponse

isSuccessful

boolean · required

Is Successful - [Optional]

Used when an ongoing dispute case requires adding a new document to the case record

POST

https://devcard.sim-ant.com/SandBox/IntegrationDigitalChannelCredit

/credit/api/addDocumentByCaseNumber

Adds one or more document references to a case number in the BKM batch system. It requires the channel, case number, and a list of DMS references.

Part of:

Journey 02 · Managing a card product — step 1, Open and evidence a case

Used when an ongoing dispute case requires adding a new document to the case record › Request Body

AddDocumentByCaseNumberRequest

CaseNumber

integer · int32 · required

Case Number - [Optional]

Channel

string | null

Channel - [Optional]

array | null

Dms References - [Optional]

Used when an ongoing dispute case requires adding a new document to the case record › Responses

Success

No data returned

Get Dispute List

POST

https://devcard.sim-ant.com/SandBox/IntegrationDigitalChannelCredit

/credit/api/getDisputeList

Retrieves a list of dispute transactions for a given card or customer. Filters can be applied by card number, card reference number, case number, customer number, dispute transaction ID, shadow card number, encrypted card number, or UTID. Returns detailed information for each dispute including case number, dispute transaction ID, dispute amount and currency, dispute date and reason code, transaction details (amount, currency, date, status, authorization number, MCC, merchant name), source network, and associated customer/card information.

Part of:

Journey 02 · Managing a card product — step 2, Track and manage

Get Dispute List › Request Body

GetDisputeListRequest

CaseNumber

integer · int32 · required

Case Number - [Optional]

DisputeTransactionId

integer · int64 · required

Dispute Transaction Id - [Optional]

CustomerNumber

integer · int64 · required

Customer Number - [Optional]

UTID

string | null

U T I D - [Optional]

ShadowCardNumber

string | null

Shadow Card Number - [Optional]

CardRefNumber

string | null

Card Ref Number - [Optional]

EncryptedCardNumber

string | null

Encrypted Card Number - [Optional]

CardNumber

string | null

Card Number - [Optional]

Get Dispute List › Responses

Success

GetDisputeListResponse

array | null

Dispute List - [Optional]

POST/credit/api/getDisputeList

curl https://devcard.sim-ant.com/SandBox/IntegrationDigitalChannelCredit/credit/api/getDisputeList \
  --request POST \
  --header 'Content-Type: application/json' \
  --data '{
  "CaseNumber": 0,
  "DisputeTransactionId": 0,
  "UTID": "UTID",
  "CustomerNumber": 0,
  "ShadowCardNumber": "ShadowCardNumber",
  "CardRefNumber": "CardRefNumber",
  "EncryptedCardNumber": "EncryptedCardNumber",
  "CardNumber": "CardNumber"
}'

Example Request Body

{
  "CaseNumber": 0,
  "DisputeTransactionId": 0,
  "UTID": "UTID",
  "CustomerNumber": 0,
  "ShadowCardNumber": "ShadowCardNumber",
  "CardRefNumber": "CardRefNumber",
  "EncryptedCardNumber": "EncryptedCardNumber",
  "CardNumber": "CardNumber"
}

json

Example Responses

{
  "DisputeTransaction": [
    {
      "CaseNumber": 0,
      "CustomerNumber": 0,
      "DisputeAmount": 0,
      "DisputeCurrencyCode": "DisputeCurrencyCode",
      "DisputeDate": "2024-08-25T15:00:00Z",
      "DisputeReasonCode": "DisputeReasonCode",
      "DisputeTransactionId": 0,
      "InsertUserId": "InsertUserId",
      "MaskedCardNumber": "MaskedCardNumber",
      "MerchantName": "MerchantName",
      "TrnAmount": 0,
      "TrnCurrencyCode": "TrnCurrencyCode",
      "TrnDate": "2024-08-25T15:00:00Z",
      "TrnStatusDescription": "TrnStatusDescription",
      "AuthorizationNumber": "AuthorizationNumber",
      "Mcc": "Mcc",
      "SourceNetwork": "SourceNetwork",
      "Utid": "Utid"
    }
  ]
}

json

application/json

Service that returns the list of dispute reasons available when creating a new dispute case via Create Dispute Case

POST

https://devcard.sim-ant.com/SandBox/IntegrationDigitalChannelCredit

/credit/api/getDisputeReasonDefList

Retrieves a list of all dispute reason definitions in the system. Each item includes the dispute reason code and its corresponding description. No input parameters are required.

Part of:

Journey 02 · Managing a card product — step 1, Open and evidence a case

Service that returns the list of dispute reasons available when creating a new dispute case via Create Dispute Case › Responses

Success

GetDisputeReasonDefResponse

array | null

Dispute Reason Definitions - [Optional]

PIN and card security Campaigns and rewards

Credit Digital Channels Integration

Disputes and chargebacks

Open a dispute against a transaction, attach the evidence, and cancel a case that should not have been raised.

Used to initiate spending disputes from multiple customer channels

POST

https://devcard.sim-ant.com/SandBox/IntegrationDigitalChannelCredit

/credit/api/createDisputeCase

Creates a new dispute case for a credit card transaction. Supports multiple dispute case details and DMS references. Returns the case number and related dispute transaction details.

Part of:

Journey 02 · Managing a card product — step 1, Open and evidence a case

Used to initiate spending disputes from multiple customer channels › Request Body

CreateDisputeCaseRequest

DisputeDate

string · date-time · required

Dispute Date - [Optional]

Channel

string | null

Channel - [Optional]

ShadowCardNumber

string | null

Shadow Card Number - [Optional]

CardRefNumber

string | null

Card Ref Number - [Optional]

EncryptedCardNumber

string | null

Encrypted Card Number - [Optional]

CardNumber

string | null

Card Number - [Optional]

CaseType

string | null

Case Type - [Optional]

DisputeReasonCode

string | null

Dispute Reason Code - [Optional]

DisputeExplanation

string | null

Dispute Explanation - [Optional]

array | null

Create Dispute Case Detail - [Optional]

array | null

Dms Reference - [Optional]

Used to initiate spending disputes from multiple customer channels › Responses

Success

CreateDisputeCaseResponse

CaseNumber

integer · int32 · required

Case Number - [Optional]

array | null

Dispute Transaction - [Optional]

POST/credit/api/createDisputeCase

curl https://devcard.sim-ant.com/SandBox/IntegrationDigitalChannelCredit/credit/api/createDisputeCase \
  --request POST \
  --header 'Content-Type: application/json' \
  --data '{
  "Channel": "Channel",
  "ShadowCardNumber": "ShadowCardNumber",
  "CardRefNumber": "CardRefNumber",
  "EncryptedCardNumber": "EncryptedCardNumber",
  "CardNumber": "CardNumber",
  "CaseType": "CaseType",
  "DisputeDate": "2024-08-25T15:00:00Z",
  "DisputeReasonCode": "DisputeReasonCode",
  "DisputeExplanation": "DisputeExplanation",
  "CreateDisputeCaseDetail": [
    {
      "UTID": "UTID",
      "CurrencyCode": "CurrencyCode",
      "DisputeAmount": 0
    }
  ],
  "DmsReference": [
    {
      "DmsReferenceId": "DmsReferenceId"
    }
  ]
}'

Example Request Body

{
  "Channel": "Channel",
  "ShadowCardNumber": "ShadowCardNumber",
  "CardRefNumber": "CardRefNumber",
  "EncryptedCardNumber": "EncryptedCardNumber",
  "CardNumber": "CardNumber",
  "CaseType": "CaseType",
  "DisputeDate": "2024-08-25T15:00:00Z",
  "DisputeReasonCode": "DisputeReasonCode",
  "DisputeExplanation": "DisputeExplanation",
  "CreateDisputeCaseDetail": [
    {
      "UTID": "UTID",
      "CurrencyCode": "CurrencyCode",
      "DisputeAmount": 0
    }
  ],
  "DmsReference": [
    {
      "DmsReferenceId": "DmsReferenceId"
    }
  ]
}

json

Example Responses

{
  "CaseNumber": 0,
  "DisputeTransaction": [
    {
      "UTID": "UTID",
      "DisputeTransactionId": 0
    }
  ]
}

json

application/json

Used in an ongoing dispute process when the customer withdraws their dispute request

POST

https://devcard.sim-ant.com/SandBox/IntegrationDigitalChannelCredit

/credit/api/cancelDisputeCase

Part of:

Journey 02 · Managing a card product — step 2, Track and manage

Used in an ongoing dispute process when the customer withdraws their dispute request › Request Body

CancelDisputeCaseRequest

CaseNumber

integer · int32 · required

Case Number - [Optional]

DisputeTransactionId

integer · int64 · required

Dispute Transaction Id - [Optional]

Channel

string | null

Channel - [Optional]

UTID

string | null

U T I D - [Optional]

Description

string | null

Description - [Optional]

Used in an ongoing dispute process when the customer withdraws their dispute request › Responses

Success

CancelDisputeCaseResponse

isSuccessful

boolean · required

Is Successful - [Optional]

Used when an ongoing dispute case requires adding a new document to the case record

POST

https://devcard.sim-ant.com/SandBox/IntegrationDigitalChannelCredit

/credit/api/addDocumentByCaseNumber

Adds one or more document references to a case number in the BKM batch system. It requires the channel, case number, and a list of DMS references.

Part of:

Journey 02 · Managing a card product — step 1, Open and evidence a case

Used when an ongoing dispute case requires adding a new document to the case record › Request Body

AddDocumentByCaseNumberRequest

CaseNumber

integer · int32 · required

Case Number - [Optional]

Channel

string | null

Channel - [Optional]

array | null

Dms References - [Optional]

Used when an ongoing dispute case requires adding a new document to the case record › Responses

Success

No data returned

Get Dispute List

POST

https://devcard.sim-ant.com/SandBox/IntegrationDigitalChannelCredit

/credit/api/getDisputeList

Part of:

Journey 02 · Managing a card product — step 2, Track and manage

Get Dispute List › Request Body

GetDisputeListRequest

CaseNumber

integer · int32 · required

Case Number - [Optional]

DisputeTransactionId

integer · int64 · required

Dispute Transaction Id - [Optional]

CustomerNumber

integer · int64 · required

Customer Number - [Optional]

UTID

string | null

U T I D - [Optional]

ShadowCardNumber

string | null

Shadow Card Number - [Optional]

CardRefNumber

string | null

Card Ref Number - [Optional]

EncryptedCardNumber

string | null

Encrypted Card Number - [Optional]

CardNumber

string | null

Card Number - [Optional]

Get Dispute List › Responses

Success

GetDisputeListResponse

array | null

Dispute List - [Optional]

POST/credit/api/getDisputeList

curl https://devcard.sim-ant.com/SandBox/IntegrationDigitalChannelCredit/credit/api/getDisputeList \
  --request POST \
  --header 'Content-Type: application/json' \
  --data '{
  "CaseNumber": 0,
  "DisputeTransactionId": 0,
  "UTID": "UTID",
  "CustomerNumber": 0,
  "ShadowCardNumber": "ShadowCardNumber",
  "CardRefNumber": "CardRefNumber",
  "EncryptedCardNumber": "EncryptedCardNumber",
  "CardNumber": "CardNumber"
}'

Example Request Body

{
  "CaseNumber": 0,
  "DisputeTransactionId": 0,
  "UTID": "UTID",
  "CustomerNumber": 0,
  "ShadowCardNumber": "ShadowCardNumber",
  "CardRefNumber": "CardRefNumber",
  "EncryptedCardNumber": "EncryptedCardNumber",
  "CardNumber": "CardNumber"
}

json

Example Responses

{
  "DisputeTransaction": [
    {
      "CaseNumber": 0,
      "CustomerNumber": 0,
      "DisputeAmount": 0,
      "DisputeCurrencyCode": "DisputeCurrencyCode",
      "DisputeDate": "2024-08-25T15:00:00Z",
      "DisputeReasonCode": "DisputeReasonCode",
      "DisputeTransactionId": 0,
      "InsertUserId": "InsertUserId",
      "MaskedCardNumber": "MaskedCardNumber",
      "MerchantName": "MerchantName",
      "TrnAmount": 0,
      "TrnCurrencyCode": "TrnCurrencyCode",
      "TrnDate": "2024-08-25T15:00:00Z",
      "TrnStatusDescription": "TrnStatusDescription",
      "AuthorizationNumber": "AuthorizationNumber",
      "Mcc": "Mcc",
      "SourceNetwork": "SourceNetwork",
      "Utid": "Utid"
    }
  ]
}

json

application/json

Service that returns the list of dispute reasons available when creating a new dispute case via Create Dispute Case

POST

https://devcard.sim-ant.com/SandBox/IntegrationDigitalChannelCredit

/credit/api/getDisputeReasonDefList

Retrieves a list of all dispute reason definitions in the system. Each item includes the dispute reason code and its corresponding description. No input parameters are required.

Part of:

Journey 02 · Managing a card product — step 1, Open and evidence a case

Service that returns the list of dispute reasons available when creating a new dispute case via Create Dispute Case › Responses

Success

GetDisputeReasonDefResponse

array | null

Dispute Reason Definitions - [Optional]

PIN and card security Campaigns and rewards