Request access

Prepare a payment run

POSThttps://api.sandbox.stridehq.ai/v1/payment_runs

Prepares a run from approved invoices, by id or by rules. Invoices that can't be paid are left out, each with a reason in skipped. The run waits for a person to approve it in StrideHQ; no key can approve, fund or pay. Idempotency-Key is required.

Scope payment_runs:prepare

Headers

Idempotency-Key stringrequired

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

Body parameters

Send invoice_ids, or rules to pick approved invoices.

invoice_ids array of string

Approved invoices to include.

due_within_days integer

Rule. Invoices due within this many days.

include_overdue boolean

Rule. Include overdue invoices.

limit_amount integer

Rule. Stop adding invoices at this total, in minor units.

notes string

Shown to the approver.

metadata object

Up to 20 string keys and values, for your use. StrideHQ never reads them.

Responses