3. Clientes

Cliente é o usuário de um serviço ou o comprador de uma loja virtual. Esta API permite a criação e a consulta de um determinado cliente.

Atributos Request (requisição)

Nome

ownId

Id próprio do cliente.

String (65),
obrigatório
Obrigatório para o Venda Protegida

fullname

Nome completo do cliente.

String (90),
obrigatório
Obrigatório para o Venda Protegida

email

Email do cliente.

String (45),
obrigatório
Obrigatório para o Venda Protegida

phone

Telefone do cliente.

Object,
Obrigatório para o Venda Protegida

├─countryCode

DDI (código internacional) do telefone. Valores possíveis: 55.

String (2),
Obrigatório para o Venda Protegida

├─areaCode

DDD (código local) do telefone.

String (2),
Obrigatório para o Venda Protegida

└─number

Número do telefone.

String (16),
Obrigatório para o Venda Protegida

birthDate

Data de nascimento do cliente.

Date (AAAA-MM-DD),

Obrigatório para o Venda Protegida

taxDocument

Documento fiscal.

Object,

Obrigatório para o Venda Protegida

├─type

Tipo do documento. Valores possíveis: CPF, CNPJ.

String,
Obrigatório para o Venda Protegida

└─number

Número do documento.

String (CPF:11 e CNPJ:14),
Obrigatório para o Venda Protegida

shippingAddress

Endereço de entrega do cliente.

Object,
Obrigatório para o Venda Protegida

├─street

Logradouro do endereço.

string(140),
Obrigatório para o Venda Protegida

├─streetNumber

Número.

string(10),
Obrigatório para o Venda Protegida

├─complement

Complemento do endereço.

string(140)

├─district

Bairro.

String,
Obrigatório para o Venda Protegida

├─city

Cidade.

String,
Obrigatório para o Venda Protegida

├─state

Estado.

String (32),
Obrigatório para o Venda Protegida

├─country

País em formato ISO-alpha3. Exemplo BRA.

String (3),
Obrigatório para o Venda Protegida

└─zipCode

O CEP do endereço de cobrança.

String (20),
Obrigatório para o Venda Protegida

fundingInstruments

Instrumentos de cobrança.

Structured list

├─method

Método do instrumento de cobrança. Valores possíveis: CREDIT_CARD.

String

├─creditCard

Cartão de crédito.

Object

├ ├─hash

Dados criptografados do cartão de crédito.

String

├ ├─number

Número do cartão de crédito. (Necessário estar dentro do escopo PCI para enviar esse campo sem criptografia)

String (18)

├ ├─expirationMonth

Mês de expiração do cartão. (Necessário estar dentro do escopo PCI para enviar esse campo sem criptografia)

Integer (2)

├ ├─expirationYear

Ano de expiração do cartão. (Necessário estar dentro do escopo PCI para enviar esse campo sem criptografia)

Integer (4)

├ ├─cvc

Código de segurança do cartão. (Necessário estar dentro do escopo PCI para enviar esse campo sem criptografia)

Integer

├ ├─id

Identificador do cartão de crédito no Moip.

string(16),
response

├ ├─brand

Bandeira do cartão. Valores possíveis: VISA, MASTERCARD, AMEX, DINERS, ELO, HIPER, HIPERCARD.

String,
response

├ ├─first6

Primeiros 6 dígitos do cartão.

Integer,
response

├ ├─last4

Últimos 4 dígitos do cartão.

Integer,
response

├ ├─holder

Portador do cartão.

Structured

├ ├ ├─store

Determina durante a criação de um pagamento se o cartão de crédito utilizado deve ser salvo para oneClickBuy (default: true). Valores possíveis: true ou false.

Boolean

├ ├ ├─fullname

Nome do portador impresso no cartão.

String (65)

├ ├ └─birthDate

Data de nascimento do cliente.

Date (AAAA-MM-DD)

├ ├─phone

Telefone do cliente.

Structured

├ ├ ├─countryCode

DDI (código internacional) do telefone. Valores possíveis: 55.

Integer (2)

├ ├ ├─areaCode

DDD (código local) do telefone.

Integer (2)

├ ├ └─number

Número do telefone.

Integer (16)

├ ├─taxDocument

Documento fiscal.

Structured

├ ├ ├─type

Tipo do documento. Valores possíveis: CPF e CNPJ.

String (4)

├ ├ └─number

Número do documento.

String (CPF:11 e CNPJ:14)

└ └─billingAddress

Endereços de cobrança do cartão de crédito.

Object

     ├─street

Logradouro do endereço.

String

     ├─streetNumber

Número.

String

     ├─complement

Complemento do endereço.

String

     ├─district

Bairro.

String

     ├─city

Cidade.

String

     ├─state

Estado.

String (32)

     ├─country

País em formato ISO-alpha3, exemplo BRA.

String (3)

     └─zipCode

O CEP do endereço de cobrança.

String (20)

❗️

VENDA PROTEGIDA

Os atributos destacados com Venda Protegida são campos obrigatórios para ser elegível no programa.

Atributos Response (resposta/callback)

Nome

creditCard

Cartão de crédito.

Object

├─id

Identificador do cartão de crédito no Moip.

String (16)

├─brand

Bandeira do cartão. Valores possíveis: VISA, MASTERCARD, AMEX, DINERS, ELO, HIPER, HIPERCARD.

String

├─first6

Primeiros 6 dígitos do cartão.

Integer

├─last4

Últimos 4 dígitos do cartão.

integer