Skip to main content
GET
List refunds for a payment

Authorizations

Authorization
string
header
required

Merchant API key bearer token.

Path Parameters

paymentId
string
required

Payment TypeID (pmt_...) whose refunds to list.

Example:

"pmt_01hxy8m1nqk9g3x3y3p0azq2bg"

Query Parameters

cursor
string

Opaque cursor from a previous page.nextCursor. Treat as an unreadable token.

Example:

"eyJ2IjoxLCJkYXRhIjp7InJlZnVuZGVkQXQiOiIyMDI2LTAzLTAxVDEyOjAwOjAwLjAwMFoiLCJpZCI6InJmdW5kXzAxLi4uIn19"

limit
number

Number of items to return. Maximum 100. If omitted, server default is used.

Example:

25

merchantId
string
required

Merchant TypeID (mer_...) that owns the payment.

Example:

"mer_01hxy8m1nqk9g3x3y3p0azq2bg"

Response

200 - application/json
items
object[]
required
page
object
required