curl --request PATCH \
  --url https://api.example.com/pixauto/v1/payer/authorizations/{authorization_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/merge-patch+json' \
  --header 'X-Account-Id: <x-account-id>' \
  --header 'X-Idempotency: <x-idempotency>' \
  --data '
{
  "creditLineEnabled": false,
  "maximumAmount": {
    "amount": "250.00",
    "currency": "BRL"
  },
  "schedulingNotificationsEnabled": false
}
'

{
  "authorizedAt": "2026-08-27T19:18:38Z",
  "createdAt": "2026-08-27T19:18:38Z",
  "id": "01a044a8-f3bd-7488-a0dc-e8d4be4802be",
  "journey": "JOURNEY_1",
  "parameters": {
    "creditLineEnabled": false,
    "maximumAmount": {
      "amount": "250.00",
      "currency": "BRL"
    },
    "schedulingNotificationsEnabled": false
  },
  "recurrenceId": "RR12345678202608276bca619e690",
  "status": "APPROVED",
  "updatedAt": "2026-08-27T19:20:00Z"
}

{
  "code": "PIX-0142",
  "message": "claim_id is required",
  "title": "Invalid Claim Request",
  "fields": {},
  "headers": {},
  "paths": {},
  "query_params": {},
  "raw": {
    "message": "upstream provider returned 503",
    "status": 123
  }
}

{
  "code": "PIX-0004",
  "message": "Invalid or expired authentication credentials.",
  "title": "Unauthorized"
}

{
  "code": "PIX-0005",
  "message": "You do not have permission to perform this operation.",
  "title": "Forbidden"
}

{
  "code": "PIX-0142",
  "message": "claim_id is required",
  "title": "Invalid Claim Request",
  "fields": {},
  "headers": {},
  "paths": {},
  "query_params": {},
  "raw": {
    "message": "upstream provider returned 503",
    "status": 123
  }
}

{
  "code": "PIX-0142",
  "message": "claim_id is required",
  "title": "Invalid Claim Request",
  "fields": {},
  "headers": {},
  "paths": {},
  "query_params": {},
  "raw": {
    "message": "upstream provider returned 503",
    "status": 123
  }
}

{
  "code": "PIX-0142",
  "message": "claim_id is required",
  "title": "Invalid Claim Request",
  "fields": {},
  "headers": {},
  "paths": {},
  "query_params": {},
  "raw": {
    "message": "upstream provider returned 503",
    "status": 123
  }
}

{
  "code": "PIX-0016",
  "message": "The request body must be sent with Content-Type: application/json.",
  "title": "Unsupported Media Type"
}

{
  "code": "PIX-0142",
  "message": "claim_id is required",
  "title": "Invalid Claim Request",
  "fields": {},
  "headers": {},
  "paths": {},
  "query_params": {},
  "raw": {
    "message": "upstream provider returned 503",
    "status": 123
  }
}

{
  "code": "PIX-0000",
  "message": "The server encountered an unexpected error. Please try again later.",
  "title": "Internal Server Error"
}

{
  "code": "PIX-0142",
  "message": "claim_id is required",
  "title": "Invalid Claim Request",
  "fields": {},
  "headers": {},
  "paths": {},
  "query_params": {},
  "raw": {
    "message": "upstream provider returned 503",
    "status": 123
  }
}

Update the payer-configurable parameters of an authorization

RFC 7386 JSON Merge Patch over the three payer-configurable parameters of Guia v1.2 §6. Setting a property to null resets it to its NORMATIVE default; omitting it leaves it unchanged. The two toggles default to enabled, so a reset is not an opt-out.

A change never reaches debits already scheduled. The maximum amount in force at scheduling time is snapshotted on the debit and prevails (Guia v1.2 §6.1); the new value applies to future scheduling only.

The maximum amount never leaves this PSP: it is not shared with the receiving user or their PSP (Guia v1.2 §6.1).

PATCH

payer

authorizations

{authorization_id}

curl --request PATCH \
  --url https://api.example.com/pixauto/v1/payer/authorizations/{authorization_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/merge-patch+json' \
  --header 'X-Account-Id: <x-account-id>' \
  --header 'X-Idempotency: <x-idempotency>' \
  --data '
{
  "creditLineEnabled": false,
  "maximumAmount": {
    "amount": "250.00",
    "currency": "BRL"
  },
  "schedulingNotificationsEnabled": false
}
'

{
  "authorizedAt": "2026-08-27T19:18:38Z",
  "createdAt": "2026-08-27T19:18:38Z",
  "id": "01a044a8-f3bd-7488-a0dc-e8d4be4802be",
  "journey": "JOURNEY_1",
  "parameters": {
    "creditLineEnabled": false,
    "maximumAmount": {
      "amount": "250.00",
      "currency": "BRL"
    },
    "schedulingNotificationsEnabled": false
  },
  "recurrenceId": "RR12345678202608276bca619e690",
  "status": "APPROVED",
  "updatedAt": "2026-08-27T19:20:00Z"
}

