Access tokens1

Account links1

Accounts15

Ad Campaigns9

Ad Conversion Value Rules7

Ad Groups10

Ads8

Affiliates10

Ai chats5

API Keys7

Api Logs1

App Builds4

Apps8

Audiences5

Authorized users4

Bounties7

Bounty Submissions5

Cards6

Cashback Rules4

Chat channels3

Checkout Configurations4

Company token transactions3

Confirmation Tokens1

Course chapters5

Course lesson interactions2

Course lessons8

Course students2

Courses5

Deposits1

Dispute alerts2

Disputes6

Dm channels5

Dm members5

Domains5

Economic Intelligence2

Events4

Experiences8

Experiments8

Exports3

Fee markups3

Files4

Forum posts4

Forums3

Identity profiles4

Invoices9

Leads4

Ledger accounts1

Ledgers3

Media2

Members3

Memberships11

Messages5

Notifications6

Partner Referral Requests6

Partners7

Payment Method Domains5

Payment methods3

Payment Rules9

Payments12

Payout accounts1

Payout methods2

Payouts10

People2

Permissions1

Plans6

Products7

Promo Codes6

Reactions4

Refunds2

Resolution Center Cases11

Reviews2

Setup Intents6

Shipments4

Social Accounts7

Stats2

Support channels3

Swaps4

Team Members5

Topups1

Trades5

Transfers4

Users18

Verifications4

Waitlist Entries7

Webhooks9

Webhooks

Accounts3

Ad Campaigns2

Ads1

Cards13

Course lesson interactions1

Deposits1

Dispute alerts1

Disputes2

Entries4

Exports2

Invoices5

Ledger accounts1

Ledgers1

Members2

Memberships4

Messages1

Payments7

Payout accounts1

Payouts4

Plans3

Products5

Reactions1

Refunds2

Resolution Center Cases3

Setup Intents3

Shipments2

Swaps1

Transfers3

Verifications2

Setup Intents

List Setup Intents

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. client_secret is always null on list rows — retrieve the setup intent for it.

get/setup_intents

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": "succeeded",
      "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

Changed in 13 of the 74 revisions of this API.92829

Sep 25, 202686b97292852d1See the full diff
- ●
  added the new alipayhk enum value to the ////// response property for the response status
  response-property-enum-value-added
Sep 24, 20267fcefabddb0a1See the full diff
- ●
  added the new tabby enum value to the ////// response property for the response status
  response-property-enum-value-added
This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Sep 23, 2026140d015b99667525See the full diff
- ▲
  for the query request parameter first, default value 20 was added
  request-parameter-default-value-added
- ▲
  the // response's property format changed from date-time to no format for status
  response-property-type-changed
- ▲
  removed the required property // from the response with the status
  response-required-property-removed
- ▲
  removed the required property // from the response with the status
  response-required-property-removed
- ▲
  removed the required property // from the response with the status
  response-required-property-removed
- ▲
  removed the required property // from the response with the status
  response-required-property-removed
- ▲
  removed the required property // from the response with the status
  response-required-property-removed
- ●
  for the query request parameter first, the max was set to 100.00
  request-parameter-max-set
- ●
  for the query request parameter last, the max was set to 100.00
  request-parameter-max-set
- ●
  removed the optional property / from the response with the status
  response-optional-property-removed
- ●
  removed the optional property / from the response with the status
  response-optional-property-removed
- ●
  removed the optional property / from the response with the status
  response-optional-property-removed
- ○
  api operation id listSetupIntent removed and replaced with listSetupIntents
  api-operation-id-removed
- ○
  the security scope member:basic:read was removed from the endpoint's security scheme bearerAuth
  api-security-scope-removed
- ○
  the security scope member:email:read was removed from the endpoint's security scheme bearerAuth
  api-security-scope-removed
- ○
  api tag Setup Intents added
  api-tag-added
