Revoke a hub subscription

Soft-deletes the tenant’s subscription. Idempotent: revoking an already-revoked subscription succeeds.

Partner route: the text above describes the tenant’s own route. Here the register id in the path names the fund or originador the partner acts for: it must be in the partner credential’s scope and registered under the caller’s tenant. The partner sees and manages only the subscriptions it created through this register’s routes: the party’s own subscriptions and any other partner’s answer 404, as a missing one does. An originador the bancarizador deactivated is refused 403 ORIGINADOR_DEACTIVATED until it is reactivated.

DELETE /v1/consignado/originadores/{originador_id}/subscriptions/{id}

Revoke a hub subscription

cURL

curl --request DELETE \
  --url https://br-consignado-gw.sandbox.lerian.net/v1/consignado/originadores/{originador_id}/subscriptions/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'X-Idempotency: <x-idempotency>'

422

{
  "code": "AUT-0033",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example",
  "upstream": {
    "code": "E4001",
    "message": "account not found at provider"
  }
}

Autorizaciones

Authorization · string · header · requerido

JWT bearer token issued by the identity provider.

Encabezados

Authorization · string

Bearer token. A tenant route relays it to the streaming-hub as server-to-server auth.

X-Idempotency · string · requerido

Idempotency key, forwarded to the hub's idempotency middleware, which refuses this mutation without one.

Parámetros de ruta

originador_id · string<uuid> · requerido

The originador's register id, as returned in the id field of GET /v1/consignado/originadores. It must be in the partner credential's scope.

Ejemplo:

"6f1c2a3b-4d5e-4f60-8a7b-9c0d1e2f3a4b"

id · string · requerido

Subscription id.

Respuesta

204

No Content