Chargeback

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

Request chargeback review

POST /credit/transactions/{transaction_id}/chargeback — requests a chargeback review for a specified transaction.

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",
  "documents": [
    { "label": "FILE_NAME", "data": "JVBERi0xLjQKMSAwI==" }
  ]
}

Field	Type	Required	Description
datetime	string	yes	Chargeback request date and time, 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 request.
observation	string	no	General observations about the request.
documents	array	no	Documents related to the chargeback. Up to 3 items, each Base64-encoded — PDF only.
documents[].label	string	yes (per item)	File name or description.
documents[].data	string	yes (per item)	Base64-encoded PDF file.

200 OK

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

Field	Description
id	Generated chargeback ID.

For error responses, see Errors — Transaction Creation.

Get chargeback review 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.

See Enumerated — Chargeback result for all possible statuses. To optimize performance, implement the Webhook instead of polling this endpoint.