--- updatedAt: 2026-06-25T22:44:00.000Z --- Fetch the complete documentation index at: https://developers.pismo.io/pismo-docs/llms.txt. Use this file to discover all available pages before exploring further. # Get schedule Get account schedule by schedule ID. # OpenAPI definition ```json { "openapi": "3.1.0", "info": { "title": "Core platform - Payment scheduler", "version": "1.0.0", "description": "Endpoints to enable scheduler creation and processing.", "contact": { "name": "API Support", "url": "https://developers.pismo.io/" }, "license": { "name": "Copyright Pismo" } }, "servers": [ { "url": "https://sandbox.pismolabs.io/scheduler-payments", "description": "Sandbox API server for testing" } ], "tags": [ { "name": "Schedules", "description": "Endpoints to enable scheduler creation and processing" } ], "components": { "responses": { "400BadRequest": { "description": "Bad request" }, "403Forbidden": { "description": "Operation forbidden" }, "404NotFound": { "description": "The specified resource was not found" }, "500InternalServer": { "description": "Internal server error" } }, "parameters": { "accountId": { "in": "path", "name": "accountId", "schema": { "type": "integer", "format": "int64" }, "description": "Pismo account ID", "required": true }, "scheduleId": { "in": "path", "name": "scheduleId", "schema": { "type": "string" }, "description": "Schedule ID", "required": true } }, "schemas": { "AccountID": { "description": "Account ID", "type": "integer", "format": "int64", "example": 8675309 }, "AllowExecutionAfterDayChange": { "type": "boolean", "description": "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`.", "example": false, "default": false }, "Amount": { "type": "number", "format": "float", "description": "Credit or debit amount", "example": 100.23 }, "CreatedAt": { "type": "string", "format": "date-time", "description": "Date of schedule creation in the UTC-0 RFC3339 format. Format: YYYY-MM-DDTHH:mm:ss.sssZ.\n", "example": "2023-01-02T07:35:05.125Z" }, "CurrencyCode": { "type": "string", "description": "Three-letter currency code of the operation in ISO 4217.", "example": "BRL" }, "DayType": { "type": "string", "description": "`BUSINESS_DAY` type ignores weekends and holidays, `CALENDAR_DAY` includes all calendar days.", "enum": [ "BUSINESS_DAY", "CALENDAR_DAY" ], "example": "CALENDAR_DAY" }, "Description": { "type": "string", "description": "Optional text that describes the operation", "example": "Custom purchase", "maxLength": 100 }, "EndDate": { "type": "string", "format": "date-time", "description": "End date of schedule executions in the UTC-0 RFC3339 format. Format: YYYY-MM-DDTHH:mm:ss.sssZ.\n", "example": "2023-01-02T07:00:00.000Z" }, "Interval": { "type": "string", "description": "Schedule execution frequency", "enum": [ "DAILY", "WEEKLY", "MONTHLY", "YEARLY" ], "example": "DAILY" }, "IntervalRecurrence": { "type": "integer", "description": "Interval for retries, in minutes", "minimum": 1, "maximum": 60, "example": 5 }, "Metadata": { "type": "object", "description": "This optional user-defined key-value object field can be used with external operations to provide additional context or supplementary custom information for the operation. The Pismo platform does not perform any validation or processing on this field.\n\n**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).\n", "example": { "any-key": "any-value" } }, "NumberOfAttempts": { "type": "integer", "description": "Maximum number of execution retries", "minimum": 1, "maximum": 10, "example": 5 }, "PismoMetadata": { "type": "object", "description": "Any key-value object with custom information that must be passed forward in the Pismo authorization flow. Used for internal purposes only.", "example": { "any-key": "any-value" } }, "ProcessingCode": { "type": "string", "description": "Processing code that identifies the credit or debit operation", "example": "219803" }, "ProcessingCodeCredit": { "type": "string", "description": "Processing code that identifies the credit operation", "example": "219803" }, "ProcessingCodeDebit": { "type": "string", "description": "Processing code that identifies the debit operation", "example": "219803" }, "ProcessingCodes": { "type": "object", "description": "Object with the processing codes for credit and debit operations", "properties": { "credit": { "$ref": "#/components/schemas/ProcessingCodeCredit" }, "debit": { "$ref": "#/components/schemas/ProcessingCodeDebit" } } }, "Restrictions": { "type": "object", "description": "Restrictions applied to the schedule", "properties": { "minimum_daily_available": { "type": "number", "format": "float", "description": "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\".\n", "example": 100.23 }, "minimum_monthly_average_available": { "type": "number", "format": "float", "description": "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.\n", "example": 100.23 }, "minimum_days_account_inactivity": { "type": "integer", "description": "If the days of account inactivity are greater than this field value, the schedule execution is stopped and saved as \"Executed with restrictions\".\n", "example": 5 } } }, "Retries": { "type": "object", "description": "Configuration to define retry policy for failed executions.", "properties": { "interval_recurrence": { "$ref": "#/components/schemas/IntervalRecurrence" }, "number_of_attempts": { "$ref": "#/components/schemas/NumberOfAttempts" } } }, "Schedule": { "type": "object", "description": "Schedule object", "properties": { "schedule_id": { "$ref": "#/components/schemas/ScheduleID" }, "schedule_kind": { "$ref": "#/components/schemas/ScheduleKind" }, "description": { "$ref": "#/components/schemas/Description" }, "schedule_details": { "$ref": "#/components/schemas/ScheduleDetails" }, "account_id": { "$ref": "#/components/schemas/AccountID" }, "status": { "$ref": "#/components/schemas/Status" }, "created_at": { "$ref": "#/components/schemas/CreatedAt" }, "metadata": { "$ref": "#/components/schemas/Metadata" }, "pismo_metadata": { "$ref": "#/components/schemas/PismoMetadata" }, "processing_code": { "$ref": "#/components/schemas/ProcessingCode" }, "processing_codes": { "$ref": "#/components/schemas/ProcessingCodes" }, "amount": { "$ref": "#/components/schemas/Amount" }, "currency_code": { "$ref": "#/components/schemas/CurrencyCode" }, "restrictions": { "$ref": "#/components/schemas/Restrictions" }, "strategy": { "$ref": "#/components/schemas/Strategy" }, "transfers": { "$ref": "#/components/schemas/Transfers" } } }, "ScheduleDetails": { "type": "object", "description": "Schedule details", "properties": { "type": { "$ref": "#/components/schemas/Type" }, "interval": { "$ref": "#/components/schemas/Interval" }, "day_type": { "$ref": "#/components/schemas/DayType" }, "start_date": { "$ref": "#/components/schemas/StartDateTime" }, "end_date": { "$ref": "#/components/schemas/EndDate" }, "retries": { "$ref": "#/components/schemas/Retries" }, "allow_execution_after_day_change": { "$ref": "#/components/schemas/AllowExecutionAfterDayChange" }, "statement": { "$ref": "#/components/schemas/Statement" } } }, "ScheduleID": { "type": "string", "description": "Schedule ID (idempotency field for this operation)", "minLength": 36, "maxLength": 50, "example": "eec3df75-629d-43dc-8eb7-e3b186188341" }, "ScheduleKind": { "type": "string", "description": "Schedule type", "enum": [ "SINGLE", "MULTIPLE", "PRE" ], "example": "SINGLE" }, "StartDateTime": { "type": "string", "format": "date-time", "description": "Start date of executions in the UTC-0 RFC3339 format. Format: YYYY-MM-DDTHH:mm:ss.sssZ.\n", "example": "2023-01-02T07:00:00.000Z" }, "Statement": { "type": "object", "properties": { "id": { "type": "integer", "description": "Pismo ID of the statement linked to the pre-schedule", "example": 1234455 } } }, "Status": { "type": "string", "description": "Schedule status", "enum": [ "CREATED", "IN_PROGRESS", "CANCELED", "COMPLETED" ], "example": "COMPLETED" }, "Strategy": { "type": "string", "description": "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.\n\n- `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.\n\n Child → Parent\n\n- `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.\n\n Parent → Child\n", "enum": [ "OVERDRAFT_SWEEP", "SWEEP" ], "example": "SWEEP" }, "Transfers": { "type": "array", "description": "List of transfers, including their origin and destination accounts.\nThe `amount` field must be provided if the `strategy` is not specified.\n", "items": { "type": "object", "properties": { "description": { "type": "string", "description": "Transfer description", "example": "Transfer to savings account" }, "amount": { "$ref": "#/components/schemas/Amount" }, "metadata": { "$ref": "#/components/schemas/Metadata" }, "to": { "type": "object", "description": "Information about the destination account for the transfer", "properties": { "account_id": { "$ref": "#/components/schemas/AccountID" }, "processing_code": { "$ref": "#/components/schemas/ProcessingCode" } } }, "from": { "type": "object", "description": "Information about the source account for the transfer", "properties": { "account_id": { "$ref": "#/components/schemas/AccountID" }, "processing_code": { "$ref": "#/components/schemas/ProcessingCode" } } } } } }, "Type": { "type": "string", "description": "Should a schedule be executed once or in a recurring fashion?\n- `ONCE`: Executed only once on the date specified in `start_date`.\n- `RECURRING`: Executed repeatedly according to the interval defined in `interval`, within the period between `start_date` and `end_date`. A recurring schedule can run daily, weekly, monthly, or yearly, which is set in the `interval` field.\n", "enum": [ "ONCE", "RECURRING" ], "example": "RECURRING" } }, "securitySchemes": { "BearerAuth": { "type": "http", "scheme": "bearer", "description": "Account access token. Tokens can expire quickly, which can result in an \"Unauthorized\" error.", "bearerFormat": "JWT" } } }, "security": [ { "BearerAuth": [] } ], "paths": { "/v1/accounts/{accountId}/schedules/{scheduleId}": { "parameters": [ { "$ref": "#/components/parameters/accountId" }, { "$ref": "#/components/parameters/scheduleId" } ], "get": { "summary": "Get schedule", "description": "Get account schedule by schedule ID.\n", "operationId": "get-schedule", "tags": [ "Schedules" ], "responses": { "200": { "description": "Request was processed successfully, existing schedule with the corresponding ID returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Schedule" } } } }, "400": { "$ref": "#/components/responses/400BadRequest" }, "403": { "$ref": "#/components/responses/403Forbidden" }, "404": { "$ref": "#/components/responses/404NotFound" }, "500": { "$ref": "#/components/responses/500InternalServer" } } } } } } ```