Consultar Agendamentos de Transação Pix de uma conta

Request

ENDPOINT

/account/ACCOUNT_KEY/pix_schedules

MÉTODO

GET

Path Params

Campo	Tipo	Descrição	Caracteres
account_key	uuidv4	Chave única de identificação da conta.	36

Query Params

Campo	Tipo	Descrição	Caracteres
request_control_key	uuidv4	Chave única de identificação da request utilizada pelo cliente.	36
schedule_status	string	Status do agendamento. Pode ser enviado em forma de lista.	Enumerador schedule_status
page	integer	Número da página requisitada. 1 por padrão
page_size	integer	Tamanho da página requisitada na consulta. 30 por padrão e valor máximo	Valor máximo de 30

Enumerador schedule_status

Enumerador	Descrição
scheduled	Transação agendada
sent	Agendamento concluído e enviado com sucesso. Estado final
rejected	Agendamento rejeitado durante criação ou execução. Estado final
cancelled	Agendamento cancelado por solicitação de cliente. Estado final
pending_2fa_approval	Pendente de aprovação por autenticação de dois fatores
pending_creation	Agendamento em processo de criação (Estado transitório para agendamento em lote)
waiting_batch_approval	Agendamento criado e vinculado a um lote aguardando aprovação por autenticação de dois fatores

Response

STATUS

200

Response Body

{
  "data": [
    {
      "request_control_key": "b6804f32-101e-4702-8fbc-c2dbc4c2caec",
      "schedule_key": "8cb70dea-9fb0-4a68-9572-99a72849c8d6",
      "schedule_status": "scheduled",
      "schedule_date": "2024-12-31",
      "created_at": "2023-03-13T19:00:28.440Z"
    },
    {
      "request_control_key": "bf6b0a4b-c7a5-446b-9dad-1ae10b25342a",
      "schedule_key": "2479a5cd-079e-4d72-bf4e-16a695bda45e",
      "schedule_status": "cancelled",
      "schedule_date": "2024-12-31",
      "created_at": "2023-03-13T19:00:28.440Z"
    },
    {
      "request_control_key": "9d36c03e-2db7-4c90-87ed-6c9ddb3c03c7",
      "schedule_key": "5d6b14b9-053f-408c-bcd7-61ecf9224f2c",
      "schedule_status": "rejected",
      "schedule_date": "2024-12-31",
      "created_at": "2023-03-13T19:00:28.440Z"
    }
  ],
  "pagination": {
    "current_page": 1,
    "next_page": null,
    "rows_per_page": 30
  }
}