APIs
Sub-processorsAbout PismoContact us

Cancel payment (Pismo account ID)

post
https://sandbox.pismolabs.io/cash-management/v2/payments/cancel

Cancel an existing payment operation.

NOTE:

  • This endpoint requires an account token - an access token encoded with a Pismo account ID. Tokens can expire quickly, which can result in a 401 Unauthorized message.

This endpoint generates the following events:

Refer to Data and reporting for more information on events and setting up event notifications.

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

Request body

string
required
length ≤ 43

Tracking ID for the original operation.

string
required
length between 1 and 43

A unique payment tracking number provided by the client. If an existing tracking_id already exists in the system, the API returns a 409 error.

This field is:

  • Unique within the Organization.
  • Immutable — It can't be updated.
  • Not recyclable — You can't reuse a tracking_id.
string
enum
Defaults to INSTANT

Define the cancellation method used to determine which dates the cancellation will impact the account balance.

  • INSTANT (default): Cancels the payment using the current business date.
  • ORIGINAL_DATES: Cancels the payment using the original payment dates.
Allowed:
boolean
Defaults to false

If FALSE, the payment_datetime is validated against the account creation date and time. If TRUE, the validation is skipped.

metadata
object

Key-value pairs containing data intended for storage in the Pismo system.

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

403

The request has been lost

Updated 3 months ago

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

Updated 3 months ago

Did this page help you?