WooshPay OpenAPI
Product DocumentAPI ReferenceJS SDK ReferenceSaaS Platform Integration
Product DocumentAPI ReferenceJS SDK ReferenceSaaS Platform Integration
Back to WooshPay Website
  1. Payment 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
      POST
    • Retrieve a PaymentMethod
      GET
    • Retrieve a Customer's PaymentMethod
      GET
    • Update a PaymentMethod
      POST
    • List PaymentMethods
      GET
    • List a Customer's PaymentMethods
      GET
    • Attach a PaymentMethod to a Customer
      POST
    • Detach a PaymentMethod from a Customer
      POST
  • Refunds
    • Create a refund
      POST
    • Retrieve a refund
      GET
  • Webhooks
    • Create a Webhook
      POST
    • List All Webhooks
      GET
    • Retrieve a Webhook
      GET
    • Delete a Webhook
      DELETE
    • Update a Webhook
      POST
  • 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
      • Retrieve a SetupIntent
      • Cancel a SetupIntent
      • List all SetupIntents
      • List all SetupAttempts
      • Update a SetupIntent
      • Confirm a SetupIntent
    • Create an invoice
    • Retrieve an invoice
    • Finalize an invoice
    • Send an invoice for manual payment
    • Delete a draft invoice
    • Void an invoice
    • List all invoices
    • Pay an invoice
  • 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. Payment Intents

List all PaymentIntents

