APIs
Sub-processorsAbout PismoContact us

Return BACS direct credit inbound payment [beta]

post
https://sandbox.pismolabs.io/bacs/v1/payments/bacs/directcredit/return/

Initiates a client return for a settled BACS direct credit inbound payment. The return amount must match the original transaction amount exactly, since the platform does not allow partial returns. The platform permits only one return per original transaction.

Returns initiated through this endpoint are marked with return_origin = CLIENT to distinguish them from system-initiated returns (return_origin = SYSTEM).

This endpoint generates a BACS direct credit inbound return payment processed event with return_origin = CLIENT.

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

Client return request body

string
enum
required

The reason for the return.

  • account_closed—The beneficiary account is no longer active.
  • account_currency_mismatch—The payment currency does not match the account currency.
  • other—A reason that the other specific codes do not cover.
  • cancelled_by_payer—The payer requests cancellation of the payment.
Allowed:
float
required

Amount to return. Must match the original transaction amount, since the Pismo platform does not support partial returns.

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
required

Organization identifier.

string

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

string
required

A UUID (without hyphens) to ensure the operation remains idempotent, allowing for operation repetition without causing unintended effects or duplication. Identifies the transaction on future events.

Responses

Updated about 1 month ago

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

Updated about 1 month ago

Did this page help you?