APIs
Sub-processorsAbout PismoContact us

Cancel transfer of held amount

post
https://sandbox.pismolabs.io/payments/v1/payments/hold-funds/transfer/cancel

Cancel transfer of a previously held amount from an account. This endpoint generates the Authorization created and Account balance changed events. See the Hold funds guide for more details.

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

Request object for POST /v1/payments/hold-funds/transfer/cancel.

string
required
length between 1 and 50

Unique identifier of the operation.

string
required
length between 1 and 50

Unique identifier that references the original transfer.

integer
required
≥ 1

Unique identifier of an account in the Pismo platform.

float
required
≥ 0.01

Credit or debit amount.

string
required
length ≤ 6
^[0-9]{6}$

Unique 6-character processing code that identifies the credit or debit operation.

string

Optional text that describes this operation. The platform supports only letters and numbers in this field and removes any special characters or emojis.

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.

Responses

Updated about 2 months ago

Did this page help you?
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

Updated about 2 months ago

Did this page help you?