Skip to main content

Credentials API

Una credencial es la entidad que contiene los accesos a una procesadora y el estado del mismo

Campos de una credencial

CampoTipoDescripción
idstringUUID único de la credencial
usernamestringNombre de usuario
other_loginnull o stringOtro método de login (opcional)
statusstringEstado de la credencial Ver statuses
status_codenull o string Código de estado (opcional)
info_providerstringProveedor de información Ver info_providers
account_idstringIdentificador único de la cuenta
establishmentsarrayLista de establecimientos

Estados de una credencial:

EstadoDescripción
okCredencial activa y funcional
expiredCredencial expirada
blockedCredencial bloqueada
pendingCredencial pendiente
incorrectInformación incorrecta
disabledCredencial deshabilitada
deletedCredencial 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 optativosTipoDescripción
PageIntegerIndica la página a obtener resultados.
per_pageIntegerCantidad de resultados por página (Máximo 40)
statusString[]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
}