Listar pagamentos (integração)

{ "data": [ { "status": "approved", "transaction_id": "019ddb56-fbe3-72e1-9f3c-8d0b2faf8f73", "amount": 15000, "message": "Payment approved", "attempts": 1, "payment_method": "card", "created_at": "2026-04-30T01:23:45+00:00", "updated_at": "2026-04-30T01:23:46+00:00", "transactions": [], "webhooks": [] } ], "meta": { "current_page": 1, "per_page": 15, "total": 142, "last_page": 10 } }

Authorizations

X-Client-ID

string

header

required

Identificador público do cliente (integração servidor-a-servidor). Usado em conjunto com X-API-Key.

X-API-Key

string

header

required

Chave secreta de API (integração servidor-a-servidor). Usada em conjunto com X-Client-ID.

Query Parameters

start_date

string<date>

Data inicial (criação).

Example:

"2026-04-01"

end_date

string<date>

Data final (criação).

Example:

"2026-04-30"

status

enum<string>

Status da transação. Estado persistido da transação.

Available options:

pending,

approved,

failed,

refunded

Example:

"approved"

payment_method

enum<string>

Método de pagamento.

Available options:

pix,

card,

billet

Example:

"card"

gateway

enum<string>

Gateway processador. Slug do gateway processador.

Available options:

pagarme,

safe2pay,

picpay

Example:

"pagarme"

amount_from

integer

Valor mínimo, em centavos.

Example:

1000

amount_to

integer

Valor máximo, em centavos.

Example:

50000

transaction_type

enum<string>

Tipo de transação.

Available options:

payment,

withdraw

Example:

"payment"

per_page

integer

default:15

Itens por página (padrão 15).

Example:

15

page

integer

default:1

Página atual.

Example:

1

Response

200 - application/json

Lista paginada de pagamentos.

data

object[]

required

Show child attributes