support
Voltar para documentação
Procurando
Categoria
Tags
parâmetros principaisexpandir todos
customerReference
requerido
informação sobre seu cliente
customer
email
requerido
billingDetails
title
category
firstName
lastName
phoneNumber
streetNumber
address
district
zipCode
city
state
country
language
cellPhoneNumber
identityCode
identityType
legalName
Testar
Documentação

Web service CustomerWallet/Update

A chamada de serviços Web requer autenticação básica HTTP . Mais informações: " Fase de Autenticação ".

POSThttps://api.lyra.com/api-payment/V4/CustomerWallet/Update

O serviço Web REST CustomerWallet/Update permite que você atualize as informações do comprador em todos os métodos de pagamento associados a uma carteira de comprador.

De acordo com os mandatos de débito direto SEPA, os seguintes dados não serão atualizados:

  • Estado civil (title)
  • Sobrenome (lastName)
  • Nome (firstName)
  • Razão social (legalName)

Configurações de entrada

customerReference

Referência comprador.

Formato

customer.email

Endereço e-mail do comprador.

  • Especificações de estrutura de e-mail: RFC-2822

Formato

address

Caminho: customer.billingDetails.address

Endereço de faturamento.

Advertência: Os símbolos > e < não são autorizados.

Formato

address2

Caminho: customer.billingDetails.address2

Informações complementares sobre o endereço de faturamento.

Advertência: Os símbolos > e < não são autorizados.

Formato

category

Caminho: customer.billingDetails.category

Tipo de cliente.

Formato

Valores possíveis

valores Descrição
PRIVATE Cliente de tipo Pessoa física
COMPANY Cliente de tipo Pessoa Jurídica

cellPhoneNumber

Caminho: customer.billingDetails.cellPhoneNumber

Telefone mobile do comprador.

Aceita todos os formatos:

Exemplos:

  • 0623456789
  • +33623456789
  • 0033623456789
  • (+34) 824 65 43 21
  • 87 77 12 34

Em função do meio de pagamento, algumas restrições podem alterar o formato. Favor consultar a documentação técnica específica do método de pagamento para maiores detalhes.

Formato

city

Caminho: customer.billingDetails.city

Cidade de faturamento.

Formato

country

Caminho: customer.billingDetails.country

País do comprador (em maiúscula, conforme à norma ISO 3166-1 alfa-2).

Formato

Valores possíveis

Exemplos de valores possíveis:

País Código
ÁUSTRIA AT
Brasil BR
CORSEGA FR
COSTA DO MARFIM CI
FRANÇA FR
GUADALUPE GP
ÍNDIA IN
MARTINICA MQ
NOVA-CALEDONIA NC
ST-PIERRE-ET-MIQUELON PM
POLINÉSIA FRANCESA PF

district

Caminho: customer.billingDetails.district

Bairro do endereço de faturamento.

Formato

firstName

Caminho: customer.billingDetails.firstName

Nome do comprador.

Formato

identityCode

Caminho: customer.billingDetails.identityCode

CPF/CNPJ. Possibilita identificar de maneira única cada cidadão dentro de um país.

Formato

identityType

Caminho: customer.billingDetails.identityType

Tipo de documento de identidade.

Formato

language

Caminho: customer.billingDetails.language

Código do idioma do comprador, conforme a norma ISO 639-1.

Permite especificar o idioma de envio dos e-mails de confirmação de pagamento.

Formato

Valores possíveis

Exemplos de valores possíveis:

Idioma Código
Alemão (Alemanha) DE
Inglês (Reino-Unido) EN
Inglês (Estados-Unidos) EN
Chinês (Tradicional) ZH
Espanhol (Espanha) ES
Espanhol (Chile) ES
Francês (França) FR
Italiano (Itália) IT
Japonês (Japão) JP
Holandês (Holanda) NL
Polonês (Polônia) PL
Português (Brasil) PT
Português (Portugal) PT
Russo (Rússia) RU

lastName

Caminho: customer.billingDetails.lastName

Sobrenome do comprador.

Formato

legalName

Caminho: customer.billingDetails.legalName

Razão social.

Formato

phoneNumber

Caminho: customer.billingDetails.phoneNumber

Número de telefone do comprador.

Aceita todos os formatos:

Exemplos:

  • 0123456789
  • +33123456789
  • 0033123456789
  • (00.571) 638.14.00
  • 40 41 42 42

Em função do meio de pagamento, algumas restrições podem alterar o formato. Favor consultar a documentação técnica específica do método de pagamento para maiores detalhes.

Formato

state

Caminho: customer.billingDetails.state

Região (estado) do endereço de faturamento. Recomendado mas não obrigatório passar o valor em ISO-3166-2.

Formato

streetNumber

Caminho: customer.billingDetails.streetNumber

Número de rua do endereço de faturamento.

Carateres aceites:

  • Caracteres alfabéticos (de "A" a "Z" e de "a" a "z")
  • Espaço

Formato

title

Caminho: customer.billingDetails.title

Estado civil do comprador.

Exemplos:

  • Sr.
  • Sr.
  • Sra.

Formato

zipCode

Caminho: customer.billingDetails.zipCode

CEP do endereço de faturamento.

Formato

Referência da resposta

O Web service CustomerWallet/Get retorna o objeto seguinte:

Resposta Contexto
CustomerWallet Objeto que descreve um Token de meio de pagamento.

Consultar a referência da resposta para maiores detalhes.