List all refunds

Request

Query Params

paymentIntentId

string

optional

The identifier of the PaymentIntent

Example:

pi_test_20250410060416374547

clientReferenceId

string

optional

A unique string to reference the Refund

refundId

string

optional

Unique identifier for the refund.

Example:

re_test_iXmKUQfNlqgc

createdGt

integer

optional

Only return refunds that were created during the given date interval. Minimum value to filter by (exclusive)

Example:

1744358762580

createdGte

integer

optional

Minimum value to filter by (inclusive)

Example:

1744358762580

createdLt

integer

optional

Maximum value to filter by (exclusive)

Example:

1744358762580

createdLte

integer

optional

Maximum value to filter by (inclusive)

Example:

1744358762580

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:

10

Request samples

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request GET '/v1/refunds?paymentIntentId=pi_test_20250410060416374547&clientReferenceId&refundId=re_test_iXmKUQfNlqgc&createdGt=1744358762580&createdGte=1744358762580&createdLt=1744358762580&createdLte=1744358762580&limit=10'

Responses

🟢200成功

application/json

Body

code

string

required

msg

string

required

data

object

required

hasMore

boolean

required

items

array[object (Refund) {10}]

optional

Example

{
  "code": "success",
  "msg": null,
  "data": {
    "hasMore": true,
    "items": [
      {
        "refundId": "re_test_iXmKUQfNlqgc",
        "paymentIntentId": "pi_test_20250410060416374547",
        "clientReferenceId": "re_01",
        "amount": 9,
        "currency": "USD",
        "reason": "duplicate",
        "status": "succeeded",
        "failureReason": null,
        "closeTime": 1744359414668,
        "created": 1744359413640
      },
      {
        "refundId": "re_test_XNkqyxrISFeN",
        "paymentIntentId": "pi_test_20250410060416374547",
        "clientReferenceId": null,
        "amount": 11,
        "currency": "USD",
        "reason": "duplicate",
        "status": "succeeded",
        "failureReason": null,
        "closeTime": 1744358763246,
        "created": 1744358762580
      }
    ]
  }
}