v8

OpenAPI 3.1.02026-08-033623795.0 MB

Setup intents

Retrieve setup intent

Retrieves the details of an existing setup intent.

Required permissions:

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

get/setup_intents/{id}

Path parameters

idstring required

Example:sint_xxxxxxxxxxxxx

The unique identifier of the setup intent.

Response

A successful response

created_atstring date-time required

The datetime the setup intent was created.

error_messagestring nullable required

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

idstring required

The unique identifier for the setup intent.

metadataobject nullable required

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

status'processing' | 'succeeded' | 'canceled' | 'requires_action' required

The status of the setup intent.

three_ds_verifiedboolean required

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

Example response

{
  "checkout_configuration": {
    "id": "ch_xxxxxxxxxxxxxxx"
  },
  "company": {
    "id": "biz_xxxxxxxxxxxxxx"
  },
  "created_at": "2023-12-01T05:00:00.401Z",
  "error_message": "Your card was declined.",
  "id": "sint_xxxxxxxxxxxxx",
  "payment_method": {
    "card": {
      "exp_month": 42,
      "exp_year": 42,
      "last4": "4242"
    },
    "created_at": "2023-12-01T05:00:00.401Z",
    "id": "payt_xxxxxxxxxxxxx"
  }
}