Skip to content
XOS Developers

payoutAccounts

Gateway module · 4 operations

List payout account rows

GET/payout-accounts

Payout details held by the payment provider. XOS stores provider references only. Returns a cursor page of payout account rows the caller may see. The default order is `created_at` ascending. Supports sparse fieldsets and the filter grammar.

Create a payout account

POST/payout-accounts

Payout details held by the payment provider. XOS stores provider references only. Creates a payout account. Requires `Idempotency-Key`; a replay returns the original response. The organization is derived from the credential or the parent row, never from the body.

Get a payout account

GET/payout-accounts/{id}

Payout details held by the payment provider. XOS stores provider references only. Returns one payout account with its `ETag`. A payout account the caller may not see returns 404.

Delete a payout account

DELETE/payout-accounts/{id}

Payout details held by the payment provider. XOS stores provider references only. Soft-deletes the payout account: it moves to Trash and can be restored for its table's retention period.