Schedules

Create bulk pre-schedules

Create multiple pre-schedules in a single request. This request triggers an asynchronous process to create the pre-schedules. Once processing is complete, the Bulk pre-schedules created event is sent with the result of the operation.

Pre-schedule is a type of schedule that is executed by a direct call from the Pismo platform at the end of the closing cycle. To configure a pre-schedule execution, 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/bulk

Request

  • Base URL
    https://sandbox.pismolabs.io/scheduler-payments
  • URL
    https://sandbox.pismolabs.io/scheduler-payments/v1/pre-schedules/bulk
  • Auth
    HTTP bearer

Request body

schedule_idstring required

Schedule ID (idempotency field for this operation)

account_idinteger required

Account ID

amountnumber float required

Credit or debit amount

currency_codestring required

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

processing_codestring required

Processing code that identifies the credit or debit operation

descriptionstring

Optional text that describes the operation

metadataMetadata

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.

Example request

[
  {
    "schedule_id": "eec3df75-629d-43dc-8eb7-e3b186188341",
    "schedule_details": {
      "statement": {
        "id": 1234455
      }
    },
    "account_id": 8675309,
    "amount": 100.23,
    "currency_code": "BRL",
    "processing_code": "219803",
    "description": "Custom purchase",
    "metadata": {
      "any-key": "any-value"
    }
  }
]

Response

Request was processed successfully, new multiple pre-schedules accepted.

Changes

No recorded changes to this operation across all 1 revision of this API.