Volver a la referencia

Autenticación

Llaves secretas por ambiente y el recurso /me.

Cada petición autenticada lleva tu llave en Authorization: Bearer o en X-API-Key. El formato es sk_test_<id>.<secreto> o sk_live_<id>.<secreto>. El comercio (MID) sale de la llave: no va en la ruta. Crea y rota las llaves en el panel. Los POST de cobro, transferencia, verificación y cuentas de depósito exigen Idempotency-Key. Los cuerpos y respuestas de la API pública van en camelCase (merchantId, orderReference, settledAt).

GET

Comprobar la llave

/api/v1/me

Devuelve el comercio, el ambiente y los scopes de la llave.

Parámetros

Authorization
header
stringObligatorio

Bearer $CLOBEPAY_API_KEY. También se acepta X-API-Key con el mismo valor. No envíes ambos.

Respuestas

  • HTTP 200Llave válida.

Errores

  • HTTP 400ambiguous_credentialsAuthorization: Bearer y X-API-Key traen llaves distintas.
  • HTTP 401missing_credentialsNo enviaste la llave (Authorization: Bearer o X-API-Key).
  • HTTP 401invalid_api_keyLa llave no existe, está mal formada o no coincide.
  • HTTP 401api_key_revokedLa llave fue revocada.
  • HTTP 401api_key_expiredLa llave expiró.
  • HTTP 401api_key_wrong_environmentLa llave es de otro ambiente (llave de prueba en producción o al revés).
  • HTTP 403insufficient_scopeLa llave no tiene el scope de esta ruta.
  • HTTP 429rate_limitedDemasiadas peticiones. Respeta Retry-After.
GET/me
curl -X GET "$CLOBEPAY_API_BASE/me" \  -H "Authorization: Bearer $CLOBEPAY_API_KEY"

Respuesta

HTTP 200
{
  "merchantId": "MID000847",
  "merchantName": "Comercial del Valle",
  "environment": "test",
  "scopes": [
    "payment_links:read",
    "payment_links:write",
    "payins:read"
  ],
  "apiKeyId": "2a581389-bc78-4a05-b2ad-15d24803fee0"
}