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.
Credit card validation
Important
The "Credit Card Onboarding" can be performed by either requesting a selfie from the end user and completing the entire registration process, or by reusing the biometric captures from processes executed by other products of the Unico IDCloud platform:
To reuse processes generated by other Unico IDCloud platform products, you must provide the reference process ID in the
additionalInfo.processID
field;The reference processes used must have been completed no more than 1 hour prior.
Endpoint to validate a credit card.
Valid access token. Must be sent in the format "Bearer {token}".
Number associated with the onboarding. This value will be used as an index in the portal and can serve as a foreign key between your system and IDPay.
123456
ID of the company responsible for the transaction. This field is provided by Unico.
7873959b-f7b2-4b81-8b0e-4ce178e64daf
URL to which the user will be redirected after completing the transaction. Possible values include: an HTTPS URL for web redirection or a Schema URL for redirection in native mobile apps.
https://example.com/redirect
Maximum secured value.
10.5
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://example.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/test",
"token": "eyJhbGciOiJIUzI1NiIsInR5cC[...]Ok6yJV_adQssw5c"
}
The orderNumber field must be filled with the UNIQUE order number of that purchase in the e-commerce system, and using a distinct transactional ID is incorrect.
It is important to pay attention to this field, as it may negatively impact the user experience in the final flow, causing issues with product usage.
Possible impacts include:
Low Conversion:
The order number is used to help the end user complete the flow.
API Errors:
You might encounter errors such as "replicated transaction" if the same order number, cpf, BIN, and last4 digits are used.
Get the validation status
Endpoint to check the current status of a specific transaction.
ID of the transaction to be queried.
6ab1771e-dfab-4e47-8316-2452268e5481
Valid access token. The value must be sent in the format Bearer {token}
.
GET /api/public/v1/walletid/transactions/{transaction_id} HTTP/1.1
Host: transactions.transactional.uat.unico.app
Authorization: text
Accept: */*
{
"status": "processing"
}
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.
Last updated
Was this helpful?