The client's payout statement, newest first
The client's payout statement, newest first, each row with the amount that left settlement, the fee the wallet kept, the rail and the ledger transaction behind it.
/v1/clients/{clientId}/payoutsThe client's payout statement, newest first, each row with the amount that left settlement, the fee the wallet kept, the rail and the ledger transaction behind it. Needs authority over the client — membership of its organization, an API key bound to this client, or tenant staff holding clients:manage; anything else is refused not_client_member or insufficient_scope (403), and an unknown client client_not_found (404). limit is clamped to 1-100.
Authorization
bearerAuth A tenant API key (sk_{env}_{id}_{secret}), a wallet user token, or an IdP access token. Which principal the credential resolves to decides the scopes it carries; see the authentication guide.
In: header
Path Parameters
uuidQuery Parameters
1 <= value <= 10050Response Body
application/json
application/problem+json
application/problem+json
application/problem+json
curl -X GET "https://example.com/v1/clients/497f6eca-6276-4993-bfeb-53cbbbba6f08/payouts"[ { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "merchant_id": "500924a8-3f5e-4c00-beb8-2efcde988aea", "amount": 0, "fee": 0, "txn_id": "3dd6ecc9-94bf-4fc7-98ae-cdbe5b6f62e4", "rail": "string", "external_ref": "string", "status": "pending_transfer", "created_at": "2019-08-24T14:15:22Z" }]Subscribe to a plan; amount and interval come from the catalog
Subscribes the calling consumer to a published plan.
Pay out settlement money (books first, transfer follows)
Draws the merchant's settlement money to the tenant treasury and records the payout; the external transfer is executed off-platform, so this call moves the books, not the bank.