These docs are for v2. Click to read the latest docs for v5.

Retornando clientes

get

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

Retorna uma lista dos clientes cadastrados

Query Params

count

int32

Defaults to 10

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

cursor

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.

x-cursor-nextpage

string

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

x-cursor-previouspage

string

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

document_number

string

Defaults to !DOCUMENT_NUMBER!

Filtro de CPF/CNPJ

document_type

string

Defaults to cpf

Filtro de tipo do documento utilizado: cnpj ou cpf

name

string

Defaults to !NAME!

Filtro pelo nome do cliente

born_at

date-time

Filtro pela data de nascimento do cliente no formato de timestamp em milisegundos

gender

string

Filtro pelo sexo do cliente. Pode ser M ou F

date_created

date-time

Defaults to !NOW_TIMESTAMP!

Filtro pela data de criação

created_at

string

Alias de date_created

string

Filtro pelo id dos customers

Response

Language

Credentials

Query

Request

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

Transaction IDs

200200