Sign in

v1

latestOpenAPI 3.1.02026-07-228956435.8 KB
Setup intents

Get a setup intent

Retrieves the setup intent with the given id. The setup intent must belong to your organization and match the live or test mode of the API key used.

get/setup_intents/{id}

Path parameters

idstring required

Unique identifier of the setup intent to retrieve.

Response

The setup intent with the given id.

idstring required

Unique identifier of the setup intent.

object'setup_intent' required

Type of the object. Always setup_intent.

error_reason'null' | 'login_invalid_credentials' | 'login_credentials_locked' | 'authorization_timeout' | 'mfa_authorization_timeout' | 'mfa_unavailable' | 'bank_connection_error' | 'bank_not_available' | 'password_change_required' | 'request_timeout' | 'subscription_intent_expired' | 'account_type_not_permitted' | 'internal_error' | 'user_left' | 'card_declined' | 'invalid_card_credentials' | 'invalid_card' | 'authentication_failed' | 'insufficient_funds' nullable required

Error code describing why the latest setup attempt failed. null until an attempt fails and when the setup succeeds.

status'created' | 'started' | 'waiting_for_retry' | 'succeeded' | 'failed' required

Lifecycle status of the setup intent. One of created, started, waiting_for_retry, succeeded, or failed.

Example response

{
  "id": "seti_xL9mPq2RkV3WnDQG",
  "error_reason": "invalid_card",
  "status": "failed"
}