Skip to main content
A payout is money Quidkey sends to the merchant’s own bank account, carrying a batch of transactions. Payouts send no webhook events, so poll them.

1. List Payouts

Payouts come newest first. Each one has: A payout that fails while being sent leaves the list, and reading it answers 404, until Quidkey staff resolve it. It then comes back under the same id. Part or all of its money may have moved by then.

2. List a Payout’s Transactions

The payout’s transactions link is the same list. Each transaction’s payout_amount is what it adds to the payout, after fees and any conversion, and exchange_rate explains the conversion. The amounts are authoritative: don’t recompute them from the rate. A transaction’s payout links back to the payout that carries it, and is null until it’s batched.

Export a Payout’s Transactions

For an accounting tool, ask for the same list as a file:
The file holds every transaction the payout carries, one per row, with no paging. Its amounts are decimals beside a currency column, which a tool sums as written. Accept: application/vnd.openxmlformats-officedocument.spreadsheetml.sheet answers an Excel workbook instead. Transaction export lists the columns, and Files the rules, among them a limit of 10,000 rows.

3. Read Balances

A merchant’s virtual accounts, which Quidkey holds for it, each have a balance. To read them:
Each account’s balance is in entities, with the amount its provider reports, and retrieved_at. An amount of null means Quidkey couldn’t get a figure, and never means zero. Every read asks the provider, so don’t poll balances tightly. To total a currency, add currency=EUR and sum each balance on the page. A credential without permission to read balances gets the accounts, with each balance in not_included. Test payment transactions don’t appear in payouts or balances: those show live money only.