PIpismo
BACS direct debit

Reverse BACS Direct Debit indemnity claim [beta]

Reverse a previously raised BACS Direct Debit indemnity claim.

Only a claim that has been delivery-confirmed (status = CONFIRMED) can be reversed. The reversal is persisted with status = CREATED and submitted asynchronously to the BACS scheme via Form3.

Notes:

post/v1/payments/bacs/directdebit/claims/reversal/{id}

Request

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

Path parameters

idstring required

Local claim ID (the Pismo-assigned ID returned when the claim was raised) of the claim to reverse

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

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.

Request body

original_instruction_idstring required

Claim being reversed's DDIC claim sequence number. Forwarded to the scheme.

reasonstring

Free-text reason for reversal

Example request

{
  "original_instruction_id": "0000000000001234",
  "reason": "Claim raised in error"
}

Response

Claim reversal created

idstring

Pismo-assigned local claim-reversal ID

claim_idstring

Pismo-assigned local claim ID

status'CREATED' | 'PROCESSING' | 'CONFIRMED' | 'FAILED'

DDIC claim / claim-reversal lifecycle status_reason:

  • CREATED—Claim persisted, pending submission to the scheme via Form3.

  • PROCESSING—Claim submitted and in flight through Form3 / the scheme.

  • CONFIRMED—Claim delivery confirmed by the scheme. Terminal state.

  • FAILED—Claim rejected or failed validation/submission. Terminal state.

Example response

{
  "id": "019e9300-1111-7c54-9d17-89f5542a06e4",
  "claim_id": "019e92ec-3362-7c54-9d17-89f5542a06e4",
  "status": "CREATED"
}

Changes

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