Withdraw a payment run

POSThttps://api.sandbox.stridehq.ai/v1/payment_runs/{id}/withdraw

Withdraws a run that is still pending_approval. Its invoices go back to approved.

Scope payment_runs:prepare

View as Markdown

Path parameters

id stringrequired

The payment run's id.

Headers

Idempotency-Key string

A unique value, such as a UUID. The same key and body within 24 hours returns the original response.

Responses

Language

Credentials

Bearer

URL

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

Request

curl -X POST "https://api.sandbox.stridehq.ai/v1/payment_runs/{id}/withdraw" \
  -H "Authorization: Bearer $STRIDEHQ_API_KEY" \
  -H "Idempotency-Key: 5f2b9c1e-3a7d-4e8f-9b0c-1d2e3f4a5b6c"

Response

{
  "id": "run_3e5a7c9b1d2f4a6c8e0b2d4f6a8c0e1d",
  "object": "payment_run",
  "reference": "PR-BRIGHT-26-014",
  "status": "pending_approval",
  "created_by_type": "api",
  "invoice_ids": [
    "inv_4b1e7d2a9c3f4e5d8a6b0c1d2e3f4a5b"
  ],
  "skipped": [
    {
      "invoice_id": "inv_0a2c4e6b8d1f4a3c5e7b9d0f2a4c6e8b",
      "code": "bank_details_missing",
      "message": "The creator hasn't added bank details."
    }
  ],
  "funding_currency": "GBP",
  "totals": [
    {
      "currency": "GBP",
      "amount": 250000
    }
  ],
  "subtotal": 250000,
  "fee_rate": "2.50",
  "transaction_fee": 6250,
  "international_payment_fee": 0,
  "total_amount": 256250,
  "amount_received": 0,
  "amount_outstanding": 256250,
  "approved_by": null,
  "approved_at": null,
  "approval_url": "https://app.stridehq.ai/payments/runs?tab=runs",
  "notes": "Weekly creator payments",
  "metadata": {},
  "created_at": "2026-10-29T09:00:00Z",
  "updated_at": "2026-10-29T09:00:00Z"
}

Example response. Try it opens with the sandbox.