---
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`

Can be used when the participant is unsure whether a payout order response was sent to their webhook or is still pending. The payout oder state is either "created", "waiting_approval", "approved", "enqueued", "executing", "cancelled", "rejected", "succeeded" or "failed"

## Response `200`

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

- PayoutOrderState — Payout order state
  - `shinkansen_payout_order_state` 'created' | 'waiting_approval' | 'approved' | '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_approval`: the payout is waiting for approval * `approved`: payout was approved will soon be enqueued or executed * `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.net/shinkansen/apis/payouts-shinkansen-endpoints.md) · [All operations](https://skmtc.net/shinkansen/apis/payouts-shinkansen-endpoints/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/shinkansen/payouts-shinkansen-endpoints/versions/1e4a6760b7e8/schema)