Get Pix Request Schedule by id

​

Returns a Pix payment schedule by id.

Path Parameters
  • id
    Type: string Format: uuid
    required
Responses
  • application/json
  • 400

    Invalid request

    Erros desta resposta

    Código interno HTTP Descrição Erro normativo Bacen
    PIX-SCH-0006 400 Schedule not found —
  • 404

    Schedule not found

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

{
  "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 found