---
title: "List payouts"
method: GET
path: "/shopwired-payments/payouts"
---

# List payouts

`GET /shopwired-payments/payouts`

## Request

- Base URL: `https://api.ecommerceapi.uk/v1`
- URL: `https://api.ecommerceapi.uk/v1/shopwired-payments/payouts`
- Auth: HTTP basic

Retrieves a list of payouts with pagination.

## Query parameters

- `count` integer
- `offset` integer
- `sort` 'created' | 'created_asc' | 'created_desc'
- `fields` string

## Response `200`

A list of payouts.

- Payout[]
  - `id` string: Unique identifier for the payout.
  - `createdAt` string, date-time: Timestamp when the payout was created.
  - `status` 'pending' | 'in_transit' | 'failed' | 'paid': Current status of the payout.
  - `automatic` boolean: Indicates whether the payout was initiated automatically.
  - `expectedBy` string, date-time: Expected arrival date of the payout.
  - `destination` object: Details of the payout destination.
    - `type` string: Type of destination (e.g., bank_account).
    - `name` string: Name of the bank or institution receiving the payout.
    - `number` string: Last four digits of the receiving account number.

## Other responses

- `400`: Invalid request parameters.
- `401`: Unauthorized. Invalid or missing API key.
- `500`: Server error.

---

[API](https://skmtc.dev/ecommerceapi/apis/shopwired-payments-payouts.md) - [All operations](https://skmtc.dev/ecommerceapi/apis/shopwired-payments-payouts/llms.txt) - [OpenAPI document](https://skmtc.dev/ecommerceapi/apis/shopwired-payments-payouts/revisions/347637690551?raw)