Cancel BACS inbound transaction [beta]

Cancel a suspended transaction, which was kept on hold based on client's anti-fraud (AF) provider analysis, and return the transaction.

Suspense transaction flow

You can use the suspense transaction flow to manage incoming BACS transactions that have been temporarily placed on hold due to suspected fraud pending a decision from the client's anti-fraud (AF) provider.

Supported scenarios:

  • An incoming (cash-in) BACS transaction is received.

  • Client' s anti-fraud provider returns "hold" instead of approve or reject.

  • Pismo places the transaction amount into additional fund (unavailable balance) so the beneficiary cannot use the funds until a final decision is made.

  • The client later calls Pismo's release or cancel endpoints to finalize the transaction.

Day 2 recall (pre-settlement cancellation)

This endpoint also supports cancelling an inbound (cash-in) BACS Direct Credit that is still PROCESSING and awaiting the Day 3 posting cycle, so it is never credited to the beneficiary. The optional returnFunds flag (default true) controls whether the funds are returned to the originating institution:

  • returnFunds = true - cancel the transaction and generate a return instruction (debiting the beneficiary if the amount was already credited).

  • returnFunds = false - cancel the transaction only; no return instruction is created.

In all cases the transaction is removed from the Day 3 settlement queue and marked CANCELLED.

This endpoint generates a BACS direct credit inbound payment processed event with status = CANCELLED.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required
length ≤ 31

BACS transaction ID.

Body Params

Optional cancellation options. When omitted, returnFunds defaults to true.

Optional cancellation options. When the body is omitted, returnFunds defaults to true.

boolean
Defaults to true

Controls whether a return instruction is generated as part of the cancellation.

  • true (default) - cancel the transaction and return the funds to the originating institution (debiting the beneficiary if the amount was already credited).
  • false - cancel the transaction only; no return instruction is created.
string

Optional business reason for the cancellation (for example, DAY2_RECALL).

Headers
string
required

Account token - token encoded with a Pismo account ID. Tokens can expire quickly, which can result in a 401 Unauthorized message

string

Request tracking ID. If not provided, a random UUID is generated.

Responses

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