Setup Intents

Retrieve setup status

Changed on

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

Request

  • Base URL: https://api.whop.com/api/v1
  • URL: https://api.whop.com/api/v1/setup_intents/{setup_intent_id}/status
  • Auth: HTTP bearer

Path parameters

setup_intent_idstring required

The unique identifier of the setup intent.

Response

Setup status retrieved

idstring required

The setup this status describes, prefixed sint_.

objectstring required

Always setup_status.

return_urlstring 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. 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.

Example response

{
  "id": "sint_xxxxxxxxxxxxxx",
  "last_setup_error": {
    "code": "enrollment_declined",
    "message": "The bank declined the enrollment."
  },
  "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"
}

Changes

  • c771dc00bca6Revision changes
    • breaking

      added to the //// response property oneOf list for the response status

    • info

      added collect_card_present discriminator mapping keys to the //// response property for the response status

  • 1660b8d62204Revision changes
    • info

      added the optional property ///////// to the response with the status