Credentials API
Una credencial es la entidad que contiene los accesos a una procesadora y el estado del mismo
Campos de una credencial
Campo | Tipo | Descripción |
---|---|---|
id | string | UUID único de la credencial |
username | string | Nombre de usuario |
other_login | null o string | Otro método de login (opcional) |
status | string | Estado de la credencial Ver statuses |
status_code | null o string | Código de estado (opcional) |
info_provider | string | Proveedor de información Ver info_providers |
account_id | string | Identificador único de la cuenta |
establishments | array | Lista de establecimientos |
Estados de una credencial:
Estado | Descripción |
---|---|
ok | Credencial activa y funcional |
expired | Credencial expirada |
blocked | Credencial bloqueada |
pending | Credencial pendiente |
incorrect | Información incorrecta |
disabled | Credencial deshabilitada |
deleted | Credencial eliminada |
Obtener todas las credenciales
GET
https://gateway.increase.app/card/v2/credentials
Headers
Content-Type: application/json
Authorization: Bearer <access_token>
Tenant: argentina
curl --include \
--header "Content-Type: application/json" \
--header "Tenant: argentina" \
--header "Authorization: Bearer <tu_access_token>" \
'https://gateway.increase.app/card/v2/credentials'
Parámetros optativos | Tipo | Descripción |
---|---|---|
Page | Integer | Indica la página a obtener resultados. |
per_page | Integer | Cantidad de resultados por página (Máximo 40) |
status | String[] | Array de statuses que para filtrar (Ver credential status) |
Success response
{
"data": [
{
"id": "00000000-0000-0000-0000-000000000000",
"username": "username",
"other_login": null,
"status": "ok",
"status_code": null,
"info_provider": "naranja_regular",
"account_id": "00000000-0000-0000-0000-000000000000",
"establishments": [],
"automatic_renewal": false,
"autorenewable": false
}
],
"current_page": "1",
"per_page": 20,
"total_pages": 2,
"total_elements": 37
}
Obtener una credencial específica
GET
https://gateway.increase.app/card/v2/credentials/<credential_id>
Headers
Content-Type: application/json
Authorization: Bearer <access_token>
Tenant: argentina
curl --include \
--header "Content-Type: application/json" \
--header "Tenant: argentina" \
--header "Authorization: Bearer <tu_access_token>" \
'https://gateway.increase.app/card/v2/credentials/<credential_id>'
Success response
{
"id": "00000000-0000-0000-0000-000000000000",
"username": "username",
"other_login": null,
"status": "ok",
"status_code": null,
"info_provider": "naranja_regular",
"account_id": "00000000-0000-0000-0000-000000000000",
"establishments": [],
"automatic_renewal": false,
"autorenewable": false
}
Crear una credencial
POST
https://gateway.increase.app/card/v2/credentials
Headers
Content-Type: application/json
Authorization: Bearer <access_token>
Tenant: argentina
Body
{
"account_id": "string",
"info_provider": "string",
"username": "string",
"password": "string",
"other_login": "string",
"country": "argentina"
}
curl --include \
--header "Content-Type: application/json" \
--header "Tenant: argentina" \
--header "Authorization: Bearer <tu_access_token>" \
--data '{
"username": "usuario_ejemplo",
"password": "contraseña_ejemplo",
"other_login": "egunda_contraseña_ejemplo",
"info_provider": "naranja_regular",
"account_id": "00000000-0000-0000-0000-000000000000",
"country": "argentina"
}' \
'https://gateway.increase.app/card/v2/credentials'
Success response
{
"id": "00000000-0000-0000-0000-000000000000",
"username": "usuario_ejemplo",
"other_login": null,
"status": "ok",
"status_code": null,
"info_provider": "naranja_regular",
"account_id": "00000000-0000-0000-0000-000000000000",
"establishments": [],
"automatic_renewal": false,
"autorenewable": false
}
Actualizar una credencial específica
PUT
https://gateway.increase.app/card/v2/credentials/<credential_id>
Headers
Content-Type: application/json
Authorization: Bearer <access_token>
Tenant: argentina
Body
{
"username": "string",
"password": "string",
"other_login": "string",
}
curl --include \
--header "Content-Type: application/json" \
--header "Tenant: argentina" \
--header "Authorization: Bearer <tu_access_token>" \
--data '{
"username": "nuevo_usuario",
"password": "nueva_contraseña",
"other_login": "nueva_segunda_contraseña",
}' \
'https://gateway.increase.app/card/v2/credentials/<credential_id>'
Success response
{
"id": "00000000-0000-0000-0000-000000000000",
"username": "nuevo_usuario",
"password": "nueva_contraseña",
"other_login": "nueva_segunda_contraseña",
"status": "ok",
"status_code": null,
"info_provider": "naranja_regular",
"account_id": "00000000-0000-0000-0000-000000000000",
"establishments": [],
"automatic_renewal": true,
"autorenewable": false
}
Modificar estado de credencial
PUT
https://gateway.increase.app/card/v2/credentials/<credential_id>/set_status
Headers
Content-Type: application/json
Authorization: Bearer <access_token>
Tenant: argentina
Body
{
"status": "<new_status>"
}
curl --include \
--header "Content-Type: application/json" \
--header "Tenant: argentina" \
--header "Authorization: Bearer <tu_access_token>" \
--data '{
"status": "deleted",
}' \
'https://gateway.increase.app/card/v2/credentials/<credential_id>/set_status'
Success response
{
"id": "00000000-0000-0000-0000-000000000000",
"username": "usuario",
"other_login": null,
"status": "deleted",
"status_code": null,
"info_provider": "naranja_regular",
"account_id": "00000000-0000-0000-0000-000000000000",
"establishments": [],
"automatic_renewal": true,
"autorenewable": false
}