Skip to main content
GET
List Payments

Authorizations

Authorization
string
header
required

Chave de API gerada no dashboard da PurinCash (ps_live_ ou ps_test_).

Query Parameters

limit
integer
default:50

Quantidade máxima de itens por página (1 a 100). Padrão 50. Valor inválido devolve 400.

Required range: 1 <= x <= 100
offset
integer
default:0

Quantidade de itens a pular (maior ou igual a 0). Padrão 0. Valor inválido devolve 400.

Required range: x >= 0
status
enum<string>

Filtra pelo status do pagamento. Valor desconhecido devolve 400.

Available options:
pending,
paid,
expired,
refunded
type
enum<string>

Filtra pelo tipo do pagamento. Valor desconhecido devolve 400.

Available options:
one_time,
subscription
subaccountId
string

Só pagamentos atribuídos a esta subconta (sacc_...). É o caminho pra reconciliar as vendas de um cliente sem abrir pagamento por pagamento. Malformado devolve 400; bem-formado mas inexistente na sua conta, 404.

Response

Lista paginada de pagamentos.

payments
object[]

Pagamentos encontrados (mais recentes primeiro).

total
integer

Total de pagamentos que atendem ao filtro.

limit
integer

Limite aplicado na consulta.

offset
integer

Offset aplicado na consulta.