---
title: "Retrieve setup status"
method: GET
path: "/setup_intents/{setup_intent_id}/status"
tags: ["Setup Intents"]
---

# Retrieve setup status

`GET /setup_intents/{setup_intent_id}/status`

Retrieves how far a setup has got and what the buyer must do next, if anything. Collection runs in the background, so poll this rather than reading the create response. Accepts either a secret key or the setup's own `client_secret`, so the surface collecting the payment method can poll it directly.

## Path parameters

- `setup_intent_id` string, required

## Response `200`

Setup status retrieved

- SetupStatus
  - `id` string, required — The setup this status describes, prefixed `sint_`.
  - `next_action` PaymentNextAction, required
    - `data` object, required — The payload for this step's type: `url` for `redirect`, `kind` plus that kind's details for `display_instructions`, `expires_at` for `await_confirmation`.
    - `render` string[], required
    - `type` 'redirect' | 'display_instructions' | 'await_confirmation', required — What kind of step this is. `redirect` — send the buyer to `data.url`. `display_instructions` — show them `data`, such as a voucher code or bank transfer details. `await_confirmation` — nothing to show; they have done their part.
  - `object` string, required — Always `setup_status`.
  - `return_url` string, nullable, required — Where to send the buyer once the setup reaches a resting state, or `null` to leave them where they are.
  - `status` 'processing' | 'succeeded' | 'canceled' | 'requires_action', required — How far the setup has got. `requires_action` — the buyer has a step outstanding; see `next_action`. `processing` — the buyer has done their part and the processor is deciding. `succeeded` — the payment method is saved. `canceled` — abandoned or refused.

## Other responses

- `401` — Unauthorized
- `403` — Forbidden
- `404` — Resource not found

---

[API](https://skmtc.net/whop/apis/whop-api.md) · [All operations](https://skmtc.net/whop/apis/whop-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/whop/whop-api/versions/866821546d67/schema)