BACS direct credit

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.

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

Request

  • Base URL
    https://sandbox.pismolabs.io/bacs
  • URL
    https://sandbox.pismolabs.io/bacs/v1/payments/bacs/directcredit/cancel/{id}
  • Auth
    none declared. Required headers: Authorization

Path parameters

idstring required

BACS transaction ID.

Headers

Authorizationstring required

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

x-cidstring

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

Request body

returnFundsboolean

Should a return instruction be generated as part of the cancellation? Default is true.

  • true- 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.

reasonstring

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

Example request

{
  "returnFunds": true,
  "reason": "DAY2_RECALL"
}

Response

Response Body

idstring

Client-generated transaction ID. 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,
returnFundsboolean

Cancellation's effective return funds value

Example response

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

Changes

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