Void Payment Request
POST/api/sales-payment-requests/:salesPaymentRequest/void
Void a payment request. Refused once any money counts toward it — refund or reallocate the payment first. Unpaid requests are also voided automatically when their order is cancelled.
orders:writeGrant this scope to your token under Settings → Developer → Personal Access Tokens.
Requires permission sales_payment_requests.void.
Body fields:
reason(string, optional, max 500; kept on the request's note)
Request
Responses
- 200
- 401
- 403
- 404
- 422
- 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.
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.