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.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

Request processing body

Request to create a new pre-schedule

string
required
length between 36 and 50

Schedule ID (idempotency field for this operation)

schedule_details
object
required

Pre-schedule details

int64
required

Account ID

float
required

Credit or debit amount

string
required

Three-letter currency code of the operation in ISO 4217.

string
required

Processing code that identifies the credit or debit operation

string
length ≤ 100

Optional text that describes the operation

metadata
object

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.

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.

Responses

400

Bad request

403

Operation forbidden

500

Internal server error

Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json