Cancel installments payment

Cancel an existing installments payment.

This endpoint generates the Authorization created event.

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

Request object for POST v1/payments/installments/cancel (Cancel Installments payment).

string
length between 36 and 50
^[0-9a-fA-F]{8}\b-[0-9a-fA-F]{4}\b-[0-9a-fA-F]{4}\b-[0-9a-fA-F]{4}\b-[0-9a-fA-F]{12}$

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

string
length between 36 and 50
^[0-9a-fA-F]{8}\b-[0-9a-fA-F]{4}\b-[0-9a-fA-F]{4}\b-[0-9a-fA-F]{4}\b-[0-9a-fA-F]{12}$

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

int64

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

integer
required

Pismo account ID.

float

Total amount to be cancelled.

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 but passes this object to the acquirer in transactions involving calls to the acquirer and sends it in the events related to the stream of data produced at the end of the request.

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.

Headers
string
required
length between 39 and 39
TN\-[0-9a-fA-F]{8}\b-[0-9a-fA-F]{4}\b-[0-9a-fA-F]{4}\b-[0-9a-fA-F]{4}\b-[0-9a-fA-F]{12}

Unique Org ID.

string

Optional account ID.

string

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

Responses

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