{
  "code": "PIX-0142",
  "message": "claim_id is required",
  "title": "Invalid Claim Request",
  "fields": {},
  "headers": {},
  "paths": {},
  "query_params": {},
  "raw": {
    "message": "upstream provider returned 503",
    "status": 123
  }
}

{
  "code": "PIX-0004",
  "message": "Invalid or expired authentication credentials.",
  "title": "Unauthorized"
}

{
  "code": "PIX-0005",
  "message": "You do not have permission to perform this operation.",
  "title": "Forbidden"
}

{
  "code": "PIX-0142",
  "message": "claim_id is required",
  "title": "Invalid Claim Request",
  "fields": {},
  "headers": {},
  "paths": {},
  "query_params": {},
  "raw": {
    "message": "upstream provider returned 503",
    "status": 123
  }
}

{
  "code": "PIX-0142",
  "message": "claim_id is required",
  "title": "Invalid Claim Request",
  "fields": {},
  "headers": {},
  "paths": {},
  "query_params": {},
  "raw": {
    "message": "upstream provider returned 503",
    "status": 123
  }
}

{
  "code": "PIX-0142",
  "message": "claim_id is required",
  "title": "Invalid Claim Request",
  "fields": {},
  "headers": {},
  "paths": {},
  "query_params": {},
  "raw": {
    "message": "upstream provider returned 503",
    "status": 123
  }
}

{
  "code": "PIX-0016",
  "message": "The request body must be sent with Content-Type: application/json.",
  "title": "Unsupported Media Type"
}

{
  "code": "PIX-0142",
  "message": "claim_id is required",
  "title": "Invalid Claim Request",
  "fields": {},
  "headers": {},
  "paths": {},
  "query_params": {},
  "raw": {
    "message": "upstream provider returned 503",
    "status": 123
  }
}

{
  "code": "PIX-0000",
  "message": "The server encountered an unexpected error. Please try again later.",
  "title": "Internal Server Error"
}

{
  "code": "PIX-0142",
  "message": "claim_id is required",
  "title": "Invalid Claim Request",
  "fields": {},
  "headers": {},
  "paths": {},
  "query_params": {},
  "raw": {
    "message": "upstream provider returned 503",
    "status": 123
  }
}

Authorizations

Authorization

string

header

required

JWT bearer token issued by the identity provider.

Headers

X-Account-Id

string<uuid>

required

Non-zero UUID of the payer account selected by the calling PSP. The PSP must authorize its end user for that account before calling this API. A resource outside the selected account returns 404; a read with no records returns an empty page. See the API overview for the complete trust boundary.

Pattern: ^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{12}$

X-Idempotency

string

required

REQUIRED. Client-supplied replay key, at most 64 bytes. A request without it is refused with PIX-0030 @ 400 before the handler runs. Replaying the same key with a divergent method, URL or body is PIX-0031 @ 412. X-Account-Id is part of the compared request too, so replaying one account's key under another account is divergent rather than a replay.

Required string length: 1 - 64

Path Parameters

authorization_id

string

required

Internal identifier of the mandate whose parameters are being changed. A request or mandate that exists under a DIFFERENT account than X-Account-Id names is answered 404, not 403: the lookup carries the account as a predicate, so this end never learns that a resource exists elsewhere and cannot confirm it.

Example:

"01a044a8-f3bd-7488-a0dc-e8d4be4802be"

Body

application/merge-patch+json

The merge-patch document. Every property is optional, and null is meaningful on all three.

creditLineEnabled

boolean | null

Whether a pre-approved credit line may be drawn on when the balance is short at settlement (Guia v1.2 §6.3). Null restores the normative default, which is true.

Example:

false

maximumAmount

object | null

Ceiling per payment under this authorization. Null removes the ceiling, which is its normative default (Guia v1.2 §6). Checked at scheduling, never at settlement, and never shared with the receiving user or their PSP (§6.1).

Show child attributes

Example:

{ "amount": "250.00", "currency": "BRL" }

schedulingNotificationsEnabled

boolean | null

Governs ONLY the notice of a successful scheduling (Guia v1.2 §6.2). Null restores the normative default, which is true — a reset is NOT an opt-out.

Example:

false

Response

Parameters updated. The body carries the three parameters as they now stand.

authorizedAt

string<date-time>

required

Example:

"2026-08-27T19:18:38Z"

createdAt

string<date-time>

required

Example:

"2026-08-27T19:18:38Z"

string

required

Example:

"01a044a8-f3bd-7488-a0dc-e8d4be4802be"

journey

string

required

Example:

"JOURNEY_1"

parameters

object

required

Show child attributes

recurrenceId

string

required

Example:

"RR12345678202608276bca619e690"

status

string

required

Example:

"APPROVED"

updatedAt

string<date-time>

required

Example:

"2026-08-27T19:20:00Z"

DICT and Pix keys

Collections and BR Codes

Payments and refunds

Pix Automático API

Error handling

Update the payer-configurable parameters of an authorization

Authorizations

Headers

Path Parameters

Body

Response