v1

latestOpenAPI 3.0.02026-07-242035712.0 MB

Chargeback

Request Chargeback

This resource creates a new chargeback

Issuers and acquirers use this endpoint to create chargeback and second presentments and optionally to upload supporting documents. Issuers and acquirers may use the parameters in the request to automatically generate the Expedited Billing Dispute Form (EBDF) and attach it to the claim.

post/pws/pws_mc_cb_request/

Request body

api_call_unique_identifierstring required

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

chargeBackTypestring required

<p> Chargeback type <ul> <li>CHARGEBACK - First chargeback</li> <li>ARB_CHARGEBACK - Second chargeback</li> </ul> </p>

claimIdinteger required

Claim Id where the chargeback will be added

client_idinteger required

Unique identifier for the client which Paymentology will provide at outset

currencyCcystring required

The chargeback currency. The data should be standard currency alpha code or numeric code

disputedAmtnumber required

Amount of CB should be OT amount (DE4). US Issuers should always submit in USD. For more details refer to the GCMS Reference Manual.

documentIndicatorboolean required

Document Indicator defines if a document is required for the dispute.

reasonCodestring required

Chargeback Reason Code provides the chargeback receiver with the reason for sending the chargeback.

user_idstring

User Id of the Customer who triggered the API request.

remarksstring

Remarks for API request

credPostedAsPurchasestring

Indicator to notify this is a credit posted as a purchase.

Only applicable to reason codes of 4853 and 4860. Defaults to false.

isPartialCbboolean

Indicates a partial chargeback. Defaults to false.

messageTxtstring

Member message text to be used for the chargeback.

settlementDatestring

CONDITIONAL: Required for Argentina and Uruguay's Settlement Service participation ID codes (LA00003201, LA00003202, LA00085801, LA00085802, LA00084011, LA00084012). The date may not be prior to the current date or beyond 90 days from the current date.

localTax1IVAnumber

Applies only to LAC installments (Argentina and Uruguay). PDS 1015. Contains the VAT amount for the installment fee.

installmentFeenumber

Applies only to LAC installments (Argentina and Uruguay). PDS 1028. Contains the VAT amount for the installment fee.

editExclusionCodestring

Edit exclusion code to bypass clearing system edits.

refundNotReceivedIndicatorboolean

Cardholder/Issuer did not receive refund when a first chargeback was rejected by Collaboration with reason code 5000 indicating refund provided. 20 days after rejection of CB through collaboration.

CONDITIONAL: this field is only applicable if chargebackType is CHARGEBACK.

includeCurrencyConversionAssessmentCCAboolean

Currency Conversion Assessment amount applied for full first chargeback, to indicate, if Currency Conversion Assessment was included or not for qualified transactions.

tokeninteger

Public token. This is optional field and can be passed if settelemnt is internal

acquirerRefNumberstring

Acquirer reference number. This is optional field and can be passed if settelemnt is internal

authenticationIdstring

Authentication Id. This is optional field and can be passed if settelemnt is internal

fileNamestring

fileDatastring

acknowledgeFirstPartyTrustEvidenceboolean

Issuer has acknowledged First-Party Trust evidence and proceeded with the chargeback. Defaults to false. This field is not applicable to second presentments CONDITIONAL: This field is only applicable if chargebackType is CHARGEBACK.

Example request

{
  "api_call_unique_identifier": "438574845790657485",
  "chargeBackType": "CHARGEBACK",
  "claimId": 200002042336,
  "client_id": 760131,
  "currencyCcy": "USD",
  "disputedAmt": 100,
  "reasonCode": "4853",
  "credPostedAsPurchase": "false",
  "messageTxt": "This is a test message text",
  "settlementDate": "2021-06-15",
  "localTax1IVA": 0.6,
  "installmentFee": 1.2,
  "editExclusionCode": "BO",
  "refundNotReceivedIndicator": true
}

Response

Successful Response

Example response

{
  "header": {
    "error_desc": "success"
  },
  "body": {
    "fraudId": "2343454",
    "chargeBackId": "2343455"
  }
}