v1

latestOpenAPI 3.1.0Copyright Pismo2026-07-247702,7523.1 MB

Automatic Pix

Update payment order amount

Update payment order amount.

patch/inst-pull-pay/v1/pix/automatic/payment/order/{end_to_end_id}

Path parameters

end_to_end_idstring required

Transaction end-to-end ID. This field is a Brazil Central Bank (BCB) requirement to track all Pix transaction steps.

Headers

Authorizationstring required

Example:Bearer eyJhbGci...IUzUx

Account token - an access token encoded with a Pismo account ID. Tokens can expire quickly, which can result in a <b>401 Unauthorized</b> message.

Idempotency-Keystring required

A unique ID to ensure the operation remains idempotent, allowing for operation repitition without causing unintended effects or duplication. An idempotent operation is one that can be applied multiple times, yet the outcome remains the same. it ensures that network errors, retries, or failures can occur without introducing inconsistencies.

x-account-idinteger required

Account ID

Request body

amountnumber

New amount value, can be filled when recurrence has a dynamic amount. Defined by the payee.

Example request

{
  "amount": 101.11,
  "taxes": {
    "tax_identifier": "IS0435879820240605bcdb1fhn43a",
    "records": [
      {
        "tax_type": "IBS",
        "tax_category": "INF",
        "amount": 1050.44
      }
    ]
  }
}

Response

No Content