v1

latestOpenAPI 3.1.0Copyright Pismo2026-07-247702,7523.1 MB

Schedules

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 event with the status field set to CREATED.

Each execution of the schedule also generates the Scheduled payment executed event.

Refer to the Payment scheduler guide for more information.

post/v1/schedules

Request body

schedule_idstring required

Schedule ID (idempotency field for this operation)

account_idinteger required

Account ID

amountnumber double required

Fee amount.

currency_codestring required

ISO 4217 3-letter currency code, For example, 986 = Brazilian real and 840 = US dollar.

processing_codestring required

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.

descriptionstring

Challenge result

metadatastring

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.

Example request

{
  "schedule_id": "eec3df75-629d-43dc-8eb7-e3b186188341",
  "schedule_details": {
    "type": "authentication",
    "day_type": "CALENDAR_DAY",
    "start_date": "2023-01-02T07:00:00.000Z",
    "end_date": "2023-03-30T12:26:41",
    "retries": {
      "interval_recurrence": 5,
      "number_of_attempts": 5
    }
  },
  "account_id": 6912345,
  "amount": 215,
  "currency_code": "840",
  "processing_code": "99066",
  "description": "Challenge expired",
  "restrictions": {
    "minimum_daily_available": 100.23,
    "minimum_monthly_average_available": 100.23,
    "minimum_days_account_inactivity": 5
  },
  "metadata": "{ \"key\": \"value\"}"
}

Response

Request was processed successfully, existing schedule with the corresponding schedule_id returned.

schedule_idstring

Schedule ID (idempotency field for this operation)

Example response

{
  "schedule_id": "eec3df75-629d-43dc-8eb7-e3b186188341"
}