Skip to main content
GET
List payment rules

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.

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 return rules belonging to this account. Defaults to the account the request is acting for.

status
enum<string>

Only return rules with this status.

Opciones disponibles:
active,
inactive,
deleted
action
enum<string>

Only return rules that take this action.

Opciones disponibles:
allow,
block,
review,
enforce_3ds
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

A list of payment rules

data
object[]
requerido
page_info
object
requerido