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


Validate credit card

post

Endpoint to validate a credit card.

Header parameters
AuthorizationstringRequired

Valid access token. Must be sent in the format "Bearer {token}".

Body
orderNumberstringRequired

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.

Example: 123456
companystringRequired

ID of the company responsible for the transaction. This field is provided by Unico.

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

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.

Example: https://example.com/redirect
valuenumber · floatOptional

Maximum secured value.

Example: 10.5
Responses
200
Transaction created successfully.
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://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"
}

Get the validation status


Check validation status

get

Endpoint to check the current status of a specific transaction.

Path parameters
transaction_idstringRequired

ID of the transaction to be queried.

Example: 6ab1771e-dfab-4e47-8316-2452268e5481
Header parameters
AuthorizationstringRequired

Valid access token. The value must be sent in the format Bearer {token}.

Responses
200
Query successfully executed.
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"
}

To view all possible statuses, refer to the Enumerated section.


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?