Search PaymentIntents - WooshPay OpenAPI

Returns:
A dictionary with a data property that contains an array of up to limit PaymentIntents. If no objects match the query, the resulting array will be empty.

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 *****************

Query Params

query

string

required

The search query string.

Example:

merchant_order_id:'order1234'

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.

Example:

Header Params

string

required

Default:

application/json

Content-Type

string

required

Default:

application/json

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200OK

application/json

Body

object

string

optional

url

string

optional

has_more

boolean

optional

data

array [object {30}]

optional

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.00 or 100 t oc ha r g e ¥ 100, a zero - d ec ima l c u rre n cy) .. T h e am o u n t v a l u es u pp or t s u pt oe i g h t d i g i t s (e . g ., a v a l u eo f 99999999 f or a U S Dc ha r g eo f

999,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.

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.

Example

{
    "object": "string",
    "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,
            "merchant_user_id": "string",
            "amount_received": 0,
            "capture_method": "string",
            "invoice": "string"
        }
    ]
}