---
title: "Search payouts by gateway_account_id and state"
method: GET
path: "/v1/payout"
tags: ["Payouts"]
---

# Search payouts by gateway_account_id and state

`GET /v1/payout`

## Query parameters

- `state` string
- `page` integer
- `display_size` integer
- `override_account_id_restriction` boolean
- `gateway_account_id` string, required

## Response `200`

OK

- PayoutSearchResponse
  - `_links` PaginationBuilder
    - `first_page` PaginationLink
      - `href` string
    - `last_page` PaginationLink
      - `href` string
    - `next_page` PaginationLink
      - `href` string
    - `prev_page` PaginationLink
      - `href` string
    - `self` PaginationLink
      - `href` string
  - `count` integer
  - `page` integer
  - `results` PayoutView[]
    - `amount` integer — amount in pence
    - `created_date` string, date-time
    - `gateway_account_id` string
    - `gateway_payout_id` string
    - `live` boolean
    - `paid_out_date` string, date-time
    - `service_id` string
    - `state` 'UNDEFINED' | 'IN_TRANSIT' | 'PAID_OUT' | 'FAILED'
  - `total` integer

## Other responses

- `404` — Not found

---

[API](https://skmtc.net/government-digital-service/apis/ledger-api.md) · [All operations](https://skmtc.net/government-digital-service/apis/ledger-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/government-digital-service/ledger-api/revisions/10ffeffca918/schema)