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

post

Endpoint para validar cartão de crédito.

Header parameters

Authorizationstringrequired

Access-token válido. O valor deve ser enviado no formato Bearer {token}".

Body

identityobjectrequired

Dados de identificação do usuário.

orderNumberstringrequired

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

companystringrequired

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

cardobjectrequired

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]

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 '{
    "identity": {
      "key": "cpf",
      "value": "12345678909"
    },
    "orderNumber": 123456,
    "company": "7873959b-f7b2-4b81-8b0e-4ce178e64daf",
    "redirectUrl": "https://exemplo.com/redirect",
    "card": {
      "binDigits": "12345678",
      "lastDigits": "7890",
      "expirationDate": "12/24",
      "name": "João da Silva"
    },
    "phone": "[phone]",
    "email": "[e-mail]"
  }'

200

400

403

404

500

200

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

Transação criada com sucesso.

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

get

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

Path parameters

transaction_idstringrequired

ID da transação a ser consultada.

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

Header parameters

Authorizationstringrequired

Access-token válido. O valor deve ser enviado no formato 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"
}

Consulta realizada com sucesso.

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.