--- updatedAt: 2026-04-06T17:19:55.000Z agentTools: projectIndex: https://docs.pagar.me/v2/llms.txt --- # Retornando Links de Pagamento 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: > > ```shell > 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: > > ```shell > 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: > > ```shell > curl -X GET https://api.pagar.me/1/payment_links \ > -d 'api_key=SUA_API_KEY' > -d 'cursor=TOKEN_RETORNADO_NO_CURSOR_PREVIOUSPAGE' > ``` # OpenAPI definition ```json { "openapi": "3.1.0", "info": { "title": "api-settings", "version": "2" }, "servers": [ { "url": "https://api.pagar.me/1" } ], "components": { "securitySchemes": { "sec0": { "x-default": "", "type": "apiKey", "name": "api_key", "in": "query" } } }, "security": [ { "sec0": [] } ], "paths": { "/payment_links": { "get": { "summary": "Retornando Links de Pagamento", "description": "Retorna um Array contendo objetos de Link de Pagamento, ordenadas a partir do Link mais recente.", "operationId": "retornando-links-de-pagamento", "parameters": [ { "name": "count", "in": "query", "description": "Retorna `n` resultados, com um máximo de 1000", "schema": { "type": "integer", "format": "int32", "default": 10 } }, { "name": "cursor", "in": "query", "description": "Útil para implementação de uma paginação de resultados, permitindo a troca de páginas utilizando `x-cursor-nextpage` ou `x-cursor-previouspage`.", "schema": { "type": "string" } }, { "name": "x-cursor-nextpage", "in": "query", "description": "Retornado nos headers da resposta contém o `Token` que permite acesso a próxima página.", "schema": { "type": "string" } }, { "name": "x-cursor-previouspage", "in": "query", "description": "Retornado nos headers da resposta contém o `Token` que permite acesso a página anterior.", "schema": { "type": "string" } }, { "name": "id", "in": "query", "description": "Filtro pelo Identificador do Link de Pagamento. Ex: pl_cjkcnpnug01w3nx6d7rz1dgit", "schema": { "type": "string" } }, { "name": "short_id", "in": "query", "description": "Filtro pelo Identificador utilizado para acessar o Link de Pagamento via URL", "schema": { "type": "string" } } ], "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Result": { "value": "[ \n { \n \"amount\": 1000, \n \"date_created\": \"2018-08-02T14:29:47.128Z\",\n \"date_updated\": \"2018-08-02T14:31:30.979Z\",\n \"expires_at\": \"2018-08-02T15:29:47.126Z\",\n \"id\": \"pl_cjkcnpnug01w3nx6d7rz1dgit\", \n \"items\": [ \n {\n \"category\": null,\n \"created_at\": \"2018-08-02T14:29:47.149Z\",\n \"date\": null, \n \"external_id\": \"a123\",\n \"id\": \"cjkcnpnv101w5nx6d7bq9rkg3\",\n \"model\": \"payment_link\",\n \"model_id\": \"pl_cjkcnpnug01w3nx6d7rz1dgit\",\n \"quantity\": 1,\n \"tangible\": true,\n \"title\": \"Caderno do Goku\",\n \"transaction_id\": null,\n \"unit_price\": 600, \n \"updated_at\": \"2018-08-02T14:29:47.149Z\",\n \"venue\": null\n }, \n {\n \"category\": null,\n \"created_at\": \"2018-08-02T14:29:47.149Z\",\n \"date\": null, \n \"external_id\": \"1\",\n \"id\": \"cjkcnpnv101w4nx6djl4kz1xw\",\n \"model\": \"payment_link\",\n \"model_id\": \"pl_cjkcnpnug01w3nx6d7rz1dgit\",\n \"quantity\": 1,\n \"tangible\": true,\n \"title\": \"Bola de futebol\",\n \"transaction_id\": null,\n \"unit_price\": 400,\n \"updated_at\": \"2018-08-02T14:29:47.149Z\",\n \"venue\": null\n }\n ],\n \"max_orders\": 1,\n \"object\": \"payment_link\",\n \"payment_config\": {\n \"boleto\": {\n \"enabled\": true,\n \"expires_in\": 20\n },\n \"credit_card\": {\n \"enabled\": true,\n \"free_installments\": 4,\n \"interest_rate\": 25,\n \"max_installments\": 12\n },\n \"default_payment_method\": \"boleto\"\n },\n \"short_id\": \"tBJ7Dr9xSX\",\n \"status\": \"active\",\n \"url\": \"https://link.sandbox.pagar.me/tBJ7Dr9xSX\"\n }\n]" } }, "schema": { "type": "array", "items": { "type": "object", "properties": { "amount": { "type": "integer", "example": 1000, "default": 0 }, "date_created": { "type": "string", "example": "2018-08-02T14:29:47.128Z" }, "date_updated": { "type": "string", "example": "2018-08-02T14:31:30.979Z" }, "expires_at": { "type": "string", "example": "2018-08-02T15:29:47.126Z" }, "id": { "type": "string", "example": "pl_cjkcnpnug01w3nx6d7rz1dgit" }, "items": { "type": "array", "items": { "type": "object", "properties": { "category": {}, "created_at": { "type": "string", "example": "2018-08-02T14:29:47.149Z" }, "date": {}, "external_id": { "type": "string", "example": "a123" }, "id": { "type": "string", "example": "cjkcnpnv101w5nx6d7bq9rkg3" }, "model": { "type": "string", "example": "payment_link" }, "model_id": { "type": "string", "example": "pl_cjkcnpnug01w3nx6d7rz1dgit" }, "quantity": { "type": "integer", "example": 1, "default": 0 }, "tangible": { "type": "boolean", "example": true, "default": true }, "title": { "type": "string", "example": "Caderno do Goku" }, "transaction_id": {}, "unit_price": { "type": "integer", "example": 600, "default": 0 }, "updated_at": { "type": "string", "example": "2018-08-02T14:29:47.149Z" }, "venue": {} } } }, "max_orders": { "type": "integer", "example": 1, "default": 0 }, "object": { "type": "string", "example": "payment_link" }, "payment_config": { "type": "object", "properties": { "boleto": { "type": "object", "properties": { "enabled": { "type": "boolean", "example": true, "default": true }, "expires_in": { "type": "integer", "example": 20, "default": 0 } } }, "credit_card": { "type": "object", "properties": { "enabled": { "type": "boolean", "example": true, "default": true }, "free_installments": { "type": "integer", "example": 4, "default": 0 }, "interest_rate": { "type": "integer", "example": 25, "default": 0 }, "max_installments": { "type": "integer", "example": 12, "default": 0 } } }, "default_payment_method": { "type": "string", "example": "boleto" } } }, "short_id": { "type": "string", "example": "tBJ7Dr9xSX" }, "status": { "type": "string", "example": "active" }, "url": { "type": "string", "example": "https://link.sandbox.pagar.me/tBJ7Dr9xSX" } } } } } } }, "400": { "description": "400", "content": { "application/json": { "examples": { "Result": { "value": "{}" } }, "schema": { "type": "object", "properties": {} } } } } }, "deprecated": false, "x-readme": { "code-samples": [ { "language": "curl", "code": "curl -X GET https://api.pagar.me/1/payment_links -H 'content-type: application/json' -d '{\n \"api_key\": \"SUA_API_KEY\"\n}'", "name": "cURL" }, { "language": "php", "code": "paymentLinks()->getList();" }, { "language": "python", "code": "paymentLinks = pagarme.payment_link.find_all()\n\nprint(paymentLinks)" }, { "language": "javascript", "code": "pagarme.client.connect({ api_key: 'SUA_API_KEY' })\n .then(client => client.paymentLinks.all())\n .then(paymentLinks => console.log(paymentLinks))" } ], "samples-languages": [ "curl", "php", "python", "javascript" ] } } } }, "x-readme": { "headers": [], "explorer-enabled": true, "proxy-enabled": true }, "x-readme-fauxas": true } ```