Expanding entries to get Chargeback
To get associated transactional detail data about Chargebacks, integrating partners should leverage the entries endpoint.
Entries
To retrieve all chargeback entry records, use the query below
GET /entries?expand[chargeback][txn][]
Search: chargeback[greater]=0
&created[greater]={start}
&created[less]=${end}
CODE
A negative entry amount indicates a “new” chargeback which pulls funds from merchant balance. A positive entry amount indicates a “reversal” of existing chargeback.
An example of the response:
{
"response": {
"data": [
{
"chargeback": {
"txn": {
"id": "p1_txn_xxx",
"created": "2020-11-07 19:42:33.7678",
"modified": "2020-11-09 11:03:08.1442",
"creator": "p1_log_xxx",
"modifier": "000000000000001",
"ipCreated": null,
"ipModified": null,
"merchant": "p1_mer_xxx",
"token": null,
"payment": "p1_pmt_xxx",
"fortxn": null,
"fromtxn": null,
"batch": "p1_bth_xxx",
"subscription": null,
"type": 1,
"expiration": "1234",
"currency": "USD",
"platform": "VANTIV",
"authDate": null,
"authCode": null,
"captured": "2020-11-07 21:32:11",
"settled": 20201109,
"settledCurrency": "USD",
"settledTotal": 100,
"allowPartial": 0,
"order": null,
"description": null,
"descriptor": "DBA",
"terminal": null,
"terminalCapability": null,
"entryMode": null,
"origin": 2,
"tax": null,
"total": 8412,
"cashback": null,
"authorization": "000000",
"approved": 100,
"cvv": 1,
"swiped": 0,
"emv": 0,
"signature": 0,
"unattended": null,
"clientIp": null,
"first": null,
"middle": null,
"last": null,
"company": null,
"email": null,
"address1": null,
"address2": null,
"city": null,
"state": "CA",
"zip": "93543",
"country": "USA",
"phone": null,
"mid": "0000000",
"status": 4,
"refunded": 0,
"reserved": 0,
"misused": 0,
"checkStage": "capture",
"imported": 0,
"inactive": 0,
"frozen": 0,
"discount": 0,
"shipping": 0,
"duty": 0,
"pin": 0,
"traceNumber": null,
"cvvStatus": null,
"unauthReason": null,
"fee": null,
"feeConsumed": null,
"fundingCurrency": "USD",
"authentication": null,
"authenticationId": null,
"cofType": null,
"copyReason": null,
"originalApproved": 8412,
"currencyConversion": null,
"serviceCode": null,
"authTokenCustomer": null,
"debtRepayment": 0,
"statement": null,
"convenienceFee": 0,
"surcharge": null,
"channel": null,
"funded": 20201107,
"fundingEnabled": 1,
"requestSequence": 1,
"processedSequence": 1
},
"id": "p1_chb_xxx",
"created": "2021-02-26 11:31:41.3225",
"modified": "2021-02-26 11:32:04.4189",
"creator": "000000000000001",
"modifier": "000000000000001",
"merchant": "p1_mer_xxx",
"mid": "000000",
"description": "",
"total": 100,
"representedTotal": null,
"cycle": "first",
"currency": "USD",
"platform": "VANTIV",
"ref": "00000000",
"reason": "Allocation Flow - Fraud - Card Absent Environment",
"reasonCode": "10.4",
"issued": 20210226,
"received": 20210226,
"reply": 20210318,
"bankRef": "00000000000",
"chargebackRef": "000000",
"status": "open",
"lastStatusChange": "p1_chs_xxx",
"inactive": 0,
"frozen": 0,
"actionable": 1
},
"id": "p1_etr_xxx",
"created": "2021-02-26 11:31:43.4997",
"modified": "2021-02-26 11:31:43.4997",
"creator": "000000000000001",
"modifier": "000000000000001",
"entity": "p1_ent_xxx",
"onentity": "p1_ent_xxx",
"fromentity": null,
"opposingEntry": "p1_etr_xxx",
"fund": "p1_fun_xxx",
"fee": null,
"disbursement": null,
"refund": null,
"txn": null,
"adjustment": null,
"profitShare": null,
"event": 11,
"eventId": "p1_chb_xxx",
"description": "Chargeback p1_chb_xxx creation",
"amount": -8412,
"unsourced": null,
"pending": null,
"originalCurrency": null,
"currencyRate": null,
"isFee": 0,
"statement": null,
"settlement": null,
"archiveSummary": null,
"pendingEntry": "p1_per_xxx",
"pendingEntryCreated": "2021-02-26 11:31:43"
}
...
],
"details": {
"requestId": 1,
"totals": [],
"page": {
"current": 1,
"last": 2,
"hasMore": true
}
},
"errors": []
}
}
CODE
Integrating Partners should use an ID based looping to pull in all the data until hasMore is false.
You will see positive and negative events in the same data pull (e.g. sale and refund, chargeback initiation and (processor) rejection) so be sure to handle them properly.
Because Chargeback Retrievals are fee only event (i.e., there are no financial impact to the merchant except fees), they will not be represented by this model