support
Voltar para documentação
Procurando
Categoria
Tags
parâmetros principaisexpandir todos
uuid
requerido
orderId
comment
opções relativas ao cartão
cardUpdate
amount
requerido
currency
requerido
manualValidation
expectedCaptureDate
Testar
Documentação

Web service Transaction/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/Transaction/Update

O Web Service REST Transaction/Update permite modificar algumas características de uma transação já existente:

  • Modificar o valor de uma transação (para baixo).
  • Modificar a data de captura desejada,
  • Modificar o modo de validação (pode-se passar da validação manual para a validação automática. O contrário, porém, é impossível).

As transações que podem estar sujeitas à modificação possuem um dos detailedStatus seguintes:

  • AUTHORISED_TO_VALIDATE (Para validar)
  • WAITING_AUTHORISATION_TO_VALIDATE (Para validar e autorizar)
  • WAITING_AUTHORISATION (Aguardando autorização)
  • AUTHORISED (Captura em andamento)

Para mais informações sobre status, consulte: Ciclo de vida da transação .

Veja os parâmetros de resposta da transação .

Configurações de entrada

uuid

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

Formato

orderId

Referência do pedido definida pelo Estabelecimento Comercial. Não suporta os caracteres UTF-8.

Formato

comment

Comentário livre.

Formato

orderId

Referência do pedido definida pelo Estabelecimento Comercial. Não suporta os caracteres UTF-8.

Formato

cardUpdate.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

cardUpdate.currency

Moeda do pagamento. Código alfabético em maiúsculas de acordo com ISO 4217 alfa-3.

Exemplo: "EUR” para o euro.

Formato

Valores possíveis

Os valores possíveis são os seguintes:

Moeda CODIFICAÇÃO ISO 4217 Unidade fracionária
Dólar australiano (036) AUD 2
Dólar canadense (124) CAD 2
Franco suíço (756) CHF 2
Coroa dinamarquesa (208) DKK 2
Euro (978) EUR 2
Libra Esterlingo (826) GBP 2
Iene japonês (392) JPY 0
Coroa norueguesa (578) NOK 2
Coroa sueca (752) SEK 2
Dólar dos Estados-Unidos (840) USD 2

expectedCaptureDate

Caminho: cardUpdate.expectedCaptureDate

Data da captura no banco apresentada no formato ISO 8601 definido pelo W3C.

Formato

manualValidation

Caminho: cardUpdate.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).

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.