Chargeback

Markdown

Before you begin

Your API requests are authenticated using an access token. Any request that does not include a valid access token will return an error. Learn more in Authentication.

Base URL

• UAT: https://transactions.transactional.uat.unico.app/api/public/v1
• Production: https://transactions.transactional.unico.app/api/public/v1

Report a chargeback

POST /credit/transactions/{transaction_id}/chargeback — reports to Unico that a chargeback was received for a specified transaction.

Reporting is not a contestation

This endpoint only reports the chargeback. It does not open a chargeback analysis and does not trigger the liability guarantee. To have Unico analyze the chargeback, open a contestation for the transaction in the portal.

Headers

Header	Value
Authorization	Bearer {token} — a valid access token.

Body

{
  "datetime": "2023-01-05T03:00:00.000Z",
  "requestor": { "key": "cpf", "value": "USER_CPF" },
  "name": "USER_NAME",
  "reason": "REQUEST_REASON",
  "observation": "GENERAL_OBSERVATIONS"
}

Field	Type	Required	Description
datetime	string	yes	Date and time the chargeback was received, ISO 8601 format.
requestor	object	yes	Requestor's information.
requestor.key	string	yes	Identification key type for the requestor (e.g. cpf).
requestor.value	string	yes	Identification key value for the requestor.
name	string	yes	Name of the requestor.
reason	string	yes	Reason for the chargeback.
observation	string	no	General observations about the chargeback.

201 Created

{
  "id": "8263a268-5388-492a-bca2-28e1ff4a69f0"
}

Field	Description
id	Chargeback ID.

A transaction has a single chargeback. Reporting a transaction that already has one returns 200 OK with the id of the existing chargeback, and does not change it.

For error responses, see Errors — Transaction Creation.

Get chargeback status

GET /credit/transactions/{transaction_id}/chargeback/{chargeback_id} — checks the status of a specific chargeback.

Headers

Header	Value
Authorization	Bearer {token} — a valid access token.

200 OK

{
  "id": "8263a268-5388-492a-bca2-28e1ff4a69f0",
  "status": "waiting"
}

Field	Description
id	Chargeback ID.
status	Current status of the chargeback.

A reported chargeback stays waiting. If the transaction is contested in the portal, the same id shows the progress and the result of the analysis. See Enumerated — Chargeback result for all possible statuses. To optimize performance, implement the Webhook instead of polling this endpoint.