Sign in

v1

latestOpenAPI 3.1.0Copyright Pismo2026-07-247702,7523.1 MB
Installments payments

Cancel installments payment

Cancel an existing installments payment.

This endpoint generates the Authorization created event.

post/payments/v1/payments/installments/cancel

Headers

x-tenantstring required
Example:TN-c0e4c660-9059-404c-ab22-761aa431766c

Unique Org ID.

x-account-idstring

Optional account ID.

x-skip-timelinestring
Example:true

If set to true, this will prevent the generation of timeline events in the customer timeline.

Request body

tracking_idstring

Unique tracking ID of the installments operation. If you don't provide one, the Pismo platform generates it randomly.

original_tracking_idstring

Unique tracking ID of the original installments operation. You have to provide either original_tracking_id or original_authorization_id to execute this request.

original_authorization_idinteger

Authorization ID of the original installments operation. You have to provide either original_authorization_id or original_tracking_id to execute this request.

account_idinteger required

Pismo account ID.

amountnumber float

Total amount to be cancelled.

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

{
  "tracking_id": "be68db6e-8da0-4761-8632-6a51857bd123",
  "original_tracking_id": "be68db6e-8da0-4761-8632-6a51857bd123",
  "original_authorization_id": 15301234,
  "account_id": 101,
  "amount": 12.13,
  "metadata": "{ \"key\": \"value\"}"
}

Response

Created

authorization_idinteger

Generated authorization ID.

event_datestring date-time

Date and time of the authorization, in UTC-0 (RFC3339) format.

tracking_idstring

Unique 36-character identifier for the installments payment. If you didn't provide an identifier, then the Pismo platform automatically generates and includes one in the response.

Example response

{
  "authorization_id": 15301234,
  "event_date": "2020-01-02T15:14:00.218Z",
  "tracking_id": "82766158-514c-42f0-87e2-1bb3250c6dee"
}