---
title: "Get a payout"
method: GET
path: "/v2/payouts/{payout_id}"
tags: ["Payouts"]
---

# Get a payout

`GET /v2/payouts/{payout_id}`

## Request

- Base URL: `https://api.getpaid.io`
- URL: `https://api.getpaid.io/v2/payouts/{payout_id}`
- Auth: OAuth 2
  - Client credentials
  - Token URL: `https://auth.getpaid.io/oauth/token` scopes: `payouts:read`
- TypeScript: <https://skmtc.dev/getpaid/apis/getpaid-api/docs/v2/payouts/:payout_id/get.ts> (a function with typed inputs; its response is checked against the schema)

Retrieve the payout details. Use the payout movements query endpoint to retrieve its assigned movements.

## Path parameters

- `payout_id` string, id, required: The unique identifier of the payout.

## Response `200`

OK

- Payout
  - `id` string, id, required: The unique identifier of the payout.
  - `reference` string, required: An identifier in your system. It is recommended to make it unique but the uniqueness is not enforced by the solution.
  - `account` SellerRef, required: A reference to the seller account.
    - `id` string, id, required: The unique identifier of the account.
    - `legal_name` string, required: The legal name of the account.
  - `status` 'initiated' | 'movements_assigned' | 'transfer_initiated' | 'completed' | 'rejected', required: The status of the payout. See the [list, transitions, and description of each status](/manage-funds/payouts/lifecycle) for more details.
  - `reason` PayoutReason: Reason of the status of the resource when it requires additional steps or is a failure state.
    - `code` string, required: Code to identify the cause of the status of the resource.
    - `description` string, required: Human-readable description of the reason for the status of the resource.
  - `amount` integer, required: The payment amount in the minor currency unit (e.g. 100 cents for 1 EUR).
  - `currency` string, currency, required: The processing currency code according to the [ISO-4217 standard](https://en.wikipedia.org/wiki/ISO_4217)
  - `created_at` string, date-time, required: UTC timestamp in ISO 8601 format with milliseconds ([RFC 3339](https://www.rfc-editor.org/rfc/rfc3339.html)). Always includes the 'Z' UTC indicator.
  - `updated_at` string, date-time, required: UTC timestamp in ISO 8601 format with milliseconds ([RFC 3339](https://www.rfc-editor.org/rfc/rfc3339.html)). Always includes the 'Z' UTC indicator.
  - `cutoff` PayoutCutoff, required: Time range used to determine which movements are included in the payout. The range is half-open: `from` is inclusive and `to` is exclusive.
    - `from` string, date-time, required: UTC timestamp in ISO 8601 format with milliseconds ([RFC 3339](https://www.rfc-editor.org/rfc/rfc3339.html)). Always includes the 'Z' UTC indicator.
    - `to` string, date-time, required: UTC timestamp in ISO 8601 format with milliseconds ([RFC 3339](https://www.rfc-editor.org/rfc/rfc3339.html)). Always includes the 'Z' UTC indicator.

## Other responses

- `401`: Unauthorized
- `404`: Not Found
- `422`: Invalid Parameters
- `429`: Too Many Requests
- `500`: Internal Server Error

---

[API](https://skmtc.dev/getpaid/apis/getpaid-api.md) - [All operations](https://skmtc.dev/getpaid/apis/getpaid-api/llms.txt) - [OpenAPI document](https://skmtc.dev/getpaid/apis/getpaid-api/revisions/458eae3d49ad?raw)