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

    Priority type code (BACEN SPI)

    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
  • 404

    Schedule not found

Request Example for patch/api/v1/pix-schedules/{id}
curl http://localhost:8080/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": 0.01,
  "userDescription": "",
  "priority": "HIGH",
  "priorityType": "PAGAGD",
  "initiationMethod": "APDN",
  "purpose": "GSCB",
  "sender": {
    "name": "",
    "document": {
      "type": "CPF",
      "value": ""
    },
    "account": {
      "ispb": "",
      "type": "CACC",
      "branch": "",
      "number": ""
    }
  },
  "receiver": {
    "key": "",
    "name": "",
    "document": {
      "type": "CPF",
      "value": ""
    },
    "account": {
      "ispb": "",
      "type": "CACC",
      "branch": "",
      "number": ""
    }
  },
  "scheduledDate": ""
}'

{
  "id": "string",
  "status": "ACTIVE",
  "createdAt": "string",
  "updatedAt": "string",
  "initiationMethod": "APDN",
  "priority": "HIGH",
  "priorityType": "PAGAGD",
  "purpose": "GSCB",
  "amount": 1,
  "userDescription": "string",
  "sender": {
    "name": "string",
    "document": {
      "type": "CPF",
      "value": "string"
    },
    "account": {
      "ispb": "string",
      "type": "CACC",
      "branch": "string",
      "number": "string"
    }
  },
  "receiver": {
    "key": "string",
    "name": "string",
    "document": {
      "type": "CPF",
      "value": "string"
    },
    "account": {
      "ispb": "string",
      "type": "CACC",
      "branch": "string",
      "number": "string"
    }
  },
  "source": "MANUAL",
  "scheduledDate": "2026-07-29",
  "endToEndId": "string",
  "msgId": "string",
  "settledAt": "2026-07-29T19:28:46.545Z",
  "recurrenceId": "string",
  "installment": 1,
  "totalInstallments": 1,
  "reconciliationId": "REC-20260408-001",
  "totalAmount": 1
}

Schedule updated