Fail a payment

POSThttps://api.sandbox.stridehq.ai/v1/test_helpers/payments/{id}/fail

Sandbox only. Fails one payment, with the reason you choose.

Scope payment_runs:prepareSandbox only

Path parameters

id stringrequired

The payment's id.

Body parameters

failure_reason string

One of: bank_details_invalidaccount_closedreturned_by_bankcompliance_holdother

Responses

Language

Credentials

Bearer

URL

https://api.sandbox.stridehq.ai/v1

Request

curl -X POST "https://api.sandbox.stridehq.ai/v1/test_helpers/payments/{id}/fail" \
  -H "Authorization: Bearer $STRIDEHQ_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "failure_reason": "returned_by_bank"
}'

Response

{
  "id": "pay_7c9e1a3b5d7f4a2c8e0b1d3f5a7c9e1b",
  "object": "payment",
  "payment_run_id": "run_3e5a7c9b1d2f4a6c8e0b2d4f6a8c0e1d",
  "creator_id": "cre_8f3a2c1d9b7e4f60a1b2c3d4e5f60718",
  "invoice_id": "inv_4b1e7d2a9c3f4e5d8a6b0c1d2e3f4a5b",
  "amount": 250000,
  "currency": "GBP",
  "funding_amount": 250000,
  "funding_currency": "GBP",
  "fx_rate": null,
  "status": "paid",
  "failure_reason": null,
  "failure_message": null,
  "paid_at": "2026-10-30T10:12:00Z",
  "bank_account_last4": "4821",
  "created_at": "2026-10-29T09:00:00Z"
}

Example response. Try it opens with the sandbox.