List Schedules of a Batch Schedule

Request

ENDPOINT

/account/ACCOUNT_KEY/pix_schedule_batch/SCHEDULE_BATCH_KEY/pix_schedules

METHOD

GET

Path Params

Field	Type	Description	Characters
account_key	uuidv4	Unique account identification key.	36
schedule_batch_key	uuidv4	Unique batch schedule identification key.	36

Query Params

Field	Type	Description	Characters
request_control_key	uuidv4	Unique identification key for the request used by the client.	36
schedule_status	string	Schedule status. Can be sent as a list.	Enumerator schedule_status
page	integer	Requested page number. 1 by default.
page_size	integer	Size of the requested page in the query. 30 by default and max value	Maximum value of 30

Enumerator schedule_status

Enumerator	Description
scheduled	Scheduled transaction
sent	Schedule completed and successfully sent. Final status.
rejected	Schedule rejected during creation or execution. Final status.
cancelled	Schedule canceled by customer request. Final status.
pending_2fa_approval	Pending two-factor authentication approval.
pending_creation	Schedule in the process of creation (Transitional state for batch scheduling).
waiting_batch_approval	Schedule created and linked to a batch awaiting two-factor authentication approval.

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
  }
}