Skip to main content
GET
Listar cobranças

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

page
integer
default:1

Página (começa em 1).

Required range: x >= 1
perPage
integer
default:500

Itens por página (máx. 500; default 500).

Required range: 1 <= x <= 500
status
enum<string>

Filtra por status do pagamento.

Available options:
PENDING,
PAID,
FAILED,
REFUNDED,
EXPIRED
productId
string

Filtra os pagamentos de um produto.

startDate
string

Início do período (filtra por createdAt). Aceita YYYY-MM-DD (início do dia, UTC) ou ISO 8601 completo.

endDate
string

Fim do período (filtra por createdAt). YYYY-MM-DD é tratado como o FIM do dia (23:59:59.999 UTC), então o dia inteiro entra.

storeId
string

Opcional. Se enviado, precisa ser o id da loja desta chave — não há agregação cross-store; um id diferente retorna 400.

Response

Lista de pagamentos

object
string
Example:

"list"

data
object[]
page
integer
perPage
integer
total
integer

Total de registros que casam com o filtro (ignora a paginação).

totalPages
integer
hasMore
boolean

true se ainda há páginas seguintes.