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

Objeto customer

Objeto retornado na criação do customer

❗️

Atenção: Essa versão de API será descontinuada

Essa versão da API Pagar.me já não é mais atualizada e, em breve, deixará de funcionar. Para que sua loja possa vender sem problemas, você precisa realizar sua integração usando a versão mais recente da nossa API, a V5.

No canto superior esquerdo da tela é indicado qual versão da documentação você está vendo. Clique na seta onde indica a versão e altere para a V5 para acessar a documentação.

Se você já é cliente, precisa realizar obrigatoriamente a migração para a versão V5.

Em caso de dúvidas, basta entrar em contato com o nosso time de atendimento através do e-mail, enviando a sua dúvida para [email protected] e por telefone, ligando para 4004-1330. Se você já é cliente pode também entrar em contato através do chat dentro da sua Dashboard.

❗️

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

Verifique na sua Dashboard a versão da API que você está usando. Você deve usar a documentação correspondente. Para saber mais, veja: Versionamento.

PropriedadeDescrição
name
String
  • *Obrigatório**. Nome ou razão social do comprador
email
String
  • *Obrigatório**. E-mail do comprador
external_id
String
  • *Obrigatório**. Identificador do cliente na loja
type
String
  • *Obrigatório**. Tipo de documento. Deve ser individual para pessoa física ou corporation para pessoa jurídica
country
String
  • *Obrigatório**. País. Duas letras minúsculas, seguindo o padrão ISO 3166-1 alpha-2
birthday
String
Data de nascimento. Deve seguir o formato AAAA-MM-DD. Por exemplo, para 20/12/1990 birthday seria 1990-12-20
phone_numbers
Array of strings
  • *Obrigatório**. Telefone. Requer ao menos um valor. Deve seguir o padrão E.164
documents
Array of objects
Documento. Contém campos type para tipo de documento e number para número do documento. Para mais informações, clique aqui
📘

Compradores estrangeiros

Ao contrário das versões 2013-03-01 e 2017-07-17 da nossa API, essa versão aceita documentos de compradores estrangeiros e endereços internacionais, e não apenas CPF/CNPJ e CEP. Dessa forma, é possível passar dados com essas características para que o antifraude faça a análise corretamente.