support
Voltar para documentação
Procurando
Categoria
Tags
parâmetros principaisexpandir todos
amount
requerido
uuid
requerido
informação sobre seu cliente
customer
reference
recomendado
email
recomendado
billingDetails
title
category
firstName
lastName
phoneNumber
streetNumber
address
district
zipCode
city
state
country
language
cellPhoneNumber
identityCode
identityType
legalName
shippingDetails
category
firstName
lastName
phoneNumber
streetNumber
address
address2
district
zipCode
city
state
country
deliveryCompanyName
shippingSpeed
shippingMethod
legalName
identityCode
shoppingCart
insuranceAmount
shippingAmount
taxAmount
cartItemInfo
[1]
productLabel
productType
productRef
productQty
productAmount
productVat
ipAddress
opções transações gerais
comment
metadata
[1]
:
opções relativas ao cartão
transactionOptions
cardOptions
manualValidation
captureDelay
merchantInitiatedTransactionType
restrictedInstallments
[1]
installmentOptions
firstAmount
count
period
schedules
[1]
amount
date
Testar
Documentação

Serviço da Web Cobrança/CreateShipmentTransaction

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/Charge/CreateShipmentTransaction

O serviço Web RESTCarregar/CriarTransaçãoDeRemessa permite que você crie uma nova transação de envio a partir da transação inicial.

Veja o guia de integração: Efetuar um pagamento na remessa .

Configurações de entrada

amount

Montante da transação na menor unidade monetária (centavo para o Real). Ex: 1234 para 12,34 BRL.

Exemplo: 30050 para 300,50 EUR.

Formato

uuid

Referência única da transação gerada pela plataforma de pagamento.

Formato

comment

Comentário livre.

Formato

metadata

Valores personalizados vinculados à transação, no formato json.

Exemplo de chamada:

Por exemplo, para passar um valor personalizado, adicione a sua solicitação:

{
    "metadata": {
        "MyValueKey": "1234"
    }
}

Esse valor é retornado no objeto da transação recém-criada.

Pode também usar os metadatas " orderInfo1 ", " orderInfo2 " e " orderInfo3 ”para enviar informações adicionais sobre o pedido.

Estes dados serão depois exibidos na aba Extra do detalhe da transação no seu Back Office EC.

Formato

customer.reference

Código de identificação do comprado para o Estabelecimento Comercial.

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

address

Caminho: customer.shippingDetails.address

Endereço de entrega.

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

Formato

address2

Caminho: customer.shippingDetails.address2

Segunda linha do endereço de entrega.

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

Formato

category

Caminho: customer.shippingDetails.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

city

Caminho: customer.shippingDetails.city

Cidade de entrega.

Formato

country

Caminho: customer.shippingDetails.country

