Sign in

v6

latestOpenAPI 3.1.02026-07-311856741.1 MB
refunds
public

List Refunds

List refunds.

Scopes: refunds:read refunds:write

get/v1/refunds/

Query parameters

string uuid4

The refund ID.

OR
string[]

Filter by refund ID.

string uuid4

The organization ID.

OR
string[]
Example:1dbfc517-0bbf-4301-9ba8-555ca42b9737

Filter by organization ID.

string uuid4

The order ID.

OR
string[]

Filter by order ID.

string uuid4

The subscription ID.

OR
string[]

Filter by subscription ID.

string uuid4

The customer ID.

OR
string[]

Filter by customer ID.

string

The customer external ID.

OR
string[]

Filter by customer external ID.

succeededboolean nullable

Filter by succeeded.

Filter by succeeded.

pageinteger

Page number, defaults to 1.

Page number, defaults to 1.

limitinteger

Size of a page, defaults to 10. Maximum is 100.

Size of a page, defaults to 10. Maximum is 100.

sortingRefundSortProperty[] nullable

Sorting criterion. Several criteria can be used simultaneously and will be applied in order. Add a minus sign - before the criteria name to sort by descending order.

Sorting criterion. Several criteria can be used simultaneously and will be applied in order. Add a minus sign - before the criteria name to sort by descending order.

Response

Successful Response

Example response

{
  "items": [
    {
      "dispute": {
        "amount": 1000,
        "tax_amount": 200,
        "currency": "usd",
        "reason": "fraudulent",
        "order_id": "57107b74-8400-4d80-a2fc-54c2b4239cb3",
        "payment_id": "42b94870-36b9-4573-96b6-b90b1c99a353"
      }
    }
  ]
}