When a Chargeback occurs, Merchants will lose funds and receive funds as different stages and decisions are provided.
Use the following steps below to review and track Chargebacks manually & verify the movement of disputed transaction funds to and from the Merchant’s account:
Please note that all API calls listed below will require the valid headers:
CODE
Content-Type:application/json
APIKEY:{{private_api_key}}
Step 1: Get all Chargebacks Modified the Previous Day
Run the following query to see all Chargebacks modified within the past day:
CODE
GET https://api-test.payrix.com/chargebacks?modified[greater]=YYYY-MM-DD&modified[less]==YYYY-MM-DD
Optional Merchant ID filter:
CODE
GET https://api-test.payrix.com/chargebacks?modified[greater]=YYYY-MM-DD&modified[less]==YYYY-MM-DD&merchant[equals]=p1_mer_0a0a0a0a0a0a0a0a00aa0
Note & copy the txn
field value (Transaction ID) and proceed to Step 2.
Example Query Response - Chargebacks
CODE
{
"data": [
{
"id": "string", // The Chargeback ID
"created": "2023-10-17T22:41:25.433Z",
"modified": "2023-10-17T22:41:25.433Z",
"creator": "string",
"modifier": "string",
"merchant": "string",
"txn": "string", // the Transaction ID.
"mid": "string",
"description": "string",
"total": 0,
"representedTotal": 0,
"cycle": "retrieval",
"currency": "USD",
"platform": "VCORE",
"paymentMethod": "0",
"ref": "string",
"reason": "string",
"reasonCode": "string",
"issued": 0,
"received": 0,
"reply": 0,
"bankRef": "string",
"chargebackRef": "string",
"status": "open",
"lastStatusChange": "string",
"actionable": "0",
"shadow": "0",
"inactive": "0",
"frozen": "0"
}
],
"details": {
"requestId": "string",
"page": { // Pagination to see all associated chargebacks.
"current": 0,
"last": 0
}
},
"errors": []
}
Step 2: Find All Associated Chargeback Disputes for the Transaction
Run the following query to find any associated Chargebacks with a transaction:
Multiple Chargebacks can be associated with the same Transaction ID.
CODE
GET https://api-test.payrix.com/chargebacks?txn[in]=p1_txn_0a0a0a0a0a0a0a0a00aa0
Retrieve each associated chargeback
field value (Chargeback ID) and proceed to Step 3.
Example Query Response - Chargebacks
CODE
{
"data": [
{
"id": "string", // The Chargeback ID
"created": "2023-10-17T22:41:25.433Z",
"modified": "2023-10-17T22:41:25.433Z",
"creator": "string",
"modifier": "string",
"merchant": "string",
"txn": "string", // the Transaction ID.
"mid": "string",
"description": "string",
"total": 0,
"representedTotal": 0,
"cycle": "retrieval",
"currency": "USD",
"platform": "VCORE",
"paymentMethod": "0",
"ref": "string",
"reason": "string",
"reasonCode": "string",
"issued": 0,
"received": 0,
"reply": 0,
"bankRef": "string",
"chargebackRef": "string",
"status": "open",
"lastStatusChange": "string",
"actionable": "0",
"shadow": "0",
"inactive": "0",
"frozen": "0"
}
],
"details": {
"requestId": "string",
"page": { // Pagination to see all associated Chargebacks.
"current": 0,
"last": 0
}
},
"errors": []
}
Step 3: Review Associated Funds Movement
Run the following query to find all entries associated with that Chargeback. (Excludes Chargeback Fees):
CODE
GET https://api-test.payrix.com/entries?chargeback[in]=p1_chb_ID&isFee[equals]=0
Then, add the totals to the query to sum the amount:
CODE
GET https://api-test.payrix.com/entries?chargeback[in]=p1_chb_ID&isFee[equals]=0sum[{total}]=amount
Example Query Response - Entries
CODE
{
"data": [
{
"id": "string",
"created": "2023-10-17T22:41:25.433Z",
"modified": "2023-10-17T22:41:25.433Z",
"creator": "string",
"modifier": "string",
"entity": "string",
"onentity": "string",
"fromentity": "string",
"opposingEntry": "string",
"fund": "string",
"fee": "string",
"disbursement": "string",
"refund": "string",
"settlement": "string",
"txn": "string",
"chargeback": "string", // The Assoicated Chargeback ID with the Entry
"adjustment": "string",
"profitShare": "string",
"statement": "string",
"event": 1,
"eventId": "string",
"originalEventId": "string",
"originalEvent": 1,
"description": "string",
"originalCurrency": "USD",
"currencyRate": "string",
"amount": "string",
"unsourced": "string",
"pending": 0,
"isFee": 0,
"archiveSummary": 0,
"pendingEntry": "string",
"pendingEntryCreated": "2023-10-17T22:41:25.433Z"
}
],
"details": {},
"errors": []
}
Result:
If the sum equals 0, the chargeback funds have been returned to the merchant,
If negative the merchant has been debited the chargeback amount.