Setup Intents

List Setup Intents

Changed on

Lists setup intents newest first. An account API key lists its own account; a user token lists every account it can read, or one account with account_id.

get/setup_intents

Request

  • Base URL: https://api.whop.com/api/v1
  • URL: https://api.whop.com/api/v1/setup_intents
  • Auth: HTTP bearer

Query parameters

account_idstring

Only setup intents for this account, prefixed biz_.

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

Only setup intents in this state.

created_beforestring date-time

Only setup intents created before this ISO 8601 timestamp.

created_afterstring date-time

Only setup intents created after this ISO 8601 timestamp.

order'created_at'

The field to sort by.

direction'asc' | 'desc'

The sort direction.

firstinteger

Number of results to return from the start of the range.

afterstring

Return results after this cursor. Use page_info.end_cursor from the previous response to fetch the next page.

lastinteger

Number of results to return from the end of the range.

beforestring

Return results before this cursor. Use page_info.start_cursor from the previous response to fetch the previous page.

Response

setup intents listed

Example response

{
  "data": [
    {
      "account_id": "biz_xxxxxxxxxxxxxx",
      "client_secret": "sint_xxxxxxxxxxxxxx_secret_vdefault_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
      "created_at": "2026-01-01T12:00:00.000Z",
      "id": "sint_xxxxxxxxxxxxxx",
      "last_setup_error": {
        "code": "enrollment_declined",
        "message": "The bank declined the enrollment."
      },
      "member_id": "mber_xxxxxxxxxxxxxx",
      "metadata": {
        "customer_id": "cus_4417"
      },
      "payment_instrument": {
        "card": {
          "brand": "visa",
          "exp_month": 10,
          "exp_year": 2031,
          "issuer_identification_number": "41111111",
          "last4": "4242"
        },
        "display_name": "Visa •••• 4242",
        "icons": {
          "card": {
            "dark": {
              "png_1x": "https://content.whop.com/payment_methods/visa/icons/card_dark_30.png",
              "png_2x": "https://content.whop.com/payment_methods/visa/icons/card_dark_60.png",
              "png_4x": "https://content.whop.com/payment_methods/visa/icons/card_dark_120.png",
              "svg": "https://content.whop.com/payment_methods/visa/icons/card_dark.svg"
            },
            "light": {
              "png_1x": "https://content.whop.com/payment_methods/visa/icons/card_dark_30.png",
              "png_2x": "https://content.whop.com/payment_methods/visa/icons/card_dark_60.png",
              "png_4x": "https://content.whop.com/payment_methods/visa/icons/card_dark_120.png",
              "svg": "https://content.whop.com/payment_methods/visa/icons/card_dark.svg"
            }
          },
          "square": {
            "dark": {
              "png_1x": "https://content.whop.com/payment_methods/visa/icons/card_dark_30.png",
              "png_2x": "https://content.whop.com/payment_methods/visa/icons/card_dark_60.png",
              "png_4x": "https://content.whop.com/payment_methods/visa/icons/card_dark_120.png",
              "svg": "https://content.whop.com/payment_methods/visa/icons/card_dark.svg"
            },
            "light": {
              "png_1x": "https://content.whop.com/payment_methods/visa/icons/card_dark_30.png",
              "png_2x": "https://content.whop.com/payment_methods/visa/icons/card_dark_60.png",
              "png_4x": "https://content.whop.com/payment_methods/visa/icons/card_dark_120.png",
              "svg": "https://content.whop.com/payment_methods/visa/icons/card_dark.svg"
            }
          }
        },
        "payment_method_type": "card"
      },
      "payment_method_id": "payt_xxxxxxxxxxxxxx",
      "payment_method_type": "acss_debit",
      "return_url": "https://shinetime.example/billing/saved",
      "status": "requires_action",
      "three_ds_level": "frictionless_if_required",
      "updated_at": "2026-01-01T12:00:00.000Z",
      "user": {
        "id": "user_xxxxxxxxxxxxxx",
        "name": "Dana Whitfield",
        "profile_picture": {
          "url": "https://ui-avatars.com/api/"
        },
        "username": "danawhitfield"
      }
    }
  ],
  "page_info": {
    "start_cursor": "WyJjdXJzb3IiLDFd"
  }
}

Changes

  • 507636677fe9Revision changes
    • warning

      added the new payto_bank_account enum value to the ////// response property for the response status

    • warning

      added the new payto_email enum value to the ////// response property for the response status

    • warning

      added the new payto_phone enum value to the ////// response property for the response status

  • a66448c54b9dRevision changes
    • warning

      added the new duitnow_qr enum value to the ////// response property for the response status