Chargeback

In this section, you will find all the technical specifications of the IDPay product REST APIs for managing chargeback transactions

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.

You can learn more about how to generate an access token here.

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

Endpoint to request a chargeback review for a specified transaction.

Path parameters

transaction_idstringRequired

Transaction ID to be submitted for chargeback.

Header parameters

AuthorizationstringRequired

A valid access token. The value must be sent in the format Bearer {token}.

Body

application/json

datetimestring · date-timeRequired

Chargeback request date and time in ISO 8601 format.

Example: 2023-01-05T03:00:00.000Z

namestringRequired

Name of the requestor.

Example: USER_NAME

reasonstringRequired

Reason for the chargeback request.

Example: REQUEST_REASON

observationstringOptional

General observations about the request.

Example: GENERAL_OBSERVATIONS

Responses

200

Chargeback request successful.

application/json

idstringOptional

Generated chargeback ID.

Example: 8263a268-5388-492a-bca2-28e1ff4a69f0

400

Bad request (invalid data).

application/json

403

Access forbidden (invalid token or insufficient permissions).

application/json

404

Transaction not found.

application/json

500

Internal server error.

application/json

post

/credit/transactions/{transaction_id}/chargeback

HTTPcURLJavaScriptPython

POST /api/public/v1/credit/transactions/{transaction_id}/chargeback HTTP/1.1
Host: transactions.transactional.uat.unico.app
Authorization: text
Content-Type: application/json
Accept: */*
Content-Length: 231

{
  "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=="
    }
  ]
}

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

Get chargeback review status

get

Endpoint to check the status of a specific chargeback for a transaction.

Path parameters

transaction_idstringRequired

Transaction ID associated with the chargeback.

chargeback_idstringRequired

Chargeback ID to be retrieved.

Header parameters

AuthorizationstringRequired

A valid access token. The value must be sent in the format Bearer {token}.

Responses

200

Chargeback status retrieved successfully.

application/json

idstringOptional

Chargeback ID.

Example: 8263a268-5388-492a-bca2-28e1ff4a69f0

statusstringOptional

Current status of the chargeback.

Example: waiting

400

Bad request (invalid data).

application/json

403

Access forbidden (invalid token or insufficient permissions).

application/json

404

Transaction or chargeback not found.

application/json

500

Internal server error.

application/json

get

/credit/transactions/{transaction_id}/chargeback/{chargeback_id}

HTTPcURLJavaScriptPython

GET /api/public/v1/credit/transactions/{transaction_id}/chargeback/{chargeback_id} HTTP/1.1
Host: transactions.transactional.uat.unico.app
Authorization: text
Accept: */*

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

To see all possible statuses, refer to the Enumerated section.

To optimize your application's performance, you can also implement our Webhook to know when to query the Chargeback status.