MVS Pay APIPayouts

Retrieve a payout

Fetch a single payout by id, joined with its settlement extension (or null).

Authentication

x-api-keystring

A scoped MvsPayApiKey, e.g. mvspay_live_…. Mint and scope keys from the dashboard (Settings → API Keys).

Path parameters

idstringRequired

Response

The payout.
payoutobject

Hyperswitch payout response. Loosely typed; extra Hyperswitch fields pass through.

extensionobject or null

Org-scoped sidecar persisted alongside the Hyperswitch payout. Carries the MVS platform approval workflow (the gate before payout funds move).

Errors

401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
500
Internal Server Error
502
Bad Gateway Error