/pws/pws_mc_cb_request/

post

https://uat.banking.live:55555/ppws/api/pws/pws_mc_cb_request/

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.

Body Params

api_call_unique_identifier

string

required

length between 1 and 40

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

chargeBackType

string

required

Chargeback type

CHARGEBACK - First chargeback
ARB_CHARGEBACK - Second chargeback

claimId

int64

required

≥ 1

Claim Id where the chargeback will be added

client_id

int32

required

≥ 1

Unique identifier for the client which Paymentology will provide at outset

currencyCcy

string

required

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

disputedAmt

number

required

≥ 1

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

documentIndicator

boolean

required

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

reasonCode

string

required

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

user_id

string

length between 0 and 50

User Id of the Customer who triggered the API request.

remarks

string

length between 0 and 200

Remarks for API request

credPostedAsPurchase

string

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

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

isPartialCb

boolean

Indicates a partial chargeback. Defaults to false.

messageTxt

string

length between 0 and 100

Member message text to be used for the chargeback.

settlementDate

string

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.

localTax1IVA

number

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

installmentFee

number

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

editExclusionCode

string

Edit exclusion code to bypass clearing system edits.

refundNotReceivedIndicator

boolean

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.

includeCurrencyConversionAssessmentCCA

boolean

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

token

int64

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

acquirerRefNumber

string

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

authenticationId

string

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

fileName

string

fileData

string

acknowledgeFirstPartyTrustEvidence

boolean

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.

Responses

404

Webservices does not exist

500

Internal Server error

Language

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Successful Response