List all SetupAttempts - 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

Accept

string

required

Default:

application/json

Content-Type

string

required

Default:

application/json

Body Params application/json

setup_intent

string

required

Only return SetupAttempts created by the SetupIntent specified by this ID.

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:

gt

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.

lt

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

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

Request samples

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request GET 'https://apitest.wooshpay.com/v1/setup_attempts/list' \
--header 'Accept;' \
--header 'Content-Type: application/json' \
--header 'Authorization: Basic Og==' \
--data-raw '{
    "setup_intent": "string",
    "created": {
        "gt": "string",
        "gte": "string",
        "lt": "string",
        "lte": "string"
    },
    "ending_before": "string",
    "limit": 0,
    "starting_after": "string"
}'

Responses

🟢200OK

application/json

Body

object

string

optional

Default:

"list"

url

string

optional

has_more

boolean

optional

data

array [object {11}]

optional

id

string

optional

Unique identifier for the object, like "setatt_xxx".

object

string

optional

"setup_attempt"

created

integer

optional

Time at which the object was created. Measured in seconds since the Unix epoch.

customer

string

optional

[EXPANDABLE] The value of customer on the SetupIntent at the time of this confirmation.

livemode

boolean

optional

Has the value true if the object exists in live mode or the value false if the object exists in test mode.

payment_method

string

optional

[EXPANDABLE] ID of the payment method used with this SetupAttempt.

payment_method_details

object

optional

Details about the payment method at the time of SetupIntent confirmation.

setup_error

object

optional

The error encountered during this attempt to confirm the SetupIntent, if any.

setup_intent

string

optional

[EXPANDABLE] ID of the SetupIntent that this attempt belongs to.

status

string

optional

Status of this SetupAttempt, one of requires_confirmation, requires_action, processing, succeeded, failed, or abandoned.

usage

string

optional

The value of usage on the SetupIntent at the time of this confirmation, one of off_session or on_session.

Example

{
    "object": "\"list\"",
    "url": "string",
    "has_more": true,
    "data": [
        {
            "id": "string",
            "object": "string",
            "created": 0,
            "customer": "string",
            "livemode": true,
            "payment_method": "string",
            "payment_method_details": {
                "type": "string"
            },
            "setup_error": {
                "code": "string",
                "message": "string",
                "payment_method": {},
                "type": "string",
                "decline_code": "string",
                "param": "string"
            },
            "setup_intent": "string",
            "status": "string",
            "usage": "string"
        }
    ]
}