List all SetupIntents - WooshPay OpenAPI

Request

Authorization

Send your HTTP requests with an

Authorization

header that contains the word Basic followed by a space and a base64-encoded string username:password

Example:

Authorization: Basic *****************

Header Params

string

required

Default:

application/json

Content-Type

string

required

Default:

application/json

Body Params application/json

customer

string

optional

Only return SetupIntents for the customer specified by this customer ID.

payment_method

string

optional

Only return SetupIntents associated with the specified payment method.

created

object

optional

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:

string

optional

Return results where the created field is greater than this value.

gte

string

optional

Return results where the created field is greater than or equal to this value.

string

optional

Return results where the created field is less than this value.

lte

string

optional

Return results where the created field is less than or equal to this value.

ending_before

string

optional

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

integer

optional

A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.

starting_after

string

optional

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.

Example

{
  "customer": "string",
  "payment_method": "string",
  "created": {
    "gt": "string",
    "gte": "string",
    "lt": "string",
    "lte": "string"
  },
  "ending_before": "string",
  "limit": 0,
  "starting_after": "string"
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200OK

application/json

Body

object

string

optional

Default:

"list"

url

string

optional

has_more

boolean

optional

data

array [object {20}]

optional

string

optional

[RETRIEVABLE WITH PK] Unique identifier for the object, like ""seti_xxxxx".

object

string

optional

[RETRIEVABLE WITH PK] "setup_intent"

cancellation_reason

string

optional

[RETRIEVABLE WITH PK] Reason for cancellation of this SetupIntent, one of abandoned, requested_by_customer, or duplicate.

client_secret

string

optional

[RETRIEVABLE WITH PK] The client secret of this SetupIntent. Used for client-side retrieval using a publishable key. The client secret can be used to complete payment setup from your frontend. It should not be stored, logged, or exposed to anyone other than the customer. Make sure that you have TLS enabled on any page that includes the client secret.

created

integer

optional

[RETRIEVABLE WITH PK] Time at which the object was created. Measured in seconds since the Unix epoch.

customer

string

optional

[EXPANDABLE] ID of the Customer this SetupIntent belongs to, if one exists. If present, the SetupIntent’s payment method will be attached to the Customer on successful setup. Payment methods attached to other Customers cannot be used with this SetupIntent.

description

string

optional

[RETRIEVABLE WITH PK] An arbitrary string attached to the object. Often useful for displaying to users.

last_setup_error

object

optional

[RETRIEVABLE WITH PK] The error encountered in the previous SetupIntent confirmation.

latest_attempt

string

optional

[EXPANDABLE] The most recent SetupAttempt for this SetupIntent.

livemode

boolean

optional

[RETRIEVABLE WITH PK] Has the value true if the object exists in live mode or the value false if the object exists in test mode.

mandate

string

optional

[EXPANDABLE] ID of the multi use Mandate generated by the SetupIntent.

metadata

object

optional

Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.

next_action

object (Next Action)

optional

[RETRIEVABLE WITH PK] If present, this property tells you what actions you need to take in order for your customer to continue payment setup.

payment_method

string

optional

[EXPANDABLE][RETRIEVABLE WITH PK] ID of the payment method used with this SetupIntent.

payment_method_options

object

optional

Payment-method-specific configuration for this SetupIntent.

payment_method_types

array[string]

optional

The list of payment method types (e.g. card) that this SetupIntent is allowed to set up.

single_use_mandate

string

optional

[EXPANDABLE] ID of the single_use Mandate generated by the SetupIntent.

status

string

optional

[RETRIEVABLE WITH PK] Status of this SetupIntent, one of requires_payment_method, requires_confirmation, requires_action, processing, canceled, or succeeded.

usage

string

optional

[RETRIEVABLE WITH PK] Indicates how the payment method is intended to be used in the future. Use on_session if you intend to only reuse the payment method when the customer is in your checkout flow. Use off_session if your customer may or may not be in your checkout flow. If not provided, this value defaults to off_session.

return_url

string

optional

The url that the cutomer will be redirected to.

Example

{
  "object": "\"list\"",
  "url": "string",
  "has_more": true,
  "data": [
    {
      "id": "string",
      "object": "string",
      "cancellation_reason": "string",
      "client_secret": "string",
      "created": 0,
      "customer": "string",
      "description": "string",
      "last_setup_error": {
        "code": "string",
        "decline_code": "string",
        "message": "string",
        "param": "string",
        "payment_method": {
          "id": "string",
          "object": "string",
          "created": 0,
          "customer": "string",
          "metadata": {},
          "livemode": true,
          "billing_details": {
            "address": {
              "city": "string",
              "country": "string",
              "line1": "string",
              "line2": "string",
              "postal_code": "string",
              "state": "string"
            },
            "email": "string",
            "name": "string",
            "phone": "string"
          },
          "type": "card",
          "card": {
            "brand": "string",
            "checks": {
              "address_line1_check": "string",
              "address_zip_check": "string",
              "cvc_check": "string"
            },
            "country": "string",
            "exp_month": 0,
            "exp_year": 0,
            "fingerprint": "string",
            "funding": "string",
            "last4": "string",
            "metadata": {}
          }
        },
        "payment_method_type": "string",
        "type": "string"
      },
      "latest_attempt": "string",
      "livemode": true,
      "mandate": "string",
      "metadata": {},
      "next_action": {
        "type": "string",
        "redirect_to_url": {
          "return_url": "string",
          "url": "string"
        },
        "ddc_redirect": {
          "return_url": "string",
          "url": "string"
        },
        "challenge_redirect": {
          "return_url": "string",
          "url": "string"
        },
        "alipayplus_handle_redirect": {
          "return_url": "string",
          "schemeUrl": "string",
          "applinkUrl": "string",
          "normalUrl": "string"
        },
        "alipay_handle_redirect": {
          "native_data": "string",
          "native_url": "string",
          "return_url": "string",
          "url": "string"
        },
        "wechat_pay_display_qr_code": {
          "data": "string",
          "data_ur": "string",
          "image_url_png": "string",
          "image_url_svg": "string"
        },
        "wechat_pay_redirect_to_android_app": {
          "native_url": "string"
        },
        "wechat_pay_redirect_to_ios_app": {
          "native_url": "string"
        },
        "wechat_pay_redirect_to_web": {
          "url": "string"
        },
        "wechat_pay_official_account_params": {
          "appId": "string",
          "timeStamp": "string",
          "nonceStr": "string",
          "signType": "string",
          "paySign": "string",
          "package": "string"
        },
        "truemoney_handle_redirect": {
          "url": "string"
        },
        "akulaku_handle_redirect": {
          "url": "string"
        },
        "bank_transfer_id_handle_redirect": {
          "url": "string"
        },
        "promptpay_handle_redirect": {
          "url": "string"
        },
        "dana_handle_redirect": {
          "url": "string"
        },
        "shopeepay_handle_redirect": {
          "url": "string"
        },
        "gcash_handle_redirect": {
          "url": "string"
        },
        "rabbit_line_pay_handle_redirect": {
          "url": "string"
        },
        "alipay_hk_handle_redirect": {
          "url": "string"
        },
        "bpi_handle_redirect": {
          "url": "string"
        }
      },
      "payment_method": "string",
      "payment_method_options": {
        "card": {
          "request_three_d_secure": "string"
        }
      },
      "payment_method_types": [
        "string"
      ],
      "single_use_mandate": "string",
      "status": "string",
      "usage": "string",
      "return_url": "string"
    }
  ]
}