Retorna um Array contendo objetos de Link de Pagamento, ordenadas a partir do Link mais recente.
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:
curl -X GET https://api.pagar.me/1/payment_links \ -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:
curl -X GET https://api.pagar.me/1/payment_links \ -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:
Rate Limit
Essa rota possui um limite de requisições.
Caso você ultrapasse esse valor será retornado o erro “StatusCode 429” por nossa API.Para saber qual o limite dessa e demais rotas acesse : Rate Limit