Sign in

v1

latestOpenAPI 3.1.0Copyright Pismo2026-07-247702,7523.1 MB
Schedules

Create pre-schedule

Create a pre-schedule, which is executed by a direct call from the Pismo platform at the end of the closing cycle. To configure execution of a pre-schedule, contact your Pismo representative or call the Execute pre-schedule endpoint.

This endpoint generates the Scheduled payment created or modified event with the status field set to CREATED.

Once the pre-schedule is created, its execution generates the following events.

Refer to the Payment scheduler guide for more information.

post/v1/pre-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": {
    "statement": {
      "id": 1234455
    }
  },
  "account_id": 6912345,
  "amount": 215,
  "currency_code": "840",
  "processing_code": "99066",
  "description": "Challenge expired",
  "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"
}