Create Payment Request
POST/api/sales-orders/:salesOrder/payment-requests
Raise a payment request on a sales order by hand. Send either amount (order currency) or percent (of the order total including tax) — not both. The request is numbered from the payment request number format in Sales Invoice settings (default {order}-PR{seq}). Set send to email it straight away.
orders:writeGrant this scope to your token under Settings → Developer → Personal Access Tokens.
Requires permission sales_payment_requests.create. The order must be confirmed (not draft) and not cancelled; the amount can't exceed the order total.
Body fields:
amount(number, required withoutpercent, > 0)percent(number, required withoutamount, > 0, ≤ 100)due_date(string Y-m-d, optional; omit for due on receipt)note(string, optional, max 2000)send(boolean, optional, default false)
Request
Responses
- 201
- 401
- 403
- 404
- 422
- 429
Created
Response Headers
Unauthenticated — the bearer token is missing, revoked, expired, or malformed. Never retry automatically; fix the credential. See the Errors guide.
Forbidden — the token lacks a required scope, the endpoint is not available to API tokens, or the user behind the token lacks the permission. A human must adjust the token scopes or user permissions; do not retry.
Not found — no record with the given identifier (or the route does not exist). Verify the ID before retrying.
Unprocessable Entity
Response Headers
Rate limited — platform limit is 1,000 requests/min; individual tokens may carry lower limits. Honor the Retry-After header before retrying. See the Rate Limits guide.