Sign in

v1

latestOpenAPI 3.1.0Copyright Pismo2026-07-247702,7523.1 MB
BACS

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.

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

post/v1/payments/bacs/directcredit/cancel/{id}

Path parameters

idstring required

BACS transaction ID.

Headers

Authorizationstring required

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

x-tenantstring required

Organization identifier.

x-cidstring

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

Response

Response Body

idstring

Client-generated transaction identifier. This is the idempotency key UUID passed in the Send direct credit outbound payment endpoint.

status'CANCELLED'
  • CANCELLED - Something went wrong and the transaction was cancelled. Refer to reason for details,

Example response

{
  "id": "1374f841568e4ff4b363b023c170ecdr",
  "status": "CANCELLED"
}