Credit card onboarding

---

Before you start

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.

Credit Card Validation

---

Validate credit card

Endpoint to validate a credit card.

POSThttps://transactions.transactional.uat.unico.app/api/public/v1/wallet/transactions/pre-approved

Header parameters

Body

application/json

identity*object

User identification details.

orderNumber*string

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

Example: 123456

company*string

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

Example: "7873959b-f7b2-4b81-8b0e-4ce178e64daf"

redirectUrlstring

URL to redirect the user after completing the transaction. Possible values include an HTTPS URL for web pages or a URL Schema for native mobile app redirection.

Example: "https://example.com/redirect"

card*object

Card details used in the transaction.

phonestring

Phone number for notifications (optional). If provided, it will be used for WhatsApp notifications.

Example: "[phone]"

emailstring

Email address for notifications (optional). If provided, it will be used for email notifications.

Example: "[e-mail]"

Response

200400403404500

Transaction created successfully.

Body

application/json

idstring

Created transaction ID.

Example: "6ab1771e-dfab-4e47-8316-2452268e5481"

statusstring

Current transaction status.

Example: "waiting"

linkstring

Link associated with the transaction.

Example: "https://aces.so/test"

tokenstring

Signed token containing the necessary parameters to initialize Unico IDPay's web SDK.

Example: "eyJhbGciOiJIUzI1NiIsInR5cC[...]Ok6yJV_adQssw5c"

Request

JavaScriptCurlPython

const response = await fetch('https://transactions.transactional.uat.unico.app/api/public/v1/wallet/transactions/pre-approved', {
    method: 'POST',
    headers: {
      "Authorization": "text",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "identity": {
        "key": "cpf",
        "value": "12345678909"
      },
      "orderNumber": 123456,
      "company": "7873959b-f7b2-4b81-8b0e-4ce178e64daf",
      "card": {
        "binDigits": "12345678",
        "lastDigits": "7890",
        "name": "João da Silva"
      }
    }),
});
const data = await response.json();

Response

200400403404500

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

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

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

Get the validation status

---

Get validation status

Endpoint to check the current status of a specific transaction.

GEThttps://transactions.transactional.uat.unico.app/api/public/v1/wallet/transactions/{transaction_id}

Path parameters

transaction_id*string

ID of the transaction to be queried.

Example: "6ab1771e-dfab-4e47-8316-2452268e5481"

Header parameters

Response

200400404500

Query successfully executed.

Body

application/json

statusstring

Current status of the transaction.

Example: "processing"

Request

JavaScriptCurlPython

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

Response

200400404500

{
  "status": "processing"
}

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

To optimize your application's performance, you can also implement our Webhook to know when to check the transaction 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.