Requesting chargeback analysis
Introduction
This guide explains how to request a chargeback analysis through the REST API.
This method is used to request the chargeback analysis of transactions that had the credit card holder's identity validated by IDPay. The IDPay client may be reimbursed by Unico for the transaction amount if there is a complaint that results in an official chargeback process, which has been duly formalized with the acquirer/flag, after due investigations prove Unico's responsibility and error in IDPay's decision.
When to use this option?
When you receive a chargeback request for fraud related to a transaction that you believe IDPay should not have validated the credit card holder's identity.
What is chargeback?
Chargeback is the process of investigating a dispute over a purchase/transaction made with credit/debit cards on online platforms, which may result in the reversal/cancellation of this purchase/transaction. Chargeback can be classified into two major groups:
- Commercial Dispute Chargeback: When the transaction has to be canceled due to some problem in the consumer x establishment relationship. Examples: Undelivered merchandise, defective merchandise, purchase cancellation, duplicate purchase, service not provided.
- Fraud Chargeback: The dispute process between the parties begins when the cardholder claims not to have purchased their name.
Chargeback analysis can only be requested in cases of fraud chargeback.
Prerequisites for requesting for chargeback analysis
Chargeback analysis can only be requested for transactions that meet all the rules below:
- The transaction must have been approved (status approved);
- The transaction must have been created less than 90 days ago;
- The transaction must not have been previously submitted to a chargeback analysis;
- The transaction type must be "credit".
How to use it?
Make a POST request to the endpoint /credit/transactions/{transaction_id}/chargeback
With a valid access token, make a request to the endpoint (POST/credit/transactions/{transaction_id}/chargeback) sending the following parameters in the request body:
{
"datetime": "2023-01-05T03:00:00.000Z",
"requestor": {
"key": "cpf",
"value": "USER_CPF"
},
"name": "USER_NAME",
"reason": "REQUEST_REASON",
"observation": "GENERAL_OBSERVATIONS",
"documents": [
{
"label": "FILE_NAME",
"data": "JVBERi0xLjQKMSAwI=="
}
]
}
All fields are mandatory, except for the observation field.
In the documents field, up to 3 items can be uploaded, and the data field of each item must be in base64
format. In this field, you can submit documents that prove the chargeback opening, contestation and transaction data. The files must be in PDF format.
The expected response upon successful request is a JSON containing the ID of the newly created chargeback request analysis:
{
"id": "8263a268-5388-492a-bca2-28e1ff4a69f0"
}
If an error occurs, the expected response is a JSON containing the error code and message, as shown in the example below:
{
"code": "40004",
"message": "transaction id is invalid"
}
Here's a list of errors returned by the service:
HTTP Code | Code | Description | Reason |
---|---|---|---|
400 | 40032 | transaction state is invalid | It is not possible to request chargeback analysis for the informed transaction (a prerequisite has not been met: status, creation date, transaction type) |
400 | 40033 | replicated chargeback | The chargeback analysis already exists for the informed transaction |
403 | 40301 | not allowed | The user does not have permission to perform such action |
500 | 50001 | internal error | Internal failure in the service |
Any concerns?
Missing something or still need help? If you are already a customer or partner, you can contact us through the Help Center.