Princípios básicos

❗️

Você está na versão correta da documentação?

Verifique na sua Dashboard, em Ver minha conta > Configurações > API Keys, a versão da API que você está usando. Você deve usar a documentação correspondente. Para saber mais, veja: Versionamento.

Bem-vindo ao guia de referências da API do Pagar.me! É através desta API que você integra o seu sistema ao nosso. Além disso, você também pode recriar as funcionalidades existentes na nossa Dashboard, que são feitas consumindo a API que está aqui descrita.

Nossa API é RESTful, e todas suas respostas são em JSON, no endpoint base:

https://api.pagar.me/1/

A seguir, algumas convenções de nossa API:

Paginação

❗️

Cuidado com o limite máximo do count

O parâmetro count possui um limite máximo de 1000, caso seja passado um valor maior que esse a API retornará um erro.

Há muitas rotas de listagem de entidades na API. Em todas elas é necessário lidar com um sistema de paginação para percorrer todas as instâncias. Esse sistema refere-se aos parâmetros count, page e cursor. Count representa quantos resultados por página deverão ser retornados — se não for informado um valor, o padrão é 10, e seu limite é 1000. Page é a página a ser retornada e se não for informado um valor, o padrão é 1. Cursor é o parâmetro que permite percorrer entre as paginas, utilizando o Token retornado em x-cursor-nextpage ou x-cursor-previouspage que por sua vez são retornados nos headers da response.

É importante dizer, que os parâmetros page e cursor são parâmetros quem tem por objetivo a troca de páginas e portanto não devem ser utilizados de forma conjunta.

Autenticação

Sempre que a sua aplicação chama algum de nossos endpoints, você deve passar como forma de autenticação a sua API Key, chave que pode ser encontrada na sua Dashboard.

A API Key pode ser informada da seguinte forma:

• Basic Auth com username igual à chave e senha igual a x (xis minúsculo)