GET
/v1/payment_intents

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
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
{
    "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/payment_intents' \
--header 'Accept;' \
--header 'Content-Type: application/json' \
--header 'Authorization: Basic Og==' \
--data-raw '{
    "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 {32}] 
optional
id
string 
optional
Unique identifier for the object, like 'pi_xxx'
object
string 
optional
'payment_intent'
created
integer 
optional
Time at which the object was created. Measured in seconds since the Unix epoch.
currency
string 
required
Three-letter ISO currency code, in uppercase. Must be a supported currency.
customer
string 
optional
ID of the Customer
amount
integer 
required
Amount intended to be collected by this PaymentIntent. A positive integer representing how much to charge in the smallest currency unit (e.g., 100 cents to charge 1.00or100tocharge¥100,azero−decimalcurrency)..Theamountvaluesupportsuptoeightdigits(e.g.,avalueof99999999foraUSDchargeof999,999.99).
status
string 
optional
Status of this PaymentIntent, one of requires_payment_method, requires_confirmation, requires_action, processing, requires_capture, canceled, or succeeded
description
string 
optional
An arbitrary string attached to the object. Often useful for displaying to users.
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.
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.
shipping
object (Shipping) 
optional
Shipping information for this PaymentIntent.
merchant_order_id
string 
optional
The order ID created in merchant's order system that corresponds to this PaymentIntent
client_secret
string 
optional
The client secret of this PaymentIntent. Used for client-side retrieval using a publishable key.
last_payment_error
object 
optional
The payment error encountered in the previous PaymentIntent confirmation. It will be cleared if the PaymentIntent is later updated for any reason.
next_action
object (Next Action) 
optional
If present, this property tells you what actions you need to take in order for your customer to fulfill a payment using the provided source.
payment_method_types
array[string]
optional
The list of payment method types (e.g. card) that this PaymentIntent is allowed to use.
Allowed values:
alipayalipay_hkboostcardtruemoneygcashkakaopaytouchngorabbit_line_paydanaklarnaidealgiropaysofortepstrustlybancontactp24unionpayfpxmcashgrabpaybank_transfer_idqrispromptpayovoshopeepayupiboletopaynowpix9paystitchbpi
payment_method_options
object (Payment Method Options) 
optional
Payment-method-specific configuration for this PaymentIntent.
payment_method
string 
optional
ID of the payment method used in this PaymentIntent.
receipt_email
string 
optional
Email address that the receipt for the resulting payment will be sent to.
canceled_at
integer 
optional
Populated when status is canceled, this is the time at which the PaymentIntent was canceled. Measured in seconds since the Unix epoch.
cancellation_reason
string 
optional
Reason for cancellation of this PaymentIntent, either user-provided (duplicate, fraudulent, requested_by_customer, or abandoned) .
confirmation_method
string 
optional
Possible enum values：
automatic (Default)
PaymentIntent can be confirmed using a publishable key. After next_action s are handled, no additional confirmation is required to complete the payment.
manual
All payment attempts must be made using a secret key. The PaymentIntent returns to the requires_confirmation state after handling next_actions, and requires your server to initiate each payment attempt with an explicit confirmation.
3ds_status
object 
optional
The status of 3DS result
amount_capturable
integer 
optional
Amount that can be captured from this PaymentIntent.
return_url
string 
optional
The url that the cutomer will be redirected to.
quantity
integer 
optional
The quantity of the items being purchased.
latest_charge
string 
optional
The latest charge created by this payment intent.
merchant_user_id
string 
optional
The user ID created in merchant's order system that corresponds to this PaymentIntent
amount_received
integer 
optional
Amount that was collected by this PaymentIntent.
capture_method
string 
optional
Possible enum values：automatic（default），manual
invoice
string 
optional
ID of the invoice that created this PaymentIntent, if it exists.
setup_future_usage
enum<string> 
optional
Indicates that you intend to make future payments with this PaymentIntent’s payment method. Providing this parameter will attach the payment method to the PaymentIntent’s Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be attached to a Customer after the transaction completes.
Allowed values:
off_sessionon_session
Example
{
    "object": "\"list\"",
    "url": "string",
    "has_more": true,
    "data": [
        {
            "id": "string",
            "object": "string",
            "created": 0,
            "currency": "string",
            "customer": "string",
            "amount": 0,
            "status": "string",
            "description": "string",
            "metadata": {},
            "livemode": true,
            "shipping": {
                "address": {
                    "city": "string",
                    "country": "string",
                    "line1": "string",
                    "line2": "string",
                    "postal_code": "string",
                    "state": "string"
                },
                "carrier": "string",
                "name": "string",
                "phone": "string",
                "tracking_number": "string"
            },
            "merchant_order_id": "string",
            "client_secret": "string",
            "last_payment_error": {
                "code": "string",
                "message": "string",
                "payment_method": {},
                "type": "string",
                "decline_code": "string"
            },
            "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_types": [
                "alipay"
            ],
            "payment_method_options": {
                "card": {
                    "request_three_d_secure": "any",
                    "setup_future_usage": "on_session",
                    "capture_method": "string",
                    "tax_id": "string"
                },
                "alipayplus": {
                    "terminal_type": "APP",
                    "os_type": "IOS"
                },
                "alipay_hk": {
                    "terminal_type": "APP",
                    "os_type": "IOS"
                },
                "alipay": {
                    "terminal_type": "APP",
                    "os_type": "IOS"
                },
                "wechat_pay": {
                    "terminal_type": "WEB",
                    "client_ip": "string",
                    "os_type": "IOS",
                    "openid": "string"
                },
                "sepa_debit": {},
                "akulaku": {
                    "terminal_type": "WEB",
                    "os_type": "IOS"
                },
                "truemoney": {
                    "terminal_type": "WEB",
                    "os_type": "IOS"
                },
                "kakaopay": {
                    "terminal_type": "WEB",
                    "os_type": "IOS"
                },
                "shopeepay": {
                    "terminal_type": "string",
                    "os_type": "string"
                },
                "dana": {
                    "terminal_type": "string",
                    "os_type": "string"
                },
                "pix": {
                    "tax_id": "string"
                }
            },
            "payment_method": "string",
            "receipt_email": "string",
            "canceled_at": 0,
            "cancellation_reason": "string",
            "confirmation_method": "string",
            "3ds_status": {
                "cavv": "string",
                "eci": 0,
                "status": "string",
                "three_d_result": "string",
                "three_d_enrollment": "string",
                "three_d_secure_version": "string",
                "xid": "string",
                "three_d_secure_server_transaction_id": "string"
            },
            "amount_capturable": 0,
            "return_url": "string",
            "quantity": 0,
            "latest_charge": "string",
            "merchant_user_id": "string",
            "amount_received": 0,
            "capture_method": "string",
            "invoice": "string",
            "setup_future_usage": "off_session"
        }
    ]
}
Previous
Retrieve a PaymentIntent
Next
Search PaymentIntents
Built with