HomepageAutenticaçãoAPI Reference

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:

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
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
post
POST /api/public/v1/walletid/transaction HTTP/1.1
Host: transactions.transactional.uat.unico.app
Authorization: text
Content-Type: application/json
Accept: */*
Content-Length: 347

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

É importante ter atenção com relação a este campo, pois pode impactar negativamente na experiência do usuário no fluxo final, ocasionando problemas no uso do produto.

Como possíveis impactos podemos citar:

  • Baixa conversão:

    • O número do pedido é usado para ajudar o usuário final a realizar a conclusão do fluxo;

  • Erros na API:

    • É possível que você receba erros como: replicated transaction caso seja usado o mesmo número do pedido, cpf, bin e last4.

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
200
Consulta realizada com sucesso.
application/json
get
GET /api/public/v1/walletid/transactions/{transaction_id} HTTP/1.1
Host: transactions.transactional.uat.unico.app
Authorization: text
Accept: */*

{
  "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.

PreviousChargebackNextErros

Last updated

Was this helpful?