Pagar.me v5 · Docs Legacy

Pagar.me v5 API (Legado)

5.0.0OAS 3.1

API legada Pagar.me v5 — pedidos, cobranças, clientes, cartões, assinaturas, recebedores, transferências.

API Base URL
  • Server 1:https://api.stone.com.br/core/v5
Security
sec0 (http)

Basic authentication is a simple authentication scheme built into the HTTP protocol.
To use it, send your HTTP requests with an Authorization header that contains the word Basic
followed by a space and a base64-encoded string username:password.

Example: Authorization: Basic ZGVtbzpwQDU1dzByZA==

Additional Information
Contact Suporte Pagar.me

Criar cliente

post
https://api.stone.com.br/core/v5/customers

Body

application/json
namestring

Nome do cliente. Max: 64 caracteres.

emailstring

E-mail do cliente. Max: 64 caracteres

codestring

Código de referência do cliente no sistema da loja. Max: 52 caracteres

documentstring

CPF, CNPJ ou PASSPORT do cliente. Max: 16 caracteres para CPF e CNPJ e Max: 50 caracteres para PASSPORT

document_typestring

Tipo de documento. Valores possíveis: CPF, CNPJ ou PASSPORT.

typestring

Tipo de cliente. Valores possíveis: individual (pessoa física) ou company (pessoa jurídica).
Obrigatório, caso o document seja enviado.

genderstring

Sexo do cliente . Valores possíveis: male ou female

addressobject

Endereço do cliente.

Show Child Parameters
phonesobject

Telefones do cliente. Saiba mais sobre o telefones

Show Child Parameters
birthdatestring(date)

Data de nascimento do cliente.

Default:mm/dd/aaa

metadatastring

Objeto chave/valor utilizado para armazenar informações adicionais sobre o cliente. Saiba mais sobre metadata

Response

application/json

200

idstring

Example:cus_QA5V47r9c0Im3dzN

namestring

Example:Tony Stark

emailstring

Example:tonystarkk@avengers.com

codestring

Example:MY_CUSTOMER_001

documentstring

Example:93095135270

document_typestring

Example:CPF

typestring

Example:individual

genderstring

Example:male

delinquentboolean

Default:true

addressobject
Show Child Parameters
created_atstring

Example:2017-09-22T15:36:46Z

updated_atstring

Example:2018-04-03T17:46:20Z

birthdatestring

Example:1984-05-03T00:00:00Z

phonesobject
Show Child Parameters
metadataobject
Show Child Parameters
post/customers

Body

{ "name": "Tony Stark", "email": "tonystarkk@avengers.com", "code": "MY_CUSTOMER_001", "document": "93095135270", "type": "individual", "document_type": "CPF", "gender": "male", "address": { "line_1": "375, Av. General Justo, Centro", "line_2": "8º andar", "zip_code": "20021130", "city": "Rio de Janeiro", "state": "RJ", "country": "BR" }, "birthdate": "05/03/1984", "phones": { "home_phone": { "country_code": "55", "area_code": "21", "number": "000000000" }, "mobile_phone": { "country_code": "55", "area_code": "21", "number": "000000000" } }, "metadata": { "company": "Avengers" } }
 
application/json

Listar clientes

Este recurso permite a obtenção da carteira de clientes do lojista. Pode ser utilizados alguns parâmetros como filtro da listagem

get
https://api.stone.com.br/core/v5/customers

Query Parameters

namestring

Nome do cliente

documentstring

CPF ou CNPJ do cliente. Max: 16 caracteres

emailstring

E-mail do cliente

genderstring

Sexo do cliente . Valores possíveis: male ou female

pageinteger(int32)

Página atual.

Default:1

sizeinteger(int32)

Quantidade de itens por página.

Default:10

codestring

Código do cliente no sistema do lojista

Default:10

Response

application/json

200

get/customers
 
application/json