---
updatedAt: 2026-04-06T17:19:57.000Z
agentTools:
  projectIndex: https://docs.pagar.me/v1/llms.txt
---

# Retornando um objeto Order

**Objeto Order**

<Table align={["left","left"]}>
  <thead>
    <tr>
      <th style={{ textAlign: "left" }}>

      </th>

      <th style={{ textAlign: "left" }}>

      </th>
    </tr>
  </thead>

  <tbody>
    <tr>
      <td style={{ textAlign: "left" }}>
        Parâmetro
      </td>

      <td style={{ textAlign: "left" }}>
        Descrição
      </td>
    </tr>

    <tr>
      <td style={{ textAlign: "left" }}>
        amount
      </td>

      <td style={{ textAlign: "left" }}>
        Valor total do link de pagamento
      </td>
    </tr>

    <tr>
      <td style={{ textAlign: "left" }}>
        id
      </td>

      <td style={{ textAlign: "left" }}>
        ID do pedido criado
      </td>
    </tr>

    <tr>
      <td style={{ textAlign: "left" }}>
        company\_id
      </td>

      <td style={{ textAlign: "left" }}>
        ID da company que criou o link
      </td>
    </tr>

    <tr>
      <td style={{ textAlign: "left" }}>
        status
      </td>

      <td style={{ textAlign: "left" }}>
        Status do link de pagamento.\
        `created` para orders criados e abandonados ou transações recusadas\
        `paid` para pedidos criados e pagos
      </td>
    </tr>

    <tr>
      <td style={{ textAlign: "left" }}>
        items
      </td>

      <td style={{ textAlign: "left" }}>
        Itens do pedido. [Referência](https://docs.pagar.me/v3/reference#objeto-items-itens):
      </td>
    </tr>

    <tr>
      <td style={{ textAlign: "left" }}>
        payment\_link\_id
      </td>

      <td style={{ textAlign: "left" }}>
        Id do link de pagamento que originou o pedido
      </td>
    </tr>
  </tbody>
</Table>

> 📘 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/orders \
> -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/orders \
> -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/orders \
> -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": "1"
  },
  "servers": [
    {
      "url": "https://api.pagar.me/1"
    }
  ],
  "components": {
    "securitySchemes": {
      "sec0": {
        "x-default": "",
        "type": "apiKey",
        "name": "api_key",
        "in": "query"
      }
    }
  },
  "security": [
    {
      "sec0": []
    }
  ],
  "paths": {
    "/orders": {
      "get": {
        "summary": "Retornando um objeto Order",
        "description": "",
        "operationId": "retornando-um-objeto-order",
        "parameters": [
          {
            "name": "count",
            "in": "query",
            "description": "Retorna `n` resultados, com um máximo de 1000.",
            "schema": {
              "type": "string"
            }
          },
          {
            "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": "ID do pedido criado",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "payment_link_id",
            "in": "query",
            "description": "ID do link de pagamento que originou o pedido",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "status",
            "in": "query",
            "description": "Status do link de pagamento",
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "200",
            "content": {
              "application/json": {
                "examples": {
                  "Result": {
                    "value": "{\n  object\t\"order\"\n\tid\t\"or_cjvpbovqs0b6lcs6d018cjj40\"\n\tcompany_id\t\"59ca631101bcd3b639357e4b\"\n\tstatus\t\"created\"\n\tamount\t157\n\titems\t\n\t[{\t\n\t\tobject\t\"item\"\n\t\tid\t\"392\"\n\t\ttitle\t\"TUBO ESPONJOSO ELKITO 3/4 CINZA\"\n\t\tunit_price\t157\n\t\tquantity\t1\n\t\tcategory\tnull\n\t\ttangible\ttrue\n\t\tvenue\tnull\n\t\tdate\tnull\n  }]\n\tpayment_link_id\t\"pl_cjvp9thv60auhcy6d1lcigzl3\"\n\tpostback_url\tnull\n}"
                  }
                }
              }
            }
          },
          "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/orders/ -H 'content-type: application/json' -d '{\n    \"api_key\": \"SUA_API_KEY\"\n}'"
            },
            {
              "language": "javascript",
              "code": "pagarme.client.connect({ api_key: 'SUA_API_KEY' })\n  .then(client => client.orders.all())\n  .then(orders => console.log(orders))"
            }
          ],
          "samples-languages": [
            "curl",
            "javascript"
          ]
        }
      }
    }
  },
  "x-readme": {
    "headers": [],
    "explorer-enabled": true,
    "proxy-enabled": true
  },
  "x-readme-fauxas": true
}
```