- ○
  api tag Setup intents removed
  api-tag-removed
- ○
  added the new optional header request parameter Api-Version-Date to all path's operations
  new-optional-request-default-parameter-to-existing-path
- ○
  added the new optional query request parameter order
  new-optional-request-parameter
- ○
  added the new optional query request parameter status
  new-optional-request-parameter
- ○
  the query request parameter account_id became optional
  request-parameter-became-optional
- ○
  removed the non-success response with the status
  response-non-success-status-removed
- ○
  removed the non-success response with the status
  response-non-success-status-removed
- ○
  removed the non-success response with the status
  response-non-success-status-removed
- ○
  removed the non-success response with the status
  response-non-success-status-removed
- ○
  added the required property // to the response with the status
  response-required-property-added
- ○
  added the required property // to the response with the status
  response-required-property-added
- ○
  added the required property // to the response with the status
  response-required-property-added
- ○
  added the required property // to the response with the status
  response-required-property-added
- ○
  added the required property // to the response with the status
  response-required-property-added
- ○
  added the required property // to the response with the status
  response-required-property-added
- ○
  added the required property // to the response with the status
  response-required-property-added
- ○
  added the required property // to the response with the status
  response-required-property-added
- ○
  added the required property // to the response with the status
  response-required-property-added
- ○
  added the required property // to the response with the status
  response-required-property-added
- ○
  added the required property // to the response with the status
  response-required-property-added
- ○
  added the required property // to the response with the status
  response-required-property-added
Sep 15, 2026c19acf2e254811See the full diff
- ●
  added the new touch_n_go enum value to the /// response property for the response status
  response-property-enum-value-added
- ○
  removed the bizum enum value from the /// response property for the response status
  response-property-enum-value-removed
This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Sep 5, 20262fa9dfe9535a5See the full diff
- ●
  added the new mercado_pago_ar enum value to the /// response property for the response status
  response-property-enum-value-added
- ●
  added the new mercado_pago_mx enum value to the /// response property for the response status
  response-property-enum-value-added
- ●
  added the new nupay enum value to the /// response property for the response status
  response-property-enum-value-added
- ●
  added the new opay enum value to the /// response property for the response status
  response-property-enum-value-added
- ●
  added the new verve enum value to the /// response property for the response status
  response-property-enum-value-added
Sep 4, 20268473fa1d1f473See the full diff
- ●
  added the new oney enum value to the /// response property for the response status
  response-property-enum-value-added
- ●
  added the new oney_3x enum value to the /// response property for the response status
  response-property-enum-value-added
- ●
  added the new oney_4x enum value to the /// response property for the response status
  response-property-enum-value-added
Sep 3, 2026697924df40d111See the full diff
- ▲
  added the new required query request parameter account_id
  new-required-request-parameter
- ●
  deleted the query request parameter company_id
  request-parameter-removed
This revision also has 9 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Aug 28, 20264da7133b2de72See the full diff
- ●
  added the new flex_pay enum value to the /// response property for the response status
  response-property-enum-value-added
- ●
  added the new gcash enum value to the /// response property for the response status
  response-property-enum-value-added
This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Aug 26, 202686d0a97abfe55See the full diff
- ●
  added the new accel enum value to the //////// response property for the response status
  response-property-enum-value-added
- ●
  added the new culiance enum value to the //////// response property for the response status
  response-property-enum-value-added
- ●
  added the new nyce enum value to the //////// response property for the response status
  response-property-enum-value-added
- ●
  added the new pulse enum value to the //////// response property for the response status
  response-property-enum-value-added
- ●
  added the new star enum value to the //////// response property for the response status
  response-property-enum-value-added
This revision also has 42 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Aug 21, 2026715c4defcbbf1See the full diff
- ●
  added the new addi enum value to the /// response property for the response status
  response-property-enum-value-added

Of the 74 revisions, 1 has no diff computed.

Full history (13 revisions)