API Reference

Our reference library for integrating with our API


Find answers to our most frequently asked questions

Classic Docs

Documentation for our Classic API

Disputes reconciliation

You have two options for reporting on the financial implications of disputes and reconciling chargebacks with your payments:

In both reports, you'll find our dispute indicator codes, which help you match up the financial activity on your account with the progress of dispute cases.

The best way to track the progress of a dispute case is to use the payment ID (prefixed with pay_) of the payment to which the dispute applies. The payment ID stays the same across the Hub, Reconciliation API, and webhooks.

Sometimes, you may receive two disputes against the same payment. These will show as two separate ADJM records for the same payment ID, with a different time for each.

Differences between disputes and payments reports

You will see different data for the same dispute case depending on which report you use. The disputes report records all dispute-related status changes. The payments report only records actions that have a financial impact on your account.

For example, if you lose a dispute, this will be reported in the disputes report with an RPDL indicator. But, because the disputed amount was already taken from your account when the dispute was first raised (ADJM), this will not be reported in the Reconciliation API payments report.

Creating a disputes report 

To generate a disputes report, and view any you've previously created, log in to the Hub, go to Reports, and the find the Disputes section. Click New report to create a new disputes report.

These reports list all of the disputes that occurred during the selected period, with various columns providing more information about each event.

Disputes report example

Here’s a simplified example of what two separate dispute cases might look like in your Hub disputes report if you sort the data by payment ID.

Dispute IDDispute indicator codePayment ID

So for the first payment (pay_code_a), you can see the dispute case associated with it has been won (RPDW).

For the second (pay_code_b), the dispute associated with it is currently in progress (RPDR) – the scheme is now reviewing the evidence you submitted.

Creating a payments report 

Use our Reconciliation API’s payments endpoint to generate a payments report. These reports record any charge or credit to your account, including those related to disputes.

As with the Hub's disputes reports, look up the payment ID of the disputed payment you’re interested in to find out more about it.

Payments report example

Here's a simplified example of two separate payments in a report, one of which has a dispute raised against it.

The action type column tells you what action was taken (where there are duplicates, it means there were multiple financial implications caused by that same action), and the breakdown type tells you more about the financial implication.

Action IDAction typePayment IDBreakdown type
act_code_1Authorizationpay_code_xScheme fee
act_code_3Authorizationpay_code_yScheme fee
act_code_4Capturepay_code_yScheme fee
act_code_5Chargebackpay_code_yChargeback (ADJM)
act_code_5Chargebackpay_code_yScheme fee

Looking at the action type and breakdown type columns for the second payment (pay_code_y), you can see a dispute has been raised against it.

The ‘Chargeback’ action type appears twice because the payments report covers any action that has a financial impact on your account. So, in this case, first the disputed amount was debited from your account, and then you were charged a scheme fee for that same dispute.

Dispute indicator codes 

The table below lists all the dispute indicator codes you’ll see in both the disputes reports from the Hub and the payments reports from the Reconciliation API.

Each code is associated with a different dispute status, allowing you to track the progress of live disputes as the cases progress.

If you want to be notified every time a dispute’s status updates, you can subscribe to the associated webhook.

Indicator codeAPI statusDescriptionWebhook
RTVLOur API does not currently return retrieval requests.You’ve received a request for more information (also known as a retrieval request). A dispute may be raised if you do not respond.payment_retrieval
ADJMevidence_requiredYou’ve received a dispute and you need to submit evidence if you want to defend against it.dispute_evidence_required
AUTOresolvedYou've already refunded the customer, so we automatically submitted the relevant evidence and resolved the dispute for you.dispute_resolved
CBRVcanceledThe issuer has canceled the dispute. You have been refunded the disputed amount.dispute_canceled
RPDRevidence_under_reviewYou’ve submitted your evidence and the issuer is now reviewing it. You have been charged a dispute fee.n/a
RPDWwonYou have won the dispute. You have been refunded the disputed amount.dispute_won
RPDLlostYou have lost the dispute. You have been charged a dispute fee, if applicable.dispute_lost
ARBRarbitration_under_reviewYou have escalated your case to arbitration with the issuer and/or scheme.n/a
ARBWarbitration_wonThe scheme has decided the case in your favour. You have been refunded the disputed amount.n/a
ARBLarbitration_lostThe scheme has decided the case in the issuer’s favour. You have been charged an arbitration fee.n/a