1 of 1

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.

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

Endpionts:

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

Chargeback Analysis Request

Check the status of the chargeback analysis

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.

Still need help?

Didn't find something or still need help? If you're already a client or partner, you can reach out through our Help Center.

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.

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

Endpionts:

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

Chargeback Analysis Request

Request chargeback review

Endpoint to request a chargeback review for a specified transaction.

POSThttps://transactions.transactional.uat.unico.app/api/public/v1/credit/transactions/{transaction_id}/chargeback

Path parameters

transaction_id*string

Transaction ID to be submitted for chargeback.

Header parameters

Authorization*string

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

Body

datetime*string (date-time)

Chargeback request date and time in ISO 8601 format.

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

requestor*object

Requestor's information.

key*string

Identification key type for the requestor.

Example: "cpf"

value*string

Identification key value for the requestor.

Example: "USER_CPF"

name*string

Name of the requestor.

Example: "USER_NAME"

reason*string

Reason for the chargeback request.

Example: "REQUEST_REASON"

observationstring

General observations about the request.

Example: "GENERAL_OBSERVATIONS"

documents*array of object

Documents related to the chargeback. Up to 3 items are allowed, and each document must be Base64 encoded. Only PDF files are accepted.

label*string

File name or description.

Example: "FILE_NAME"

data*string

Base64 encoded PDF file.

Example: "JVBERi0xLjQKMSAwI=="

Response

Chargeback request successful.

Body

idstring

Generated chargeback ID.

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

Request

Response

Check the status of the chargeback analysis

Get chargeback review status

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

GEThttps://transactions.transactional.uat.unico.app/api/public/v1/credit/transactions/{transaction_id}/chargeback/{chargeback_id}

Path parameters

transaction_id*string

Transaction ID associated with the chargeback.

chargeback_id*string

Chargeback ID to be retrieved.

Header parameters

Authorization*string

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

Response

Chargeback status retrieved successfully.

Body

idstring

Chargeback ID.

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

statusstring

Current status of the chargeback.

Example: "waiting"

Request

const response = await fetch('https://transactions.transactional.uat.unico.app/api/public/v1/credit/transactions/{transaction_id}/chargeback/{chargeback_id}', {
    method: 'GET',
    headers: {
      "Authorization": "text"
    },
});
const data = await response.json();

Response

{
  "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.

Still need help?

Didn't find something or still need help? If you're already a client or partner, you can reach out through our Help Center.

Request chargeback review

Endpoint to request a chargeback review for a specified transaction.

POSThttps://transactions.transactional.uat.unico.app/api/public/v1/credit/transactions/{transaction_id}/chargeback

Path parameters

transaction_id*string

Transaction ID to be submitted for chargeback.

Header parameters

Authorization*string

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

Body

datetime*string (date-time)

Chargeback request date and time in ISO 8601 format.

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

requestor*object

Requestor's information.

key*string

Identification key type for the requestor.

Example: "cpf"

value*string

Identification key value for the requestor.

Example: "USER_CPF"

name*string

Name of the requestor.

Example: "USER_NAME"

reason*string

Reason for the chargeback request.

Example: "REQUEST_REASON"

observationstring

General observations about the request.

Example: "GENERAL_OBSERVATIONS"

documents*array of object

Documents related to the chargeback. Up to 3 items are allowed, and each document must be Base64 encoded. Only PDF files are accepted.

label*string

File name or description.

Example: "FILE_NAME"

data*string

Base64 encoded PDF file.

Example: "JVBERi0xLjQKMSAwI=="

Response

Chargeback request successful.

Body

idstring

Generated chargeback ID.

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

Request

Response

const response = await fetch('https://transactions.transactional.uat.unico.app/api/public/v1/credit/transactions/{transaction_id}/chargeback', {
    method: 'POST',
    headers: {
      "Authorization": "text",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "datetime": "2023-01-05T03:00:00.000Z",
      "requestor": {
        "key": "cpf",
        "value": "USER_CPF"
      },
      "name": "USER_NAME",
      "reason": "REQUEST_REASON",
      "documents": [
        {
          "label": "FILE_NAME",
          "data": "JVBERi0xLjQKMSAwI=="
        }
      ]
    }),
});
const data = await response.json();

Get chargeback review status

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

GEThttps://transactions.transactional.uat.unico.app/api/public/v1/credit/transactions/{transaction_id}/chargeback/{chargeback_id}

Path parameters

transaction_id*string

Transaction ID associated with the chargeback.

chargeback_id*string

Chargeback ID to be retrieved.

Header parameters

Authorization*string

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

Response

Chargeback status retrieved successfully.

Body

idstring

Chargeback ID.

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

statusstring

Current status of the chargeback.

Example: "waiting"

Request

const response = await fetch('https://transactions.transactional.uat.unico.app/api/public/v1/credit/transactions/{transaction_id}/chargeback/{chargeback_id}', {
    method: 'GET',
    headers: {
      "Authorization": "text"
    },
});
const data = await response.json();

Response

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

Chargeback

Before you begin

Chargeback Analysis Request

Check the status of the chargeback analysis

Still need help?​

Chargeback

Before you begin

Chargeback Analysis Request

Request chargeback review

Check the status of the chargeback analysis

Get chargeback review status

Still need help?​

Request chargeback review

Get chargeback review status

Still need help?

Still need help?