Skip to main content
GET
Retrieve setup intent
This page documents the Legacy API. For new integrations, use Retrieve Setup Intent in the Current API.
Required permissions:
  • payment:setup_intent:read
  • member:basic:read
  • member:email:read

Autorisationer

Authorization
string
header
påkrævet

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

Scopes

payment:setup_intent:read
member:basic:read
member:email:read

Sti-parametre

id
string
påkrævet

The unique identifier of the setup intent.

Eksempel:

"sint_xxxxxxxxxxxxx"

Svar

A successful response

A setup intent allows a user to save a payment method for future use without making an immediate purchase.

checkout_configuration
object | null
påkrævet

The checkout session configuration associated with this setup intent. Null if no checkout session was used.

company
object | null
påkrævet

The company that initiated this setup intent. Null if the company has been deleted.

created_at
string<date-time>
påkrævet

The datetime the setup intent was created.

Eksempel:

"2023-12-01T05:00:00.401Z"

error_message
string | null
påkrævet

A human-readable error message explaining why the setup intent failed. Null if no error occurred.

Eksempel:

"Your card was declined."

id
string
påkrævet

The unique identifier for the setup intent.

Eksempel:

"sint_xxxxxxxxxxxxx"

member
object | null
påkrævet

The company member associated with this setup intent. Null if the user is not a member.

metadata
object | null
påkrævet

Custom key-value pairs attached to this setup intent. Null if no metadata was provided.

payment_method
object | null
påkrævet

The saved payment method created by this setup intent. Null if the setup has not completed successfully.

status
enum<string>
påkrævet

The current status of the setup intent.

Tilgængelige muligheder:
processing,
succeeded,
canceled,
requires_action
three_ds_verified
boolean
påkrævet

Whether 3D Secure authentication was completed when this payment method was set up.