Sign in

v1

latestOpenAPI 3.0.02026-07-242035712.0 MB
Chargeback

Create Claim

This resource creates a new claim

Issuers use this endpoint to create a new claim, which is required before creating a retrieval request or a first chargeback. If an issuer attempts to create a duplicate claim on an original transaction, the issuer receives a error message with the claim ID of the existing claim. Acquirers are not able to create claims. They receive claims from disputes that issuers initiate.

Note: issuers must have a first presentment in order to create a claim.

Note: issuers cannot create claims on first presentments that acquirers have reversed.

post/pws/pws_mc_create_claim/

Request body

api_call_unique_identifierstring required

Unique number that must be passed at each API request. Identifier to make each API request unique

authTransactionIdstring required

The Authorization Transaction Identifier from Authorization Summary Results.

Valid Format : Alphanumeric Special character (~!@#$%^&*()_+{}|:"<>?,./;'[]-=)

claimTypestring required

Claim tyoe

Format : String

Accepted value : Standard

clearingTransactionIdstring required

The Clearing Transaction Identifier from Clearing Summary Results.

Valid Format : Alphanumeric Special character (~!@#$%^&*()_+{}|:"<>?,./;'[]-=)

client_idinteger required

Unique identifier for the client which Paymentology will provide at outset

disputedAmountnumber required

Amount disputed in the claim

Format : Numeric

disputedCurrencystring required

Currency of amount disputed in the claim. disputedCurrency can be provided as standard alpha code or numeric code(must be three digit ISO-4217 standard numeric currency code)

user_idstring

User Id of the Customer who triggered the API request.

remarksstring

Remarks for API request

referenceSetIdinteger

Unique identifier for clearing summary (settlement). This field will be used if authorisation or clearing is internal Format : Numeric

acquirerRefNumberstring

Acquirer Reference Number

authorizationDateTimestring
authenticationIdstring

Authentication Id

Example request

{
  "api_call_unique_identifier": "438574845790657485",
  "authTransactionId": "aaCnaMDqmto4wnL+BSUKSdzROqGJ7YELoKhEvluycwKNg3XTzSfaIJhFDkl9hW081B5tTqFFiAwCpcocPdB2My4t7DtSTk63VXDl1CySA8Y=",
  "claimType": "Standard",
  "clearingTransactionId": "ccCnaMDqmto4wnL+BSUKSdzROqGJ7YELoKhEvluycwKNg3XTzSfaIJhFDkl9hW081B5tTqFFiAwCpcocPdB2My4t7DtSTk63VXDl1CySA8Y=",
  "client_id": 760131,
  "disputedAmount": 100,
  "disputedCurrency": "826",
  "referenceSetId": 20050,
  "acquirerRefNumber": "05436847276000293995738",
  "authenticationId": "858082"
}

Response

Successful Response

Example response

{
  "header": {
    "error_desc": "success"
  },
  "body": {
    "caseFilingDetails": {
      "caseFilingDetail": {
        "claimId": "200002020654",
        "claimType": "Standard",
        "caseId": "502146",
        "caseType": "1",
        "currencyCode": "CNY",
        "customerFilingNumber": "1775",
        "creditDate": "2023-05-02",
        "chargebackDate": "2023-04-30",
        "reasonCode": "4870",
        "disputeAmount": "504.81",
        "dueDate": "2023-05-02",
        "filingAgaintstIca": "7798",
        "filingAs": "I",
        "filingIca": "1775",
        "merchantName": "Dollar Tree",
        "primaryAccountNum": "5123430067779819522",
        "rulingDate": "2023-05-02",
        "rulingStatus": "Declined",
        "virtualAccountNum": "5123437179579307008"
      },
      "caseFilingRespHistory": [
        {
          "memo": "Case filing response",
          "action": "REBUT",
          "responseDate": "2023-05-02"
        }
      ]
    },
    "chargebackDetails": [
      {
        "currency": "CNY",
        "createDate": "2023-04-30",
        "documentIndicator": "false",
        "messageText": "Chargeback message",
        "amount": "504.81",
        "reasonCode": "4870",
        "isPartialChargeback": "false",
        "chargebackType": "CHARGEBACK",
        "chargebackId": "300003030676",
        "claimId": "200002020654",
        "chargebackRefNum": "9000082557",
        "documentStatus": "DOC_NOT_APPLICABLE",
        "reconciliationAmount": "504.81",
        "reconciliationCurrency": "CNY",
        "rejectReason": "Code1=5000(00):D0025/000;DE072=D0025\\\\0000\\\\\\\\",
        "editExclusionCode": "BO",
        "refundNotReceivedIndicator": "true",
        "creditVoucherStatus": "Credit Voucher Accepted",
        "currencyConversionAssessmentCCAIncluded": "true",
        "currencyConversionAssessmentCCAAmount": "0.99 CNY"
      }
    ],
    "feeDetails": [
      {
        "cardAcceptorIdCode": "183229846815172",
        "cardNumber": "5123430067779819522",
        "countryCode": "AUS",
        "currency": "CNY",
        "feeDate": "2023-05-01",
        "destinationMember": "007798",
        "feeId": "30002086648",
        "feeAmount": "CHARGEBACK",
        "creditSender": true,
        "message": "Message regarding fee",
        "reason": "7623",
        "rejectReason": "Code1=0142(00):D0063/002;DE072=D0063\\\\\\\\8000000808\\\\\\\\\\\\\\\\",
        "reconciliationCurrency": "CNY",
        "chargebackRefNum": "9000082557",
        "reconciliationAmount": "8.76"
      }
    ]
  }
}