Skip to main content
GET
Retorna lista de pagamentos agrupados por pedido
🚀 API v2 (Recomendada) - Use este endpoint para novos projetos

Authorizations

Authorization
string
header
required

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

Path Parameters

pageNumber
integer
required

Determina o número da página a ser retornada.

pageLimit
integer
required

Limita a quantidade de registros retornados por página.

Query Parameters

orderId
string

ID do pedido

orderCode
string

Código do pedido

status
string

Status geral do pagamento

createdBefore
string

A pesquisa retorna registros criados até esta data passada no parâmetro. Formato (AAAA-MM-DD).

createdAfter
string

A pesquisa retorna registros criados a partir desta data passada no parâmetro. Formato (AAAA-MM-DD).

updatedBefore
string

A pesquisa retorna registros atualizados até esta data passada no parâmetro. Formato (AAAA-MM-DD).

updatedAfter
string

A pesquisa retorna registros atualizados a partir desta data passada no parâmetro. Formato (AAAA-MM-DD).

Response

OK

items
object[]
meta
object