Claim a Pix Automático recurrence for the calling engine

The engine that authorizes a recurrence claims it, and the Courier then routes the recurrence’s messages to it. 201: the recurrence is now the caller’s. 204: it already was. 409 JDC-0102: another engine holds it; stop and report it to an operator, because only an operator moves a recurrence. 422 JDC-0104: the recurrenceId is not usable. 503: nothing was recorded; send the same claim again, it is idempotent. The owner is always the caller: an engine claims only for itself, and only a key no engine holds.

PUT /v1/ownership/recurrences/{recurrenceId}

Claim a Pix Automático recurrence for the calling engine

cURL

curl --request PUT \
  --url https://api.example.com/v1/ownership/recurrences/{recurrenceId} \
  --header 'Authorization: Bearer <token>'

400

{
  "code": "<string>",
  "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

An Access Manager application token whose subject is bound to exactly one engine; an engine may hold several, one per calling product. It reaches only the operations its scopes name; the operator surface refuses it.

Scopes

ownership:write

Claim accounts, charger documents or a Pix Automático recurrence, or declare a Pix Automático payment leg, for the calling engine alone

Parámetros de ruta

recurrenceId · string · requerido

The idRecorrencia as JD issued it.

Respuesta

201

Created