Declare an earlier leg of a Pix Automático payment the calling engine holds

Before the Courier takes over Pix, each engine declares the payments in flight whose earlier leg it already answered yes: the debit block (block) of every payment whose debit or reversal is still to come, and the schedule (schedule) of every schedule whose debit, reversal or cancellation status is still to come; with no accepted block, the debit and its reversal follow the schedule. Those later legs then reach the caller. A later leg that arrived first is retained and is released by the Courier’s re-check once its leg is declared. A leg the Courier itself dispatched outranks any declaration unless its engine answered other than yes. 201: the leg now follows the caller. 204: it already did. 409 JDC-0116: the Courier’s record gives the leg to another engine, or holds the caller’s answer to the block that was not a yes; stop and report it to an operator. 422 JDC-0104: the leg or the endToEndId is not usable. 503: nothing may have been recorded; send the same declaration again, it is idempotent. The holder is always the caller.

PUT /v1/ownership/payments/{endToEndId}/legs/{leg}

Declare an earlier leg of a Pix Automático payment the calling engine holds

cURL

curl --request PUT \
  --url https://api.example.com/v1/ownership/payments/{endToEndId}/legs/{leg} \
  --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

endToEndId · string · requerido

The payment's endToEndId as JD sent it.

leg · enum<string> · requerido

block: the debit block a debit and its reversal follow. schedule: the schedule its cancellation status follows, and its debit and reversal when no block was accepted.

Opciones disponibles: block, schedule

Respuesta

201

Created