Pagar.me v5 · Docs Legacy
Criar cliente
post
https://api.stone.com.br/core/v5/customers
Body
application/json
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
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
Authentication
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
Response
application/json
200
get/customers
Authentication
Query Parameters
application/json
Obter cliente
get
https://api.stone.com.br/core/v5/customers/{customer_id}
Path Parameters
customer_idstringrequired
Código do cliente. Formato cus_XXXXXXXXXXXXXXXX.
Response
application/json
Response
application/json
200
idstring
Example:cus_6l5dMWZ0hkHZ4XnE
namestring
Example:Wonderful Woman
emailstring
Example:wonderfulwoman@avengers.com
genderstring
Example:female
delinquentboolean
Default:true
addressobject
Show Child Parameters
created_atstring
Example:2017-08-22T19:50:44Z
updated_atstring
Example:2017-08-22T19:50:51Z
phonesobject
metadataobject
Show Child Parameters
get/customers/{customer_id}
Authentication
Path Parameters
application/json
Editar cliente
put
https://api.stone.com.br/core/v5/customers/{customer_id}
Path Parameters
customer_idstringrequired
Código do cliente. Formato cus_XXXXXXXXXXXXXXXX.
Body
application/json
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 PASSAPORTE do cliente. Max: 16 caracteres para CPF e CNPJ e Max: 50 caracteres para PASSAPORTE
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. Saiba mais sobre endereços
phoneobject
Telefones do cliente. Saiba mais sobre o telefones
birthdatestring(date)
Data de nascimento do cliente.
metadatastring
Objeto chave/valor utilizado para armazenar informações adicionais sobre o cliente. Saiba mais sobre metadata
Response
application/json
Response
application/json
200
idstring
Example:cus_6l5dMWZ0hkHZ4XnE
namestring
Example:Peter Parker
emailstring
Example:parker@avengers.com
documentstring
Example:26224451990
genderstring
Example:male
typestring
Example:individual
delinquentboolean
Default:true
created_atstring
Example:2017-05-02T23:26:49Z
updated_atstring
Example:2017-05-02T23:28:16Z
phonesobject
Show Child Parameters
metadataobject
Show Child Parameters
put/customers/{customer_id}
Authentication
Path Parameters
Body
{
"name": "Peter Parker",
"email": "parker@avengers.com",
"gender": "male"
}
application/json
Criar cartão
Este recurso cria um card associado ao customer através do customer_id informado.
post
https://api.stone.com.br/core/v5/customers/{customer_id}/cards
Path Parameters
customer_idstringrequired
Código do cliente. Formato: cus_XXXXXXXXXXXXXXXX
Body
application/json
Body
application/json
numberstringrequired
Número do cartão. Entre 13 e 19 caracteres
holder_namestringrequired
Nome do portador como está impresso no cartão. Máximo de 64 caracteres (Caracteres especiais e números não são aceitos)
holder_documentstring
CPF ou CNPJ do portador do cartão. Obrigatório caso o tipo do cartão seja voucher (bandeiras VR ou Pluxee).
exp_monthinteger(int32)required
Mês de validade do cartão. Valor entre 1 e 12 (inclusive)
exp_yearinteger(int32)required
Ano de validade do cartão. Formatos yy ou yyyy. Ex: 23 ou 2023.
cvvstringrequired
Código de segurança do cartão. O campo aceita 4 ou 3 caracteres, variando por bandeira.
brandstring
Bandeira do cartão. Para cartões de crédito, temos como valores possíveis: elo, mastercard, visa, amex, jcb, aura, hipercard, diners, unionpay ou discover.
labelstring
Indica a label do cartão
billing_address_idstring
Código do endereço de cobrança. Max: 36 caracteres.<>Opcional, pode ser utilizado no lugar do billing_address.
billing_addressobject
Endereço de cobrança.
Show Child Parameters
optionsobject
Objeto com opções para a criação do cartão. Um exemplo de opção que pode ser adicionada ao cartão é o verify_card : true, que informa que haverá uma validação do cartão antes da utilização (Zero Dollar Auth).
metadatastring
Objeto chave/valor utilizado para armazenar informações adicionais sobre o cartão. Saiba mais sobre metadata
tokenstring
Pode ser enviado no lugar dos dados do cartão, caso este já tenha sido tokenizado previamente. Saiba mais sobre criação de token de cartão.
Response
application/json
Response
application/json
200
One Ofidstring
Example:card_8ELY0AwVF9HDa3jK
first_six_digitsstring
Example:542501
last_four_digitsstring
Example:7793
brandstring
Example:Mastercard
holder_namestring
Example:Tony Stark
holder_documentstring
Example:93095135270
exp_monthinteger
Default:0
Example:1
exp_yearinteger
Default:0
Example:2030
statusstring
Example:active
labelstring
Example:Sua bandeira
created_atstring
Example:2017-07-07T19:50:33Z
updated_atstring
Example:2017-07-07T19:50:33Z
billing_addressobject
Show Child Parameters
customerobject
Show Child Parameters
typestring
Example:credit
post/customers/{customer_id}/cards
Authentication
Path Parameters
Body
{
"number": "4000000000000010",
"holder_name": "Tony Stark",
"holder_document": "93095135270",
"exp_month": 1,
"exp_year": 30,
"cvv": "351",
"brand": "Mastercard",
"label": "Sua bandeira",
"billing_address": {
"line_1": "375, Av. General Osorio, Centro",
"line_2": "7º Andar",
"zip_code": "220000111",
"city": "Rio de Janeiro",
"state": "RJ",
"country": "BR"
},
"options": {
"verify_card": true
}
}
application/json