Retrieve setup 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.

GET /setup_intents/{setup_intent_id}/status

JavaScript

JavaScript

import Whop from '@whop/sdk';

const client = new Whop({
  apiKey: process.env['WHOP_API_KEY'], // This is the default and can be omitted
});

const response = await client.setupIntents.retrieveStatus('setup_intent_id');

console.log(response.id);

200

{
  "id": "sint_xxxxxxxxxxxxxx",
  "last_setup_error": {
    "code": "enrollment_declined",
    "message": "The enrollment was declined by the payment provider."
  },
  "next_action": {
    "data": {
      "frame_max_width": 500,
      "url": "https://psp.example/3ds/challenge"
    },
    "render": [
      "inline"
    ],
    "type": "redirect"
  },
  "object": "setup_status",
  "return_url": "https://shinetime.example/billing/saved",
  "status": "canceled"
}

Authorizations

Authorization · string · header · required

An Account API key, account-scoped JWT, App API key, or user OAuth token. Prepend the key or token with Bearer, for example Bearer ***************************.

Path Parameters

setup_intent_id · string · required

The unique identifier of the setup intent.

Response

200

application/json

Setup status retrieved

id · string · required

The setup this status describes, prefixed sint_.

Example:

"sint_xxxxxxxxxxxxxx"

last_setup_error · object | null · required

Why the setup ended where it did, or null when nothing has failed. Present on canceled — a buyer who abandoned carries no code, one refused by the provider does.

Show child attributes

next_action · Redirect · object · required

What the buyer must do next while status is requires_action, otherwise null. type picks the shape and each variant carries only its own data, so switching on type gives you exactly that step's payload.

Redirect

Display instructions

Await confirmation

Show child attributes

object · string · required

Always setup_status.

Example:

"setup_status"

return_url · string | null · required

Where to send the buyer once the setup reaches a resting state, or null to leave them where they are.

Example:

"https://shinetime.example/billing/saved"

status · enum<string> · required

How far the setup has got. A 200 means we answered, not that the method was saved — always branch on this. 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, and only this one means saved. canceled — abandoned or refused; see last_setup_error to tell which.

Available options: processing, succeeded, canceled, requires_action

Example:

"canceled"