Skip to main content
GET
Retrieve setup status

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

Setup status retrieved

id
string
required

The setup this status describes, prefixed sint_.

next_action
object | null
required

What the buyer must do next while status is requires_action, otherwise null.

object
string
required

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

status
enum<string>
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.

Available options:
processing,
succeeded,
canceled,
requires_action
Example:

"processing"