PIpismo
BACS direct credit

Reverse BACS direct credit outbound payment [beta]

Reverse a BACS direct credit outbound payment that is on hold.

A reversal is only allowed when:

  • The payment is an outbound payment with status HOLD
  • The reversal is requested on the same day as the payment creation date

This endpoint generates a BACS direct credit outbound reversal processed event.

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

Request

  • Base URL
    https://sandbox.pismolabs.io/bacs
  • URL
    https://sandbox.pismolabs.io/bacs/v1/payments/bacs/directcredit/{id}/reversal
  • Auth
    none declared. Required headers: Authorization, Idempotency-key

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.

Idempotency-keystring 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.

Response

Response Body

payment_idstring

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

outbound_reversal_idstring

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

status'PROCESSING'
  • PROCESSING - Reversal has been submitted and is awaiting settlement

Example response

{
  "payment_id": "1374f841568e4ff4b363b023c170ecdr",
  "outbound_reversal_id": "1374f841568e4ff4b363b023c170ecdr",
  "status": "PROCESSING"
}

Changes

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