Docs · Referencia

Tarjetas

Lista las tarjetas de débito del titular y congela una. Descongelar se queda en la app de Novo.

Listar las tarjetas de débito

GET/v1/cards

Las tarjetas de débito del titular de la cuenta, con los últimos 4 dígitos y su estado. Nunca se devuelven los números completos ni las fechas de vencimiento. Los nombres de los campos de tarjeta todavía no son definitivos.

Autenticación

Token bearer cuyo cliente tiene el scope cards:read

Respuesta · una lista de Card

dataarray of Card

La página de resultados

Cada elemento de data:

idstringobligatorio

El id de la tarjeta

nicknamestringtexto no confiable

Apodo de la tarjeta, si lo tiene

last_fourstringobligatorio

Últimos 4 dígitos de la tarjeta

statusstringobligatorio

Estado de la tarjeta

typestring

physical o virtual, cuando está disponible

Respuestas

200OK
401Falta el token, venció o es desconocido, o el cliente se revocó o se desactivó
403Al cliente le falta el scope, la situación del titular cambió o la API no está habilitada para este negocio
429Demasiadas solicitudes. Espera lo que indique Retry-After
500Algo falló de forma inesperada del lado de Novo. No se puede reintentar: menciona request_id a soporte
503Algo de lo que depende la respuesta no está disponible. Reintenta después de Retry-After

Solicitud

curl "https://$NOVO_API_HOST/v1/cards" \
  -H "Authorization: Bearer $ACCESS_TOKEN"

Respuesta · 200

{
  "data": [
    {
      "id": "00000000-0000-4000-8000-000000000001",
      "nickname": "Ops card",
      "last_four": "4321",
      "status": "EXAMPLE_STATUS",
      "type": "virtual"
    }
  ]
}

Congelar una tarjeta de débito

POST/v1/cards/{card_id}/freeze

Congela la tarjeta. Congelar una tarjeta que ya está congelada devuelve 200 con el estado actual. No hay un endpoint para descongelar: eso se queda en la app de Novo. card_id debe ser un UUID. Se recomienda un Idempotency-Key, pero no es obligatorio. Una tarjeta que no existe, o que no es del titular, devuelve 404; una tarjeta en un estado que no permite congelarla devuelve 409.

Autenticación

Token bearer cuyo cliente tiene el scope cards:freeze

Parámetros

card_idpath · stringobligatorio

El id de la tarjeta

uuid

Idempotency-Keyheader · string

Una clave que eliges tú, para que un reintento se reconozca como la misma solicitud

máx. 255 caracteres

Respuesta · FreezeResult

card_idstringobligatorio

El id de la tarjeta

uuid

statusstringobligatorio

frozen, también cuando la tarjeta ya estaba congelada

Uno de frozen

request_idstring

Igual que el encabezado Novo-Request-Id

Respuestas

200La tarjeta está congelada
400Un parámetro no es válido. No se puede reintentar
401Falta el token, venció o es desconocido, o el cliente se revocó o se desactivó
403Al cliente le falta el scope, la situación del titular cambió o la API no está habilitada para este negocio
404No hay nada con ese id en el negocio vinculado
409El Idempotency-Key se reutilizó o todavía está en curso, o la tarjeta no se puede congelar
413El cuerpo supera el límite de tamaño. No se puede reintentar
415La operación no acepta el tipo de contenido del cuerpo. No se puede reintentar
429Demasiadas solicitudes. Espera lo que indique Retry-After
500Algo falló de forma inesperada del lado de Novo. No se puede reintentar: menciona request_id a soporte
503Algo de lo que depende la respuesta no está disponible. Reintenta después de Retry-After

Solicitud

curl -X POST "https://$NOVO_API_HOST/v1/cards/00000000-0000-4000-8000-000000000001/freeze" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Authorization: Bearer $ACCESS_TOKEN"

Respuesta · 200

{
  "card_id": "00000000-0000-4000-8000-000000000001",
  "status": "frozen",
  "request_id": "req_example_01"
}