Payment transactions

In this section, you will find all the technical specifications of the IDPay product REST APIs for managing payment 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.

Endpoints:

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

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

Transaction creation

---

Create Transaction

Endpoint to create a new transaction.

post

/credit/transaction

Header parameters

Authorizationstringrequired

Valid access token. The value must be sent in the format "Bearer {token}".

Body

orderNumberstringrequired

Order number associated with the transaction. This data will be used as an index in the portal and can be used as a foreign key between your system and IDPay.

Example: 123456

companystringrequired

ID of the company responsible for the transaction. This field is provided by Unico.

Example: f44f02e5-320e-497b-b346-8cf19b3ee2a4

redirectUrlstring

URL to which the user will be redirected after completing the transaction. Possible values are: An https URL to redirect web pages or a URL Schema for redirection in native mobile applications.

Example: https://example.com/redirect

valuenumber · floatrequired

Total purchase value.

Example: 100.5

phonestring

Notification phone number. This parameter is optional, and if provided, a WhatsApp notification will be sent to the user.

Example: 5511998551010

emailstring

Notification email. This parameter is optional, and if provided, an email notification will be sent to the user.

Example: [e-mail]

identityobjectrequired

User identification data.

cardobjectrequired

Information about the card used in the transaction.

additionalInfoobject

Additional information about the transaction. Currently, the following additional information can be sent: Seller: Information about the seller of that transaction. Seller identification (CPF or CNPJ) can be provided.

Responses

application/json

application/json

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://transactions.transactional.uat.unico.app/api/public/v1/credit/transaction' \
  --header 'Authorization: text' \
  --header 'Content-Type: application/json' \
  --data '{
    "orderNumber": "123456",
    "company": "f44f02e5-320e-497b-b346-8cf19b3ee2a4",
    "redirectUrl": "https://example.com/redirect",
    "value": 100.5,
    "phone": "5511998551010",
    "email": "[e-mail]",
    "identity": {
      "key": "cpf",
      "value": "USER_CPF"
    },
    "card": {
      "binDigits": "12345678",
      "lastDigits": "7890",
      "expirationDate": "12/24",
      "name": "João da Silva"
    },
    "additionalInfo": {
      "seller": {
        "identity": {
          "key": "cpf",
          "value": "12345678909"
        }
      }
    }
  }'

200

400

403

404

500

200

{
  "id": "6ab1771e-dfab-4e47-8316-2452268e5481",
  "status": "waiting",
  "link": "https://aces.so/test",
  "token": "eyJhbGciOiJIUzI1NiIsInR5cC[...]Ok6yJV_adQssw5c"
}

Transaction successfully created.

The orderNumber field must be filled with the UNIQUE order number of that purchase in the e-commerce system, and using a distinct transactional ID is incorrect.

It is important to pay attention to this field, as it may negatively impact the user experience in the final flow, causing issues with product usage.

Possible impacts include:

• Low Conversion:

  • The order number is used to help the end user complete the flow.

• API Errors:

  • You might encounter errors such as "replicated transaction" if the same order number, BIN, and last4 digits are used.

Note: If the company is configured to reuse transactions with the same data, please refer to the "Transaction Reuse" section.

If the validations determine that biometric capture is not required, the response will have a different status, and a capture link will not be generated, as shown below:

{
    "id": "6ab1771e-dfab-4e47-8316-2452268e5481",
    "status": "fast-inconclusive"
}

This scenario will occur if you use the Pre or Super Pre modules, for cases where you use IDPay in the Checkout, as specified in the Features section.

Reuse of Transactions

---

It is possible to configure the company to reuse transactions that have the same data, avoiding "replicated transaction" errors. The reuse will occur under the following conditions:

• A transaction is being created with the same orderNumber, identity.key, identity.value, company, card.binDigits, card.lastDigits, and value of a previously created transaction.

• The previous transaction has not yet exceeded the expiration time configured for the company.

If the transaction to be created and the previous transaction do not meet these conditions, a new transaction will be created. Otherwise, the following are the possible responses:

If the previous transaction is in a final status, such as approved or inconclusive:

{
    // previous transaction information
    "id": "6ab1771e-dfab-4e47-8316-2452268e5481",
    "status": "approved"
}

If the previous transaction is still in an initial status, such as waiting or shared:

{
    // previous transaction information
    "id": "6ab1771e-dfab-4e47-8316-2452268e5481",
    "status": "waiting",
    "link": "https://aces.so/teste",
    "token": "eyJhbGciOiJIUzI1NiIsIn[...]dQssw5c"
}

In this last case, the transaction still in an initial status will have its expiration date recalculated, based on the date of this request.

Transaction status query

---

Get Transaction Status

Endpoint to check the current status of a specific transaction.

get

/credit/transactions/{transaction_id}

Path parameters

transaction_idstringrequired

Transaction ID to check the status.

Header parameters

Authorizationstringrequired

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

Responses

application/json

application/json

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://transactions.transactional.uat.unico.app/api/public/v1/credit/transactions/{transaction_id}' \
  --header 'Authorization: text'

200

400

403

404

500

200

{
  "status": "processing"
}

Transaction status retrieved successfully.

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

To optimize the performance of your application, you can also implement our Webhook to know when to check the transaction status. See more in the Webhook section.

Obtaining the set of evidence for the transaction

---

The evidence set can only be generated for approved transactions.

Get Transaction Evidence Set

Endpoint to get the evidence set of a specific transaction.

get

/credit/transactions/{transaction_id}/probative

Path parameters

transaction_idstringrequired

ID of the transaction for which the evidence set will be retrieved.

Header parameters

Authorizationstringrequired

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

Responses

application/json

application/json

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://transactions.transactional.uat.unico.app/api/public/v1/credit/transactions/{transaction_id}/probative' \
  --header 'Authorization: text'

200

400

403

404

500

200

{
  "link": "https://unico.io/probative.pdf"
}

Probative file link retrieved successfully.

The link returned for the evidence set is valid for five minutes after it is obtained. Therefore, it is important that this link is not saved, but rather used to download the evidence set.

Resending the transaction notification

---

Resend transaction notification

Endpoint to resend notifications via email and/or phone for a specific transaction.

post

/credit/transactions/{transaction_id}/notify

Path parameters

transaction_idstringrequired

Transaction ID for which the notification will be sent.

Header parameters

Authorizationstringrequired

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

Body

phonestringrequired

Phone number to send the notification.

Example: NOTIFICATION_PHONE

emailstringrequired

Email address to send the notification.

Example: NOTIFICATION_EMAIL

Responses

application/json

application/json

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://transactions.transactional.uat.unico.app/api/public/v1/credit/transactions/{transaction_id}/notify' \
  --header 'Authorization: text' \
  --header 'Content-Type: application/json' \
  --data '{
    "phone": "NOTIFICATION_PHONE",
    "email": "NOTIFICATION_EMAIL"
  }'

200

400

403

404

500

200

{
  "id": "b50ee24c-71eb-4a5d-ade1-41c48b44c240",
  "link": "https://aces.so/example"
}

Notification sent successfully.

It is also possible to configure the resending of notifications through the portal, without the need to implement it via API. To understand the possibilities, speak with the person responsible for your project.

---

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.