Skip to main content
GET
List Refunds

Autorizaciones

Authorization
string
header
requerido

An Account API key, an App API key, an account access token, an account-scoped user token, or a user OAuth token. Prepend the key or token with Bearer, for example Bearer ***************************. See Auth & API keys for how to get each one.

Scopes

payment:basic:read

Encabezados

Api-Version-Date
string

Pins the request to a dated API version.

Ejemplo:

"2026-11-17"

Parámetros de consulta

account_id
string

Only refunds issued by this account, prefixed biz_.

payment_id
string

Only refunds of this payment, prefixed pay_.

user_id
string

Only refunds to this buyer, prefixed user_.

created_before
string<date-time>

Only refunds requested before this ISO 8601 timestamp.

created_after
string<date-time>

Only refunds requested after this ISO 8601 timestamp.

order
enum<string>

The field to sort by.

Opciones disponibles:
created_at
direction
enum<string>

The sort direction.

Opciones disponibles:
asc,
desc
first
integer
predeterminado:20

Number of results to return from the start of the range.

Rango requerido: x <= 100
after
string

Return results after this cursor. Use page_info.end_cursor from the previous response to fetch the next page.

last
integer

Number of results to return from the end of the range.

Rango requerido: x <= 100
before
string

Return results before this cursor. Use page_info.start_cursor from the previous response to fetch the previous page.

Respuesta

refunds listed

data
object[]
requerido
page_info
object
requerido