Initiate Mercury Payment Batch
POST/api/mercury/payment-batches
Initiate a batch of payments to send to Mercury for approval.
This endpoint currently requires session authentication; Personal Access Token scope support is in progress.
Bill payment approval policy: when the tenant's bill payment approval policy is enabled, each purchase invoice must be approved for at least the amount being paid. Otherwise the request is refused with 422 and code approval_required (or approval_pending while the approval is still waiting). On a connection that approves payments in SKU.io, a payment the policy already approved is sent to Mercury straight away instead of waiting for a second SKU.io approver. Landed-cost and service bills are not governed by the policy.
Request
Responses
- 200
- 401
- 403
- 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.
Validation failed — the body is a field → messages map (Laravel shape) or the platform envelope with a stable machine-readable code. Fix the payload and resubmit.
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.