| Campo | Tipo | Obrigatório | Default | Descrição |
|---|---|---|---|---|
| id 🅁 | String (41) | Id do customer no formato CUST_UUID. | ||
| reference_id | String (65) | Código externo informado pelo merchant. | ||
| String (60) | ✔️ | Email do cliente. | ||
| name | String (150) | ✔️ | Nome completo do cliente. | |
| tax_id | String (11/14) | ✔️ | CPF ou CNPJ do cliente. Somente dígitos numéricos. | |
| birth_date | Date | Data de nascimento do cliente. Formato AAAA-MM-DD. | ||
| phones | [Object] | ✔️ | Array de objetos de telefone. | |
| phones[].area | String (2) | ✔️ | Código de área do telefone. | |
| phones[].country | String (2) | ✔️ | Código do país do telefone. Apenas telefones com DDI 55 são aceitos. | |
| phones[].number | String (8/9) | ✔️ | Número de telefone. Somente dígitos numéricos. | |
| phones[].id 🅁 | Int | Id númerico identificador. | ||
| address | Object | Objeto de endereço do customer. | ||
| address.street | String (150) | Nome da rua. | ||
| address.number | String (8) | Número da casa. | ||
| address.complement | String (40) | Complemento do endereço. | ||
| address.locality | String (60) | Bairro. | ||
| address.city | String (60) | Cidade. | ||
| address.region_code | String (2) | Estado (sigla). Exemplo: MG | ||
| address.country | String (3) | País em formato ISO-alpha3. Exemplo: BRA | ||
| address.postal_code | String (8) | CEP do endereço. | ||
| billing_info | [Object] | Array de objetos de informações de pagamento. | ||
| billing_info[].type | String | Tipo do meio de cobrança. Possível valor: CREDIT_CARD. | ||
| billing_info[].card | Object | Objeto de cartão. | ||
| billing_info[].card.number | String (14-19) | Número do cartão. Necessário Certificação PCI. | ||
| billing_info[].card.exp_year | String (1/2) | Ano de expiração do cartão. Necessário Certificação PCI. | ||
| billing_info[].card.exp_month | String (2/4) | Mês de expiração do cartão. Necessário Certificação PCI. | ||
| billing_info[].card.holder | Object | Objeto do portador do cartão. Necessário Certificação PCI. | ||
| billing_info[].card.holder.name | String (30) | Nome do portador, impresso no cartão. Necessário Certificação PCI. | ||
| billing_info[].card.encrypted | String | Cartão criptografado. Substitui todos os outros dados do cartão. | ||
| billing_info[].card.token 🅁 | String (41) | Token do cartão no formato TOKE_UUID. | ||
| billing_info[].card.brand 🅁 | String | Bandeira do Cartão. | ||
| billing_info[].card.first_digits 🅁 | String (6) | 6 primeiros digitos do cartão. | ||
| billing_info[].card.last_digits 🅁 | String (4) | 4 últimos digitos do cartão. | ||
| created_at 🅁 | Date | Data e hora da criação do customer. | ||
| updated_at 🅁 | Date | Data e hora da atualização do customer. | ||
| links.[].rel 🅁 | String | |||
| links.[].href 🅁 | String | |||
| links.[].media 🅁 | String | |||
| links.[].type 🅁 | String |
Atenção aos campos com esse sinal 🅁
São campos somente no response.
Tipos de cartões
É aceito cartões pessoa física e jurídica.
Bandeiras de cartão de crédito:
- VISA
- MASTERCARD
- AMEX
- ELO
- HIPERCARD
- HIPER
- DINERS
Bandeiras de cartão de débito:
- VISA
- MASTERCARD
- ELO
Bandeiras de token de rede:- VISA
- MASTERCARD
- ELO