Consultar el estado de un código de compra

GET

/status

const url = 'https://dev-api.tsp.cl/firma_digital/dev/api/partners/v1/status?p_code=example';
const options = {method: 'GET', headers: {'x-gw': '<x-gw>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url 'https://dev-api.tsp.cl/firma_digital/dev/api/partners/v1/status?p_code=example' \
  --header 'x-gw: <x-gw>'

Estado simplificado, sin exponer campos internos — pensado para que un partner integrado vía widget pueda consultar en qué va un usuario sin depender de escuchar eventos del widget en tiempo real.

Authorizations

PartnerApiKey

Parameters

Query Parameters

p_code

required

string

Responses

200

application/json

object

success

boolean

data

object

p_code

string

status

En orden de precedencia (el primero que aplica gana): CANCELLED (anulado, gana incluso sobre uno ya emitido) > EXPIRED (se emitió pero ya venció) > EMITTED (certificado entregado) > LOCKED (bloqueado antes de emitirse) > IN_ONBOARDING (a mitad del flujo del widget) > VALIDATED (identidad verificada, falta certificate_claim, solo B2C) > ACTIVE (existe, nadie lo canjeó) > NOT_FOUND (no existe). VALIDATED e IN_ONBOARDING todavía no forman parte del enum purchase_codes.status del modelo unificado hacia el que se está migrando.

string

Allowed values: NOT_FOUND ACTIVE VALIDATED IN_ONBOARDING EMITTED EXPIRED LOCKED CANCELLED

Example

{
  "success": true,
  "data": {
    "status": "NOT_FOUND"
  }
}

400

Falta el parámetro p_code.

401

API Key inválida o ausente.