Prepare a payment run
POSThttps://api.sandbox.stridehq.ai/v1
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.
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 that are due. With no rules, every approved invoice that's due is included.
invoice_ids array of string
Approved invoices to include, up to 200.
due_within_days integer
Rule. Invoices due on or before this many days from today (0 to 365). An invoice with no due date counts as due today.
include_overdue boolean
Rule. Include invoices past their due date. Default true.
currency string
Rule. Only invoices paid in this currency (ISO 4217).
limit_amount integer
Rule. Invoices are added oldest due date first until the next would go over this total, in minor units. Needs currency when the invoices are in more than one.
notes string
Shown to the approver. Up to 500 characters.
metadata object
Up to 20 string keys (up to 40 characters) and values (up to 500 characters), for your use. StrideHQ never reads them. Send null to clear it.