Preview Payment Approval Routing
GET/api/purchase-invoices/payment-request-routing
Preview where a bill payment request of a given amount would be routed, before submitting it. Returns the routing mode and the resolved payer (if the amount routes directly to a single payer).
Authentication: Requires Bearer token.
Query parameters:
- amount (optional, numeric, >= 0): Amount to evaluate. Defaults to 0.
Routing modes: approval_levels (multi-step approval chain), payer (single designated payer to send the request to), self_payer (the acting user is the designated payer, so they approve and record the payment directly instead of sending a request to themselves), threshold_approval (single approval against a threshold), auto_approve (no approval required).
Request
Responses
- 200
- 401
- 403
- 429
OK
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.
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.