PIpismo
Payments

Cancel payment

Cancel an existing payment operation.

NOTE:

  • This endpoint requires an account token - an access token encoded with an external 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.

post/corporate/v2/payments/cancel

Request

  • Base URL
    https://sandbox.pismolabs.io
  • URL
    https://sandbox.pismolabs.io/corporate/v2/payments/cancel
  • Auth
    HTTP bearer

Request body

original_tracking_idstring required

Tracking ID for the original operation.

tracking_idstring required

A unique payment tracking number provided by the client. If an existing tracking_id is found on the Pismo platform, 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
cancellation_method'INSTANT' | 'ORIGINAL_DATES'

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.
skip_account_date_validationboolean

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

metadataConfirmPaymentMetadata

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

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

{
  "original_tracking_id": "249fbd1c-cfcd-48aa-8bcb-1ffe3a5f7978",
  "tracking_id": "0a50c88a-ade8-4bcc-a639-9a0b0f11e244",
  "cancellation_method": "INSTANT"
}

Response

Created

original_tracking_idstring

Tracking ID for the original operation.

tracking_idstring

A unique payment tracking number provided by the client. If an existing tracking_id is found on the Pismo platform, 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
event_datetimestring date-time

Event date and time displayed in ISO 8601 format.<br> minLength: 1 maxLength: 30

Example response

{
  "original_tracking_id": "249fbd1c-cfcd-48aa-8bcb-1ffe3a5f7978",
  "tracking_id": "0a50c88a-ade8-4bcc-a639-9a0b0f11e244",
  "event_datetime": "2023-04-27T12:01:24Z"
}

Changes

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