---
title: "Get the status of a payout order"
method: GET
path: "/payout_orders/{payout_order_id}/state"
tags: ["Payout orders State"]
---

# Get the status of a payout order

`GET /payout_orders/{payout_order_id}/state`

## Request

- Base URL: `https://api.treasury.shinkansen.finance/v1`
- URL: `https://api.treasury.shinkansen.finance/v1/payout_orders/{payout_order_id}/state`
- Auth: API key in header `Shinkansen-Treasury-Api-Key`

Can be used when the participant is unsure whether a payout order response was sent to their webhook or is still pending. See the response schema for the full list of payout order states.

## Response `200`

Returns the state of the payout order identified by the given id.

- PayoutOrderState: Payout order state
  - `shinkansen_payout_order_state` 'created' | 'waiting_validation' | 'waiting_approval' | 'approved' | 'scheduled' | 'pending_funds' | 'enqueued' | 'executing' | 'cancelled' | 'rejected' | 'succeeded' | 'partially_succeeded' | 'failed': The state of the payout order. This can be any of these values: * `created`: the payout was created (initial state) * `waiting_validation`: the recipient account is being validated before the payout order can move on * `waiting_approval`: the payout is waiting for approval * `approved`: payout was approved will soon be enqueued or executed * `scheduled`: the payout order was approved and is waiting for its execution date * `pending_funds`: the payout order is held because the funding account does not have enough balance yet * `enqueued`: the payout order is waiting in a queue to be executed * `executing`: the payout order is being executed (the payout is executing) * `cancelled`: the payout order was cancelled by sender * `rejected`: the payout order was rejected by a representative * `succeeded`: the payout was executed successfully * `partially_succeeded`: the payout was split into chunks and some succeeded while others failed (only for chunked orders) * `failed`: the payout failed execution

## Other responses

- `404`: Requested payout is not found.

---

[API](https://skmtc.dev/shinkansen/apis/treasury-shinkansen-endpoints.md) - [All operations](https://skmtc.dev/shinkansen/apis/treasury-shinkansen-endpoints/llms.txt) - [OpenAPI document](https://skmtc.dev/shinkansen/apis/treasury-shinkansen-endpoints/revisions/2d3ec7684af3?raw)