--- 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. # Create single schedule Create a single schedule, which executes a simple payment operation on a single account. Configure the schedule's execution frequency and other details in the `schedule_details` field. In some cases, due to errors and retries, execution of the scheduled transaction might occur on the following day instead of the originally scheduled date. To address this, the `allow_execution_after_day_change` flag in `schedule_details` enables you to pre-authorize execution of the scheduled transaction on the next day. This flag must be set to `true` for schedules that are set to be executed at the end of the day (after 11:30pm UTC). If the schedule is not executed on the expected day for any reason, and this field isn't set to `true`, the schedule is not executed and is marked as `EXECUTED_WITH_ERROR_NEXT_DAY_NOT_ALLOWED`. This endpoint generates the [Scheduled payment created or modified](https://developers.pismo.io/events/docs/scheduler-payments-scheduled-payments-1) event with the `status` field set to `CREATED`. Each execution of the schedule also generates the [Scheduled payment executed](https://developers.pismo.io/events/docs/scheduler-payments-scheduled-payments-execution-1) event. Refer to the [Payment scheduler](doc:payment-scheduler) guide for more information. # 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" }, "500InternalServer": { "description": "Internal server error" } }, "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 }, "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 }, "ProcessingCode": { "type": "string", "description": "Processing code that identifies the credit or debit operation", "example": "219803" }, "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" } } }, "ScheduleID": { "type": "string", "description": "Schedule ID (idempotency field for this operation)", "minLength": 36, "maxLength": 50, "example": "eec3df75-629d-43dc-8eb7-e3b186188341" }, "SingleScheduleDetails": { "type": "object", "description": "Single 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" } } }, "SingleScheduleRequest": { "type": "object", "description": "Request to create a new single schedule", "required": [ "schedule_id", "schedule_details", "account_id", "processing_code", "amount", "currency_code" ], "properties": { "schedule_id": { "$ref": "#/components/schemas/ScheduleID" }, "schedule_details": { "$ref": "#/components/schemas/SingleScheduleDetails" }, "account_id": { "$ref": "#/components/schemas/AccountID" }, "amount": { "$ref": "#/components/schemas/Amount" }, "currency_code": { "$ref": "#/components/schemas/CurrencyCode" }, "processing_code": { "$ref": "#/components/schemas/ProcessingCode" }, "description": { "$ref": "#/components/schemas/Description" }, "restrictions": { "$ref": "#/components/schemas/Restrictions" }, "metadata": { "$ref": "#/components/schemas/Metadata" } } }, "SingleScheduleResponse": { "type": "object", "description": "Response from the creation of a new single schedule", "properties": { "schedule_id": { "$ref": "#/components/schemas/ScheduleID" } } }, "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" }, "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/schedules": { "post": { "summary": "Create single schedule", "operationId": "post-v1-create-single-schedule", "description": "Create a single schedule, which executes a simple payment operation on a single account. Configure the schedule's execution frequency and other details in the `schedule_details` field.\n\nIn some cases, due to errors and retries, execution of the scheduled transaction might occur on the following day instead of the originally scheduled date. To address this, the `allow_execution_after_day_change` flag in `schedule_details` enables you to pre-authorize execution of the scheduled transaction on the next day. This flag must be set to `true` for schedules that are set to be executed at the end of the day (after 11:30pm UTC). If the schedule is not executed on the expected day for any reason, and this field isn't set to `true`, the schedule is not executed and is marked as `EXECUTED_WITH_ERROR_NEXT_DAY_NOT_ALLOWED`.\n\nThis endpoint generates the [Scheduled payment created or modified](https://developers.pismo.io/events/docs/scheduler-payments-scheduled-payments-1) event with the `status` field set to `CREATED`.\n\nEach execution of the schedule also generates the [Scheduled payment executed](https://developers.pismo.io/events/docs/scheduler-payments-scheduled-payments-execution-1) event.\n\nRefer to the [Payment scheduler](https://developers.pismo.io/pismo-docs/docs/payment-scheduler) guide for more information.\n", "tags": [ "Schedules" ], "requestBody": { "description": "Request processing body", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SingleScheduleRequest" } } } }, "responses": { "200": { "description": "Request was processed successfully, existing schedule with the corresponding `schedule_id` returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SingleScheduleResponse" } } } }, "201": { "description": "Request was processed successfully, new schedule created.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SingleScheduleResponse" } } } }, "400": { "$ref": "#/components/responses/400BadRequest" }, "403": { "$ref": "#/components/responses/403Forbidden" }, "500": { "$ref": "#/components/responses/500InternalServer" } } } } } } ```