List payouts | MVS Developer Docs

Lists Hyperswitch payouts for the authenticated organization via the engine SDK (GET /v1/payouts), each joined with its org-scoped settlementExtension sidecar (the MVS platform approval-workflow gate). The sidecar is attached as extension, or null when none has been persisted or it belongs to a different organization. Pagination uses limit/offset; total is the engine’s total_count when present, otherwise payouts.length + offset.

Lists Hyperswitch payouts for the authenticated organization via the engine SDK (`GET /v1/payouts`), each joined with its org-scoped `settlementExtension` sidecar (the MVS platform approval-workflow gate). The sidecar is attached as `extension`, or `null` when none has been persisted or it belongs to a different organization. Pagination uses `limit`/`offset`; `total` is the engine's `total_count` when present, otherwise `payouts.length + offset`.

Authentication

x-api-keystring

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

Query parameters

limitintegerOptionalDefaults to 50

Max rows to return.

offsetintegerOptionalDefaults to 0

Rows to skip.

Response

A page of payouts, each with its settlement-extension sidecar.

payoutslist of objects

totalinteger

limitinteger

offsetinteger

Errors

401

Unauthorized Error

403

Forbidden Error

500

Internal Server Error

502

Bad Gateway Error

1	{
2	"payouts": [
3	{
4	"payout_id": "payout_Rk3sample789",
5	"status": "requires_confirmation",
6	"amount": 50000,
7	"currency": "USD",
8	"extension": {
9	"id": "stx_01",
10	"organizationId": "org_acme",
11	"hyperswitchPayoutId": "payout_Rk3sample789",
12	"approvalStatus": "PENDING",
13	"createdAt": "2026-06-21T12:00:00.000Z",
14	"updatedAt": "2026-06-21T12:00:00.000Z"
15	}
16	}
17	],
18	"total": 1,
19	"limit": 50,
20	"offset": 0
21	}

$	curl https://pay.mvscloud.com/api/payouts \
>	-H "x-api-key: <apiKey>"