Skip to main content
GET
/
v1
/
payment_failures
List
curl --request GET \
  --url https://{defaultHost}/v1/payment_failures \
  --header 'Authorization: Bearer <token>'
{
  "object": "list",
  "pagination": {
    "count": 1,
    "limit": 20,
    "page": 1,
    "url": "/v1/payment_failures"
  },
  "data": [
    {
      "id": "d6c431b6-4e1b-4a18-96a6-3e051cdc5843",
      "object": "payment_failure",
      "amount": 2900,
      "currency": "usd",
      "error_message": "Your card was declined.",
      "error_type": "payment_method_error",
      "renewal": true,
      "validation_error_codes": [],
      "checkout": null,
      "customer": "cdac97d4-5b09-4cc9-b49f-b5b4aa729123",
      "payment_intent": null,
      "payment_method": null,
      "created_at": 1771429881,
      "updated_at": 1771429881
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

​
checkout_ids[]
string[]

Only return objects that belong to the given checkouts.

​
customer_ids[]
string[]

Only return objects that belong to the given customers.

​
ids[]
string[]

Only return objects with the given IDs.

​
limit
integer

A limit on the number of items to be returned, between 1 and 100.

​
page
integer

The page of items you want returned.

Response

200 - application/json

Success

​
object
string

A string describing the object type returned.

​
pagination
object
​
data
array

An array of objects.