Get Pix Request Schedule by id

​

Returns a Pix payment schedule by id.

Path Parameters
  • id
    Type: string Format: uuid
    required
Headers
  • Idempotency-Key
    Type: string
    required
Responses
  • application/json
  • 404

    Schedule not found

Request Example for get/api/v1/pix-schedules/{id}
curl http://localhost:8080/api/v1/pix-schedules/123e4567-e89b-12d3-a456-426614174000 \
  --header 'Idempotency-Key: ' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

{
  "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.562Z",
  "recurrenceId": "string",
  "installment": 1,
  "totalInstallments": 1,
  "reconciliationId": "REC-20260408-001",
  "totalAmount": 1
}

Schedule found