Onboarding de cartão de crédito

---

Antes de começar

---

Suas requisições de API são autenticadas utilizando um access-token. Qualquer requisição que não inclua um access-token válido retornará um erro.

Você pode ver mais sobre como gerar um access-token aqui.

Endpoints:

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

• Produção: https://transactions.transactional.unico.app/api/public/v1.

Validação do cartão de crédito

---

Validar cartão de crédito

Endpoint para validar cartão de crédito.

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

Header parameters

Body

application/json

identity*object

Dados de identificação do usuário.

orderNumber*string

Número do pedido associado à transação. É o dado que será utilizado como indexador no portal e você pode utilizar como forma de associação (foreign key) entre seu sistema e o IDPay.

Example: 123456

company*string

ID da empresa responsável pela transação. Este campo é fornecido pela Unico.

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

redirectUrlstring

URL para onde o usuário será redirecionado após finalizar a transação. Valores possíveis são: Uma URL HTTPS para redirecionar páginas web ou uma URL Schema para redirecionamento em aplicações móveis nativas.

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

card*object

Informações do cartão utilizado na transação.

phonestring

Telefone para notificação. O parâmetro é opcional. Caso enviado, será utilizada para notificação via WhatsApp.

Example: "[phone]"

emailstring

E-mail para notificação. O parâmetro é opcional. Caso enviado, será utilizada para notificação via e-mail.

Example: "[e-mail]"

Response

200400403404500

Transação criada com sucesso.

Body

application/json

idstring

ID da transação criada.

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

statusstring

Status atual da transação.

Example: "waiting"

linkstring

Link relacionado à transação.

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

tokenstring

Token assinado que contém os parâmetros necessários para inicializar o SDK web do Unico IDPay.

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/teste",
  "token": "eyJhbGciOiJIUzI1NiIsInR5cC[...]Ok6yJV_adQssw5c"
}

Caso as validações realizadas decidam que não é necessário realizar a captura da biometria, a resposta de retorno terá um status diferente e não será gerado um link para a captura, como a seguir:

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

Consulta do status da validação

---

Consultar status de validação

Endpoint para consultar o status atual de uma transação específica.

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

Path parameters

transaction_id*string

ID da transação a ser consultada.

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

Header parameters

Response

200400404500

Consulta realizada com sucesso.

Body

application/json

statusstring

Status atual da transação.

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"
}

Para ver todos os status possíveis, consulte a seção Enumerados.

Para otimizar a performance da sua aplicação, você também pode implementar nosso Webhook para saber quando realizar a consulta do status da transação.

---

Dúvidas?​

Não encontrou algo ou ainda precisa de ajuda? Se já é um cliente ou parceiro, pode entrar em contato através da Central de Ajuda.