---
title: "List account schedules"
method: GET
path: "/v1/accounts/{accountId}/schedules"
tags: ["Schedules"]
---

# List account schedules

`GET /v1/accounts/{accountId}/schedules`

List account schedules with paging and filter options.

## Response `200`

Request was processed successfully.

- GetAllScheduleResponse — Response of getting the existing schedules of the account
  - `has_next` boolean — Whether there are more pages after the current page (`true`) or not (`false`).
  - `next_cursor` string, nullable — Cursor value for the next page
  - `count` integer — Number of items
  - `items` Schedule[]
    - `schedule_id` string — Schedule ID (idempotency field for this operation)
    - `schedule_kind` 'SINGLE' | 'MULTIPLE' | 'PRE' — Schedule type
    - `description` string — Challenge result
    - `schedule_details` ScheduleDetails — Schedule details
      - `type` 'authentication' | 'challenge-request' — Evaluation intention
      - `interval` 'DAY' | 'WEEK' | 'MONTH' — Scheduler interval
      - `day_type` 'BUSINESS_DAY' | 'CALENDAR_DAY' — `BUSINESS_DAY` type ignores weekends and holidays, `CALENDAR_DAY` includes all calendar days.
      - `start_date` string, date-time — Start date of executions in the UTC-0 RFC3339 format. Format: YYYY-MM-DDTHH:mm:ss.sssZ.
      - `end_date` string, date-time — End date for link (GMT-3). When the final charge for a link is made, `end_date` gets populated.
      - `retries` Retries — Configuration to define retry policy for failed executions.
        - `interval_recurrence` integer — Interval for retries, in minutes
        - `number_of_attempts` integer — Maximum number of execution retries
      - `allow_execution_after_day_change` boolean — Can the schedule be executed after the day changes? For single and transfer schedules that are scheduled for after 11:30pm UTC, this field is required to be `true`.
      - `statement` Statement
        - `id` integer — Pismo ID of the statement linked to the pre-schedule
    - `account_id` integer — Account ID
    - `status` 'PENDING' | 'PROCESSING' | 'CANCELLED' | 'SETTLED' | 'PROCESSED' — PENDING: Charge is scheduled and waiting for the cycle to close. PROCESSING: Cycle closing process has started and is awaiting completion. CANCELLED: Charge canceled due to link cancellation. SETTLED: Amount is zero and/or `minimum_spend_to_charge` has not been reached. PROCESSED: Charge was posted on the statement."
    - `created_at` string, date-time — Datetime program calendar strategy was created. Format = YYYY-MM-DDTHH:MM:SS:MM.
    - `metadata` string — Any data object with key/value pairs. No limit on length. **Note**: This field must not be used to send Personally Identifiable Information (PII), Payment Card Industry (PCI) data, or any sensitive/regulated information. Metadata fields are intended for operational, non-sensitive data only. For sensitive data, use the specific parameters designed for that purpose. For more information, refer to [Get started with Pismo APIs](https://developers.pismo.io/pismo-docs/reference/get-started-with-pismo-apis#metadata).
    - `pismo_metadata` PismoMetadata — Any key-value object with custom information that must be passed forward in the Pismo authorization flow. Used for internal purposes only.
    - `processing_code` string — Processing code for the debit transaction. If `split_transaction` is `false` (the default), each installment payment is recorded as one debit transaction equal to the installment amount minus the discount, and `processing_code` is the processing code for that transaction. If `split_transaction` is `true`, each installment payment is recorded as two transactions: a debit transaction for the installment amount and a credit transaction for the discount. In this case, `processing_code` is the processsing code for the debit transaction, and `second_processing_code` is the processing code for the credit transaction.
    - `processing_codes` ProcessingCodes — Object with the processing codes for credit and debit operations
      - `credit` string — Processing code that identifies the credit operation
      - `debit` string — Processing code that identifies the debit operation
    - `amount` number, double — Fee amount.
    - `currency_code` string — ISO 4217 3-letter currency code, For example, `986` = Brazilian real and `840` = US dollar.
    - `restrictions` Restrictions — Restrictions applied to the schedule
      - `minimum_daily_available` number, float — Establishes a minimum limit value to always be maintained in the customer's balance. If the value of the customer's balance is lower than the minimum limit value, the schedule is executed, otherwise its execution is stopped and saved as "Executed with restrictions".
      - `minimum_monthly_average_available` number, float — Follows the same logic as `minimum_daily_available`, except it considers an average limit value from the first day of the month until the day before the scheduled execution to compare with the customer’s balance value.
      - `minimum_days_account_inactivity` integer — If the days of account inactivity are greater than this field value, the schedule execution is stopped and saved as "Executed with restrictions".
    - `strategy` 'OVERDRAFT_SWEEP' | 'SWEEP' — If the `strategy` field is not specified, you must provide the `amount` field for each transfer in the `transfers` array. The following strategy types determine the transfer amounts when a strategy is specified. - `SWEEP`: Transfers the entire balance from the child account to the parent account. The terms "parent" and "child" refer to account roles, but no relationship validation is performed. Child → Parent - `OVERDRAFT_SWEEEP`: Follows the same logic as `SWEEP`, except when a child account is negative, in which case the main account sends enough money to zero out the child account. Parent → Child
    - `transfers` object[] — List of transfers, including their origin and destination accounts. The `amount` field must be provided if the `strategy` is not specified.
      - `description` string — Transfer description
      - `amount` number, double — Fee amount.
      - `metadata` string — Any data object with key/value pairs. No limit on length. **Note**: This field must not be used to send Personally Identifiable Information (PII), Payment Card Industry (PCI) data, or any sensitive/regulated information. Metadata fields are intended for operational, non-sensitive data only. For sensitive data, use the specific parameters designed for that purpose. For more information, refer to [Get started with Pismo APIs](https://developers.pismo.io/pismo-docs/reference/get-started-with-pismo-apis#metadata).
      - `to` object — Information about the destination account for the transfer
        - `account_id` integer — Account ID
        - `processing_code` string — Processing code for the debit transaction. If `split_transaction` is `false` (the default), each installment payment is recorded as one debit transaction equal to the installment amount minus the discount, and `processing_code` is the processing code for that transaction. If `split_transaction` is `true`, each installment payment is recorded as two transactions: a debit transaction for the installment amount and a credit transaction for the discount. In this case, `processing_code` is the processsing code for the debit transaction, and `second_processing_code` is the processing code for the credit transaction.
      - `from` object — Information about the source account for the transfer
        - `account_id` integer — Account ID
        - `processing_code` string — Processing code for the debit transaction. If `split_transaction` is `false` (the default), each installment payment is recorded as one debit transaction equal to the installment amount minus the discount, and `processing_code` is the processing code for that transaction. If `split_transaction` is `true`, each installment payment is recorded as two transactions: a debit transaction for the installment amount and a credit transaction for the discount. In this case, `processing_code` is the processsing code for the debit transaction, and `second_processing_code` is the processing code for the credit transaction.

## Other responses

- `400` — Bad request
- `403` — The request has been lost
- `404` — Not Found
- `500` — Internal server error

---

[API](https://skmtc.net/pismo/apis/platform-authentication.md) · [All operations](https://skmtc.net/pismo/apis/platform-authentication/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/pismo/platform-authentication/versions/935b62e16de4/schema)