WooshPay OpenAPI
Product DocumentAPI ReferenceJS SDK ReferenceSaaS Platform Integration
Product DocumentAPI ReferenceJS SDK ReferenceSaaS Platform Integration
Back to WooshPay Website
  1. Setup Intents
  • API Introduction
  • Error Code
  • Payment Intents
    • Create a PaymentIntent
      POST
    • Update a PaymentIntent
      POST
    • Cancel a PaymentIntent
      POST
    • Capture a PaymentIntent
      POST
    • Confirm a PaymentIntent
      POST
    • Retrieve a PaymentIntent
      GET
    • List all PaymentIntents
      GET
    • Search PaymentIntents
      GET
  • Charges
    • Retrieve a charge
      GET
    • List all charges
      GET
  • Payment Methods
    • Create a PaymentMethod
    • Retrieve a PaymentMethod
    • Retrieve a Customer's PaymentMethod
    • Update a PaymentMethod
    • List PaymentMethods
    • List a Customer's PaymentMethods
    • Attach a PaymentMethod to a Customer
    • Detach a PaymentMethod from a Customer
  • Refunds
    • Create a refund
    • Retrieve a refund
  • Webhooks
    • Create a Webhook
    • List All Webhooks
    • Retrieve a Webhook
    • Delete a Webhook
    • Update a Webhook
  • Events
    • Types of events
    • Retrieve an event
  • Files
    • Files
    • Create a file
    • Retrieve a file
  • Disputes
    • Retrieve a dispute
    • Update a dispute
    • Close a dispute
    • List all disputes
  • Payouts
    • Beneficiary
      • Create a beneficiary
      • Retrieve a beneficiary
      • List all beneficiaries
      • Update a beneficiary
      • Delete a beneficiary
    • Payouts
      • Create a payout
      • Retrieve a Payout
      • Update a Payout
      • List All Payouts
  • Balance
    • Get balance
  • Products
    • Create a Product
    • Retrieve a product
    • Update a product
    • List all products
  • Prices
    • Create a price
    • Retrieve a price
    • Update a price
  • Payment Links
    • Create a payment link
    • Update a payment link
    • Retrieve payment link
    • List all payment links
    • Retrieve a payment link's line items
  • Checkout
    • Create a Session
    • Expire a Session
    • Retreive a Session
    • List All Checkout Sessions
    • Retrieve a Checkout Session's line items
  • Customers
    • Create a customer
    • Retrieve a customer
    • Update a customer
  • Invoices
    • Setup Intents
      • Create a SetupIntent
        POST
      • Retrieve a SetupIntent
        GET
      • Cancel a SetupIntent
        POST
      • List all SetupIntents
        GET
      • List all SetupAttempts
        GET
      • Update a SetupIntent
        POST
      • Confirm a SetupIntent
        POST
    • Create an invoice
      POST
    • Retrieve an invoice
      GET
    • Finalize an invoice
      POST
    • Send an invoice for manual payment
      POST
    • Delete a draft invoice
      GET
    • Void an invoice
      POST
    • List all invoices
      GET
    • Pay an invoice
      POST
  • Invoice Items
    • Create an invoice item
    • Retrieve an invoice item
  • Invoice Line Item
    • Bulk add invoice line items
  • Subscriptions
    • Create a subscription
    • Retrieve a subscription
    • Update a subscription
    • Cancel a subscription
    • List subscriptions
  • Subscription Items
    • Create a subscription item
    • Retrieve a subscription item
    • Delete a subscription item
  • Issuing
    • Authorizations
      • Retrieve an authorization
      • List all authorization
    • Cardholders
      • Create a cardholder
      • Update a cardholder
      • Retrieve a cardholder
      • List all cardholders
    • Cards
      • Create a card
      • Update a card
      • Retrieve a card
      • List all cards
      • Retrieve card remaining limits
    • Transactions
      • Update a transaction
      • Retrieve a transaction
      • List all transactions
  • Coupons
    • Create a Coupon
    • Retrieve a coupon
    • Delete a coupon
  • Promotion Code
    • Create a promotion code
    • Update a promotion code
  • Accounts
    • Retrieve account's paymentmethods
  • Fx Quote
    • Create an FX Quote
  1. Setup Intents

List all SetupAttempts

GET
/v1/setup_attempts/list

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
Request Request Example
Shell
JavaScript
Java
Swift
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"
        }
    ]
}
Previous
List all SetupIntents
Next
Update a SetupIntent
Built with