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.

post

/wallet/transactions/pre-approved

Header parameters

Authorizationstringrequired

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

Body

orderNumberstringrequired

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

companystringrequired

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

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]

identityobjectrequired

User identification details.

cardobjectrequired

Card details used in the transaction.

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/wallet/transactions/pre-approved' \
  --header 'Authorization: text' \
  --header 'Content-Type: application/json' \
  --data '{
    "orderNumber": 123456,
    "company": "7873959b-f7b2-4b81-8b0e-4ce178e64daf",
    "redirectUrl": "https://example.com/redirect",
    "phone": "[phone]",
    "email": "[e-mail]",
    "identity": {
      "key": "cpf",
      "value": "12345678909"
    },
    "card": {
      "binDigits": "12345678",
      "lastDigits": "7890",
      "expirationDate": "12/24",
      "name": "João da Silva"
    }
  }'

200

400

403

404

500

200

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

Transaction created successfully.

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.

get

/wallet/transactions/{transaction_id}

Path parameters

transaction_idstringrequired

ID of the transaction to be queried.

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

Header parameters

Authorizationstringrequired

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

Responses

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/wallet/transactions/{transaction_id}' \
  --header 'Authorization: text'

200

400

404

500

200

{
  "status": "processing"
}

Query successfully executed.

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.