APIs
Sub-processorsAbout PismoContact us

Raise BACS Direct Debit indemnity claim [beta]

post
https://sandbox.pismolabs.io/bacs/v1/payments/bacs/directdebit/claims

Raise a Bacs Direct Debit Indemnity Claim (DDIC).

A DDIC reclaims money that was incorrectly debited from a payer's account under the Direct Debit Guarantee. The claim is validated and persisted, then submitted asynchronously to the Bacs scheme via Form3.

Notes:

  • The operation is idempotent via the Idempotency-key header. Repeating the same key replays the original claim.

  • The claim is persisted with status = CREATED and submitted asynchronously. Creation itself returns immediately. Subsequent status transitions generate a BACS direct debit claim status changed event (for example PROCESSING, CONFIRMED, FAILED).

  • reason_code must be a Bacs DDIC reason code (1–8). Code 3 also requires processing_date. Code 7 also requires contact_name and request_date.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

Raise claim request body

Payload to raise a DDIC claim

string
required
^[0-9]{6}$

The six-digit Bacs Service User Number (SUN) of the institution raising the claim

string
required
length ≤ 18
^DDIC[A-Za-z0-9]{2,14}$

Claim reference. Must begin with DDIC followed by 2–14 alphanumeric characters (maximum length 18). The DDIC prefix is reserved by Bacs for indemnity-claim references.

string
enum
required

Bacs DDIC reason code identifying why the indemnity claim is being raised, as defined by the Bacs DDIC scheme rules:

  • 1—The amount and/or date collected differs from the advance notice.
  • 2—No advance notice was received (or the payment was collected earlier than notified).
  • 3—The Direct Debit Instruction (DDI) is disputed / no valid mandate is held.
  • 4—The payer canceled the DDI directly with the service user.
  • 5—The account holder is deceased.
  • 6—The payer canceled the DDI with their bank.
  • 7—Claim raised at the service user's request.
  • 8—Service user name disputed / the payer does not recognise the collecting service user.

Conditional fields:

  • 3—processing_date is required.
  • 7—contact_name and request_date are required.
original_instruction
object
required

The original Direct Debit Instruction (DDI) the claim relates to

disputed_transactions
array of objects
required
length between 1 and 12
disputed_transactions*

A single disputed Direct Debit collection included in the claim

string
required
length ≤ 20

Disputed transaction amount

date
required

Date of the disputed transaction. Format = YYYY-MM-DD.

int32

Optional. If provided (non-zero), it must equal the number of disputed_transactions. Maximum 12.

date

Required when reason_code is 3. Must not be set otherwise. Format = YYYY-MM-DD.

string
length ≤ 51

Service user contact name. Required when reason_code is 7. Must not be set otherwise. Must not be all spaces.

date

Service user request date. Required when reason_code is 7. Must not be set otherwise. Format = YYYY-MM-DD.

string
length ≤ 255

Optional free-text reason for the claim

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
length ≤ 32

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 12 hours 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 12 hours ago

Did this page help you?