Hold funds

Cancel transfer of held amount

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.

post/payments/v1/payments/hold-funds/transfer/cancel

Request

  • Base URL
    https://sandbox.pismolabs.io/passport
  • URL
    https://sandbox.pismolabs.io/passport/payments/v1/payments/hold-funds/transfer/cancel
  • Auth
    HTTP bearer

Request body

tracking_idstring required

Unique identifier of the operation.

original_tracking_idstring required

Unique identifier that references the original transfer.

account_idinteger required

Unique identifier of an account in the Pismo platform.

amountnumber float required

Credit or debit amount.

processing_codestring required

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

descriptionstring

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

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",
  "account_id": 101,
  "amount": 12.13,
  "processing_code": "004000",
  "description": "Blocked value",
  "metadata": "{ \"key\": \"value\"}"
}

Response

Created

authorization_idinteger

Generated authorization ID

event_datestring date-time

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

tracking_idstring

Unique identifier for the operation.

Example response

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

Changes

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