Retornando clientes

📘

Filtros

Todos os filtros mencionados podem ser usados para buscas em ranges usando os prefixos:

Prefixo	Significado
<	menor que
>	maior que
<=	menor ou igual a
>=	maior ou igual a

Por exemplo, para buscar em um range de date_created:

Shell

curl -X GET https://api.pagar.me/1/customers \
-d 'api_key=ak_test_grXijQ4GicOa2BLGZrDRTR5qNQxJW0'
-d 'date_created=>=1483236000000'
-d 'date_created=<=1484689847590'

Para campos que sejam strings, a comparação é lexicográfica, letras maiúsculas sendo 'maiores' que minúsculas.

📘

Exemplo de paginação utilizando cursor

A primeira requisição da paginação não contém o parâmetro cursor visto que ainda nenhum token foi retornado. Segue abaixo o exemplo da primeira requisição:

Shell

curl -X GET https://api.pagar.me/1/customers \
-d 'api_key=SUA_API_KEY'

No retorno da requisição anterior, será retornado nos headers da resposta os parâmetros x-cursor-previouspagr e x-cursor-nextpage, onde o primeiro será vazio (porque não existe uma pagina anterior no momento) e o segundo conterá o Token de acesso a próxima página.

Dito isto, para acessar a próxima página da listagem, devemos informar dentro do campo cursor o Token retornado no parâmetro x-cursor-nextpage da resposta, como mostra a requisição abaixo:

Shell

curl -X GET https://api.pagar.me/1/customers \
-d 'api_key=SUA_API_KEY'
-d 'cursor=TOKEN_RETORNADO_NO_CURSOR_NEXTPAGE'

Para ir avançando para as próximas páginas da listagem, basta ir substituindo o Token passado no parâmetro cursor pelo Token retornado em casa resposta da requisição.

Para consultar a página anterior de uma listagem seguimos a mesma estrutura, onde o que muda é apenas o Token informado no parâmetro cursor, como mostra o exemplo abaixo:

Shell

curl -X GET https://api.pagar.me/1/customers \
-d 'api_key=SUA_API_KEY'
-d 'cursor=TOKEN_RETORNADO_NO_CURSOR_PREVIOUSPAGE'

🚧

Filtros de datas

É importante notar que a filtragem por data utiliza unixTimeStamp para representá-la. Para gerar o unixTimeStamp de uma data, é possível utilizar o console do Google Chrome e utilizar o seguinte código em Javascript : new Date("2017-12-25T02:00:00.000Z").getTime() que retornará 1514167200000