Retornando um objeto Order

Log in to see full request history
timestatususer agent
Retrieving recent requests…
LoadingLoading…

Objeto Order

ParâmetroDescrição
amountValor total do link de pagamento
idID do pedido criado
company_idID da company que criou o link
statusStatus do link de pagamento.
created para orders criados e abandonados ou transações recusadas
paid para pedidos criados e pagos
itemsItens do pedido. Referência:
payment_link_idId do link de pagamento que originou o pedido

📘

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/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:

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:

curl -X GET https://api.pagar.me/1/orders \ -d 'api_key=SUA_API_KEY' -d 'cursor=TOKEN_RETORNADO_NO_CURSOR_PREVIOUSPAGE'
Query Params
string
Defaults to 10

Retorna n resultados, com um máximo de 1000.

string

Útil para implementação de uma paginação de resultados, permitindo a troca de páginas utilizando x-cursor-nextpage ou x-cursor-previouspage.

string

Retornado nos headers da resposta contém o Token que permite acesso a próxima página.

string

Retornado nos headers da resposta contém o Token que permite acesso a página anterior.

string

ID do pedido criado

string
string

Status do link de pagamento

Responses

Language
Credentials
Request
Click Try It! to start a request and see the response here! Or choose an example:
application/json