---
title: "Get a list of all payouts for the merchant"
method: GET
path: "/v3/reconciliation/payouts"
tags: ["payoutList"]
---

# Get a list of all payouts for the merchant

`GET /v3/reconciliation/payouts`

This API is used to indicate if there are payouts available after a payout run.
If there are no payouts for any reason, API will indicate it in the response by returning an empty list..

## Query parameters

- `size` integer
- `page` integer
- `date` string, date

## Response `200`

Payouts List Response

- PayoutListResponse — Base paginated list response
  - `size` integer, required — the total number of elements in the current page of this response
  - `totalPages` integer, required — the total number of pages in the response
  - `totalElements` integer, required — the total number of elements in the response
  - `number` integer, required — the current page number
  - `payouts` PayoutListItem[], required — a list of payouts. If the list is empty, then there were no payouts made.
    - `payoutId` string, required — The unique identifier associated with the payout if a pay-out was successfully created
    - `merchantId` string, required — The merchant id used during aggregation of the payout run
    - `bulkId` string, required — The bulk id used during aggregation of the of the payout run if available, if not `NONE` would be sent as default
    - `iban` string, required — The IBAN in (ISO 13616) format used during aggregation of the payout run and this will be used to payout to the merchant
    - `payoutStatus` 'SUCCEEDED' | 'FAILED', required — * _SUCCEEDED_ - Payout was successfully processed * _FAILED_ - Payout failed.
    - `payoutDate` string, date-time, required — timestamp, when payout was created in UTC
    - `payoutCurrency` 'EUR', required — currency code. Only EUR is supported [ISO 4217](http://en.wikipedia.org/wiki/ISO_4217)
    - `totalPayments` integer, required — The total number of payments included in the payout
    - `totalRefunds` integer, required — The total number of refunds included in the payout
    - `totalPaymentAmount` integer, required — The total payment amount in cents contained in the payout.
    - `totalRefundAmount` integer, required — The total refund amount in cents contained in the payout.
    - `payoutAmount` integer, required — Total amount in cents paid out the to merchant

## Other responses

- `400` — Error codes: * _BAD_REQUEST_ - some field in the request was not formatted correctly
- `401` — If JWS signature is not valid. Error codes: * _UNAUTHORIZED_ - caller doesn't have valid authentication credentials
- `403` — Error codes: * _ACCESS_DENIED_ - operation not allowed, caller doesn't have required authorities
- `500` — Error codes: * _TECHNICAL_ERROR_ - technical error
- `503` — Service is unavailable

---

[API](https://skmtc.net/bancontactpro/apis/merchant-reconciliation-api.md) · [All operations](https://skmtc.net/bancontactpro/apis/merchant-reconciliation-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/bancontactpro/merchant-reconciliation-api/revisions/8124fa43e7e9/schema)
