Onboarding de cartão de crédito

Nesta seção, você encontrará todos as especificações técnicas das REST APIs do produto IDPay para gerenciar transações de 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.

Base URL:

• 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

Importante

• É possível realizar o "Onboarding do cartão de crédito" solicitando a selfie do usuário final e realizando todo o cadastro OU reutilizar as capturas biométricas dos processos de outros produtos da plataforma Unico IDCloud:

  • Para reutilizar os processos gerados pelos outros produtos da plataforma Unico IDCloud você deve informar o ID do processo de referencia no campo additionalInfo.processID;

  • Os processos de referência que serão utilizados devem ter sido concluídos em no máximo 1 hora.

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

application/json

orderNumberstringRequired

Número associado ao onboarding. É 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

redirectUrlstringOptional

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

valuenumber · floatOptional

Valor máximo assegurado.

Example: 10.5

Responses

200

Transação criada com sucesso.

application/json

idstringOptional

ID da transação criada.

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

statusstringOptional

Status atual da transação.

Example: waiting

linkstringOptional

Link relacionado à transação (este link só será retornado caso não envie o parâmetro additionalInfo.processID).

Example: https://aces.so/teste

tokenstringOptional

Token assinado que contém os parâmetros necessários para inicializar o SDK web do Unico IDPay (este token só será retornado caso não envie o parâmetro additionalInfo.processID).

Example: eyJhbGciOiJIUzI1NiIsInR5cC[...]Ok6yJV_adQssw5c

400

Dados inválidos na requisição.

application/json

403

Proibição de acesso (token inválido ou permissões insuficientes).

application/json

404

Recurso não encontrado.

application/json

500

Erro interno do servidor.

application/json

post

/walletid/transaction

HTTPcURLJavaScriptPython

POST /api/public/v1/walletid/transaction HTTP/1.1
Host: transactions.transactional.uat.unico.app
Authorization: text
Content-Type: application/json
Accept: */*
Content-Length: 349

{
  "identity": {
    "key": "cpf",
    "value": "12345678909"
  },
  "orderNumber": "123456",
  "company": "7873959b-f7b2-4b81-8b0e-4ce178e64daf",
  "redirectUrl": "https://exemplo.com/redirect",
  "card": {
    "binDigits": "87654321",
    "lastDigits": "7890",
    "expirationDate": "12/24",
    "name": "João da Silva"
  },
  "value": 10.5,
  "additionalInfo": {
    "processID": "6ab1771e-dfab-4e47-8316-2452268e5481"
  }
}

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

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

200

Consulta realizada com sucesso.

application/json

statusstringOptional

Status atual da transação.

Example: processing

hasIdentityChangedbooleanOptional

Se houve troca de identidade na transação (opcional).

Example: false

400

Dados inválidos na requisição.

application/json

403

Proibição de acesso (token inválido ou permissões insuficientes).

application/json

404

Transação não encontrada.

application/json

500

Erro interno do servidor.

application/json

get

/walletid/transactions/{transaction_id}

HTTPcURLJavaScriptPython

GET /api/public/v1/walletid/transactions/{transaction_id} HTTP/1.1
Host: transactions.transactional.uat.unico.app
Authorization: text
Accept: */*

{
  "status": "processing",
  "hasIdentityChanged": false
}

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.