Update a Pix Request Schedule

Updates an existing Pix payment schedule by id. Receiver data is taken from the request payload.

Path Parameters

id
Type: string Format: uuid
required

Headers

Idempotency-Key
Type: string
required

Body·

required

application/json

amount
Type: number
min:
0.01
required

Amount.
initiationMethod
Type: string enum
required

Payment initiation method.
values
- APDN
- APES
- AUTO
- DICT
- INIC
- MANU
- QRDN
- QRES
receiver
Type: object ·
required

Receiver/beneficiary information for the Pix transaction
scheduledDate
Type: string Format: date
required

Date when this schedule will be executed (yyyy-MM-dd).
sender
Type: object ·
required

Payer/sender information for the Pix transaction
priority
Type: string enum

Payment priority for the outgoing Pix request (SPI band: HIGH → HIGH, NORM → NORM)
values
- HIGH
- NORM
priorityType
Type: string enum

Settlement priority type
values
- PAGAGD
- PAGFRD
- PAGPRI
purpose
Type: string enum

Purpose of the outgoing Pix payment (SPI purpose codes)
values
- GSCB
- IPAY
- IPRT
- OTHR
- REFU
userDescription
Type: string

User-provided description.

Responses

application/json

400

Invalid request

Erros desta resposta

Código interno	HTTP	Descrição	Erro normativo Bacen
`PIX-SCH-0005`	400	Invalid schedule start date	—
`PIX-SCH-0006`	400	Schedule not found	—
`PIX-SCH-0009`	400	Schedule update is not allowed for current status	—
`PIX-SCH-0021`	400	Schedule is linked to a recurrence and cannot be modified directly. Update the parent recurrence instead.	—

404

Schedule not found

patch/api/v1/pix-schedules/{id}

curl http://localhost/api/v1/pix-schedules/123e4567-e89b-12d3-a456-426614174000 \
  --request PATCH \
  --header 'Idempotency-Key: ' \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --data '{
  "amount": 150,
  "userDescription": "Gym membership",
  "priority": "NORM",
  "priorityType": "PAGAGD",
  "initiationMethod": "MANU",
  "purpose": "IPAY",
  "sender": {
    "name": "Joao da Silva",
    "document": {
      "type": "CPF",
      "value": "12345678901"
    },
    "account": {
      "ispb": "12345678",
      "type": "CACC",
      "branch": "0001",
      "number": "12345678"
    }
  },
  "receiver": {
    "key": "+5511989450870",
    "name": "Joao da Silva",
    "document": {
      "type": "CPF",
      "value": "12345678901"
    },
    "account": {
      "ispb": "12345678",
      "type": "CACC",
      "branch": "0001",
      "number": "12345678"
    }
  },
  "scheduledDate": "2026-04-30"
}'

Show Schema

{
  "id": "c0a8012e-1234-5678-90ab-000000000001",
  "status": "ACTIVE",
  "createdAt": "2026-03-01T09:30:00",
  "updatedAt": "2026-03-15T12:00:00",
  "initiationMethod": "MANU",
  "priority": "NORM",
  "priorityType": "PAGAGD",
  "purpose": "IPAY",
  "amount": 150,
  "userDescription": "Gym membership",
  "sender": {
    "name": "Joao da Silva",
    "document": {
      "type": "CPF",
      "value": "12345678901"
    },
    "account": {
      "ispb": "12345678",
      "type": "CACC",
      "branch": "0001",
      "number": "12345678"
    }
  },
  "receiver": {
    "key": "+5511989450870",
    "name": "Joao da Silva",
    "document": {
      "type": "CPF",
      "value": "12345678901"
    },
    "account": {
      "ispb": "12345678",
      "type": "CACC",
      "branch": "0001",
      "number": "12345678"
    }
  },
  "source": "MANUAL",
  "scheduledDate": "2026-04-30",
  "endToEndId": "E1234567820260430143000ABC12345",
  "msgId": "M20260101000000001",
  "settledAt": "2026-06-22T14:30:00Z",
  "failureReason": "FF08",
  "recurrenceId": "c0a8012e-1234-5678-90ab-000000000002",
  "installment": 3,
  "totalInstallments": 12,
  "reconciliationId": "REC20260408001",
  "totalAmount": 150
}

Schedule updated