GET
/
v1
/
installments
/
search

Authorizations

Authorization
string
headerrequired

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

Query Parameters

query
string
required

Uma string de busca que permite criar filtros personalizados. Filtros permitidos amountRemaining, loan.customer.document, loan.customer.name, dueDate. Para os campos que são string o único comparador válido é :. É possível utilizar os operadores AND e OR para concatenar mais de uma query, O operador lógico AND tem prioridade de agrupamento em relação ao OR. É possível utilizar os caracteres () para definir prioridade de agrupamentos.

starting_after
string

Um cursor para uso na paginação. starting_after é um ID de objeto que define seu lugar na lista. Por exemplo, se você fizer uma solicitação de lista e receber 100 objetos, terminando com obj_foo, sua chamada subsequente poderá incluir starting_after=obj_foo para buscar a próxima página da lista.

ending_before
string

Um cursor para uso na paginação. starting_after é um ID de objeto que define seu lugar na lista. Por exemplo, se você fizer uma solicitação de lista e receber 100 objetos, terminando com obj_foo, sua chamada subsequente poderá incluir starting_after=obj_foo para buscar a próxima página da lista.

limit
integer
default: 10

Um limite no número de objetos a serem retornados. O limite pode variar entre 1 e 100, e o padrão é 10.

Response

200 - application/json
hasMore
boolean

Informa se existem mais itens. Os próximos itens podem ser obtidos informando o ID do último item no startingAfter.

data
object[]

Uma lista de parcelas