País de entrega (em maiúscula, conforme a 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

deliveryCompanyName

Caminho: customer.shippingDetails.deliveryCompanyName

Nome da empresa que entrega o produto.

Formato

district

Caminho: customer.shippingDetails.district

Bairro do endereço de faturamento.

Formato

firstName

Caminho: customer.shippingDetails.firstName

Nome do destinatário.

Formato

identityCode

Caminho: customer.shippingDetails.identityCode

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

Formato

lastName

Caminho: customer.shippingDetails.lastName

Sobrenome do comprador.

Formato

legalName

Caminho: customer.shippingDetails.legalName

Razão social para uma entrega em uma empresa.

Formato

phoneNumber

Caminho: customer.shippingDetails.phoneNumber

Número de telefone do comprador.

Aceita todos os formatos:

Exemplos:

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

Formato

shippingMethod

Caminho: customer.shippingDetails.shippingMethod

Modo de entrega.

Formato

Valores possíveis

VALOR Descrição
RECLAIM_IN_SHOP Retirada de mercadoria na loja.
RELAY_POINT Utilização de uma rede de pontos de entrega terceirizados (Kiala, Alveol, etc).
RECLAIM_IN_STATION Retirada em um aeroporto, uma agência de viagens ou outros.
PACKAGE_DELIVERY_COMPANY Entrega por transportadora (Colissimo, UPS, etc).
ETICKET Emissão de uma passagem eletrônica, download de produtos virtuais.
CARD_HOLDER_ADDRESS Entrega no endereço do comprador. Reservado para um uso futuro.
VERIFIED_ADDRESS Entrega em um endereço verificado. Reservado para um uso futuro.
NOT_VERIFIED_ADDRESS Entrega em um endereço não verificado. Reservado para um uso futuro.
SHIP_TO_STORE Entrega na loja. Reservado para um uso futuro.
DIGITAL_GOOD Entrega digital. Reservado para um uso futuro.
ETRAVEL_OR_ETICKET Passagem eletrônica. Reservado para um uso futuro.
OTHER Outros Reservado para um uso futuro.
PICKUP_POINT Entrega em ponto de retirada. Reservado para um uso futuro.
AUTOMATED_PICKUP_POINT Entrega em ponto de retirada automático. Reservado para um uso futuro.

shippingSpeed

Caminho: customer.shippingDetails.shippingSpeed

Prazo de entrega.

Formato

Valores possíveis

Exemplos de valores possíveis:

VALOR Descrição
STANDARD Entrega padrão.
EXPRESS Entrega em menos de 24h.
PRIORITY Entrega prioritária (Click & Collect)

state

Caminho: customer.shippingDetails.state

Região do endereço de faturamento.

Formato

streetNumber

Caminho: customer.shippingDetails.streetNumber

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

Carateres aceites:

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

Formato

zipCode

Caminho: customer.shippingDetails.zipCode

CEP do endereço de faturamento.

Formato

insuranceAmount

Caminho: customer.shoppingCart.insuranceAmount

Valor do seguro para a totalidade do pedido expresso na sua menor unidade monetária (o centavo para o Euro).

Exemplo: 30050 para 300,50 EUR.

Formato

shippingAmount

Caminho: customer.shoppingCart.shippingAmount

Montante do frete para o total do pedido, na menor unidade monetária da moeda (o centavo para o Real). Ex: 1234 para 12,34 BRL.

Exemplo: 30050 para 300,50 EUR.

Formato

taxAmount

Caminho: customer.shoppingCart.taxAmount

Valor dos impostos para a totalidade do pedido expresso na sua menor unidade monetária (o centavo para o Euro).

Exemplo: 30050 para 300,50 EUR.

Formato

cartItemInfo

Caminho: customer.shoppingCart.cartItemInfo

cardItemInfo é uma lista de objetos Customer/ShoppingCartItemInfo.

Permite descrever cada artigo do carrinho.

Formato

productAmount

Caminho: customer.shoppingCart.cartItemInfo.productAmount

Valor do produto expresso na sua menor unidade monetária (o centavo para o Euro).

Exemplo: 30050 para 300,50 EUR.

Formato

productLabel

Caminho: customer.shoppingCart.cartItemInfo.productLabel

Nome do produto.

Formato

productQty

Caminho: customer.shoppingCart.cartItemInfo.productQty

Quantidade de produto.

Formato

productRef

Caminho: customer.shoppingCart.cartItemInfo.productRef

Referência produto.

Formato

productType

Caminho: customer.shoppingCart.cartItemInfo.productType

Tipo de produto.

Valores possíveis

VALOR Descrição
FOOD_AND_GROCERY Produtos alimentares e de mercadinho
AUTOMOTIVE Automóvel / Moto
ENTERTAINMENT Lazer / Cultura
HOME_AND_GARDEN Casa e jardim
HOME_APPLIANCE Equipamentos para a casa
AUCTION_AND_GROUP_BUYING Leilões e compras em grupo
FLOWERS_AND_GIFTS Flores e presentes
COMPUTER_AND_SOFTWARE Computadores e softwares
HEALTH_AND_BEAUTY Saúde e beleza
SERVICE_FOR_INDIVIDUAL Serviços para pessoa física
SERVICE_FOR_BUSINESS Serviços para pessoa jurídica
SPORTS Esportes
CLOTHING_AND_ACCESSORIES Roupas e acessórios
TRAVEL Viagem
HOME_AUDIO_PHOTO_VIDEO Som, imagem e vídeo
TELEPHONY Telefonia

Formato

productVat

Caminho: customer.shoppingCart.cartItemInfo.productVat

Tipo de produto.

Valor do imposto sobre o produto (apresentado na menor unidade da moeda).

Valores possíveis

VALOR Descrição
Um número inteiro Valor da transação. O valor dela deve ser um número inteiro positivo (ex: 1234 para 12,34 EUR).
Um número decimal, inferior a 100 Percentagem aplicada sobre o valor. Exemplos: 20.0 ou 19.6532

Para mencionar uma percentagem aplicada sobre o valor do produto em questão, o valor deve ter no máximo 4 dígitos após a virgula. A decimal é obrigatória para mencionar uma percentagem. A decimal é marcada pelo símbolo ".".

Formato

manualValidation

Caminho: transactionOptions.cardOptions.manualValidation

Modo de validação da transação.

Formato

Valores possíveis

Os valores possíveis são os seguintes:

VALOR Descrição
NO Validação automática pela plataforma de pagamento.
YES Validação manual pelo Estabelecimento Comercial.
null Configuração padrão da loja escolhida (pode ser configurado no Back Office EC).

captureDelay

Caminho: transactionOptions.cardOptions.captureDelay

Prazo para aplicar na data de captura.

Descrição

Indica o prazo em número de dias antes da captura no banco.

Se este parâmetro não é enviado, então o valor padrão definido no Back Office EC será usado.

Este último pode ser configurado no Back Office EC por todas as pessoas devidamente autorizadas.

Se o prazo anterior à captura for superior a 365 dias na solicitação de pagamento, ele será automaticamente redefinido a 365 dias.

Formato

Referência da resposta

O web service retorna o objeto seguinte:

Resposta Contexto
Transaction Objeto com os dados da transação.

Consultar a referência da resposta para maiores detalhes.