# List all SetupAttempts ## OpenAPI Specification ```yaml openapi: 3.0.1 info: title: '' description: '' version: 1.0.0 paths: /v1/setup_attempts/list: get: summary: List all SetupAttempts deprecated: false description: '' tags: - API Reference/Setup Intents parameters: - name: Accept in: header description: '' required: true example: application/json schema: type: string - name: Content-Type in: header description: '' required: true example: application/json schema: type: string requestBody: content: application/json: schema: type: object properties: setup_intent: type: string description: >- Only return SetupAttempts created by the SetupIntent specified by this ID. created: type: object properties: gt: type: string description: >- Return results where the created field is greater than this value. gte: type: string description: >- Return results where the created field is greater than or equal to this value. lt: type: string description: >- Return results where the created field is less than this value. lte: type: string description: >- Return results where the created field is less than or equal to this value. description: >- A filter on the list based on the object created field. The value can be a string with an integer Unix timestamp, or it can be a dictionary with the following options: x-apifox-orders: - gt - gte - lt - lte x-apifox-ignore-properties: [] ending_before: type: string description: >- A cursor for use in pagination. ending_before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_bar, your subsequent call can include ending_before=obj_bar in order to fetch the previous page of the list. limit: type: integer description: >- A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. starting_after: type: string description: >- A cursor for use in pagination. starting_after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include starting_after=obj_foo in order to fetch the next page of the list. x-apifox-orders: - setup_intent - 01GKRXBZH5P00SE0MR66F0C84F required: - setup_intent x-apifox-refs: 01GKRXBZH5P00SE0MR66F0C84F: $ref: '#/components/schemas/List%20Request' x-apifox-ignore-properties: - created - ending_before - limit - starting_after responses: '200': description: '' content: application/json: schema: type: object x-apifox-refs: 01HD18AZQACV3QG391Y0BWAT5G: $ref: '#/components/schemas/List' x-apifox-overrides: data: &ref_0 type: array items: type: object x-apifox-refs: 01HD18C3HA5A81R0ARS1NHMT7P: $ref: '#/components/schemas/Setup%20Attempt' x-apifox-overrides: flow_directions: null on_behalf_of: null application: null x-apifox-orders: - 01HD18C3HA5A81R0ARS1NHMT7P properties: id: type: string description: >- Unique identifier for the object, like "setatt_xxx". object: type: string description: '"setup_attempt"' created: type: integer description: >- Time at which the object was created. Measured in seconds since the Unix epoch. customer: type: string description: >- [EXPANDABLE] The value of customer on the SetupIntent at the time of this confirmation. livemode: type: boolean description: >- Has the value true if the object exists in live mode or the value false if the object exists in test mode. payment_method: type: string description: >- [EXPANDABLE] ID of the payment method used with this SetupAttempt. payment_method_details: type: object properties: type: type: string x-apifox-orders: - type description: >- Details about the payment method at the time of SetupIntent confirmation. x-apifox-ignore-properties: [] setup_error: type: object x-apifox-refs: 01GKR6TQDX75DFMHG709SNJC55: &ref_1 $ref: '#/components/schemas/Last%20Payment%20Error' x-apifox-overrides: charge: null x-apifox-orders: - 01GKR6TQDX75DFMHG709SNJC55 properties: code: type: string description: >- For some errors that could be handled programmatically, a short string indicating the error code reported. message: type: string description: >- A human-readable message providing more details about the error. For card errors, these messages can be shown to your users. payment_method: type: object properties: {} description: >- The PaymentMethod object for errors returned on a request involving a PaymentMethod. x-apifox-orders: [] x-apifox-ignore-properties: [] type: type: string description: >- The type of error returned. One of api_error, card_error, idempotency_error, or invalid_request_error. decline_code: type: string description: >- For card errors resulting from a card issuer decline, a short string indicating the card issuer’s reason for the decline if they provide one. param: type: string description: >- If the error is parameter-specific, the parameter related to the error. For example, you can use this to display a message near the correct form field. description: >- The error encountered during this attempt to confirm the SetupIntent, if any. x-apifox-ignore-properties: - code - message - payment_method - type - decline_code - param setup_intent: type: string description: >- [EXPANDABLE] ID of the SetupIntent that this attempt belongs to. status: type: string description: >- Status of this SetupAttempt, one of requires_confirmation, requires_action, processing, succeeded, failed, or abandoned. usage: type: string description: >- The value of usage on the SetupIntent at the time of this confirmation, one of off_session or on_session. x-apifox-ignore-properties: - id - object - created - customer - livemode - payment_method - payment_method_details - setup_error - setup_intent - status - usage required: [] x-apifox-orders: - 01HD18AZQACV3QG391Y0BWAT5G properties: object: type: string default: '"list"' url: type: string has_more: type: boolean data: *ref_0 x-apifox-ignore-properties: - object - url - has_more - data headers: {} x-apifox-name: OK security: - basic: [] x-apifox-folder: API Reference/Setup Intents x-apifox-status: released x-run-in-apifox: https://app.apifox.com/web/project/1296482/apis/api-53881327-run components: schemas: List Request: type: object properties: created: type: object properties: gt: type: string description: >- Return results where the created field is greater than this value. gte: type: string description: >- Return results where the created field is greater than or equal to this value. lt: type: string description: Return results where the created field is less than this value. lte: type: string description: >- Return results where the created field is less than or equal to this value. description: >- A filter on the list based on the object created field. The value can be a string with an integer Unix timestamp, or it can be a dictionary with the following options: x-apifox-orders: - gt - gte - lt - lte x-apifox-ignore-properties: [] ending_before: type: string description: >- A cursor for use in pagination. ending_before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_bar, your subsequent call can include ending_before=obj_bar in order to fetch the previous page of the list. limit: type: integer description: >- A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. starting_after: type: string description: >- A cursor for use in pagination. starting_after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include starting_after=obj_foo in order to fetch the next page of the list. x-apifox-orders: - created - ending_before - limit - starting_after x-apifox-ignore-properties: [] x-apifox-folder: '' List: type: object properties: object: type: string default: '"list"' url: type: string has_more: type: boolean data: type: array items: type: object properties: id: type: string object: type: string api_version: type: 'null' application: type: 'null' created: type: integer description: type: string enabled_events: type: array items: type: string livemode: type: boolean metadata: type: object properties: {} x-apifox-orders: [] x-apifox-ignore-properties: [] status: type: string url: type: string x-apifox-orders: - id - object - api_version - application - created - description - enabled_events - livemode - metadata - status - url x-apifox-ignore-properties: [] x-apifox-orders: - object - url - has_more - data x-apifox-ignore-properties: [] x-apifox-folder: '' Last Payment Error: type: object properties: code: &ref_2 type: string description: >- For some errors that could be handled programmatically, a short string indicating the error code reported. message: &ref_3 type: string description: >- A human-readable message providing more details about the error. For card errors, these messages can be shown to your users. payment_method: type: object properties: {} description: >- The PaymentMethod object for errors returned on a request involving a PaymentMethod. x-apifox-orders: &ref_4 [] x-apifox-ignore-properties: [] type: &ref_5 type: string description: >- The type of error returned. One of api_error, card_error, idempotency_error, or invalid_request_error. decline_code: &ref_6 type: string description: >- For card errors resulting from a card issuer decline, a short string indicating the card issuer’s reason for the decline if they provide one. param: &ref_7 type: string description: >- If the error is parameter-specific, the parameter related to the error. For example, you can use this to display a message near the correct form field. charge: type: string description: （未实现P7）For card errors, the ID of the failed charge. x-apifox-orders: - code - message - payment_method - type - decline_code - param - charge x-apifox-ignore-properties: [] x-apifox-folder: '' Setup Attempt: type: object properties: id: type: string description: Unique identifier for the object, like "setatt_xxx". object: type: string description: '"setup_attempt"' created: type: integer description: >- Time at which the object was created. Measured in seconds since the Unix epoch. customer: type: string description: >- [EXPANDABLE] The value of customer on the SetupIntent at the time of this confirmation. livemode: type: boolean description: >- Has the value true if the object exists in live mode or the value false if the object exists in test mode. payment_method: type: string description: '[EXPANDABLE] ID of the payment method used with this SetupAttempt.' payment_method_details: type: object properties: type: type: string x-apifox-orders: - type description: >- Details about the payment method at the time of SetupIntent confirmation. x-apifox-ignore-properties: [] setup_error: type: object x-apifox-refs: 01GKR6TQDX75DFMHG709SNJC55: *ref_1 x-apifox-orders: - 01GKR6TQDX75DFMHG709SNJC55 properties: code: *ref_2 message: *ref_3 payment_method: type: object properties: {} description: >- The PaymentMethod object for errors returned on a request involving a PaymentMethod. x-apifox-orders: *ref_4 x-apifox-ignore-properties: [] type: *ref_5 decline_code: *ref_6 param: *ref_7 description: >- The error encountered during this attempt to confirm the SetupIntent, if any. x-apifox-ignore-properties: - code - message - payment_method - type - decline_code - param setup_intent: type: string description: '[EXPANDABLE] ID of the SetupIntent that this attempt belongs to.' status: type: string description: >- Status of this SetupAttempt, one of requires_confirmation, requires_action, processing, succeeded, failed, or abandoned. usage: type: string description: >- The value of usage on the SetupIntent at the time of this confirmation, one of off_session or on_session. application: type: string description: （未实现） on_behalf_of: type: string description: >- （未实现）[EXPANDABLE] The value of on_behalf_of on the SetupIntent at the time of this confirmation. flow_directions: type: string description: （未实现） x-apifox-orders: - id - object - created - customer - livemode - payment_method - payment_method_details - setup_error - setup_intent - status - usage - application - on_behalf_of - flow_directions x-apifox-ignore-properties: [] x-apifox-folder: '' securitySchemes: basic: type: http scheme: basic servers: - url: https://apitest.wooshpay.com description: 官网测试 security: - basic: [] ```