Skip to main content
GET
cURL

Escopo

Filtros

A resposta vem no envelope de paginação do contrato: count, next, previous e results.
A listagem traz sempre a conta dona do token. Não existe parâmetro de produtor.

Exemplo


Boas práticas

  • Concilie por id, não por valor e data. Dois saques do mesmo valor no mesmo dia são indistinguíveis por qualquer outro critério.
  • Para saber o que ainda vai entrar, use a Agenda de Recebimentos; esta lista é sobre o que já saiu ou foi pedido.

Authorizations

Authorization
string
header
required

Token de autenticação do tipo Bearer {access_token}, onde {access_token} é o token obtido no fluxo de autenticação.

Query Parameters

createdAt__gte
string<date>

Solicitados a partir desta data (YYYY-MM-DD), inclusive.

createdAt__lte
string<date>

Solicitados até esta data (YYYY-MM-DD), inclusive.

limit
integer

Itens por página. Default 10, máximo 1000.

page
integer

Página a retornar. Default 1.

status
enum<string>

Filtra por estado do pedido.

Available options:
approved,
blocked,
pending,
rejected

Response

Saques da conta, do mais recente para o mais antigo.

count
integer
required

Total de saques que atendem ao filtro, em todas as páginas.

next
string | null
required

URL da próxima página, ou null na última.

previous
string | null
required

URL da página anterior, ou null na primeira.

results
object[]
required