support
Voltar para documentação
Procurando
Categoria
Tags
parâmetros principaisexpandir todos
uuid
requerido
opções transações gerais
amount
currency
resolutionMode
comment
opções relativas ao cartão
transactionOptions
cardOptions
manualValidation
captureDelay
mid
Testar
Documentação

Web service Transaction/CancelOrRefund

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/CancelOrRefund

O serviço Web RESTTransaction/CancelOrRefundpermite que você reembolse (total ou parcial se o comprador aceitar) ou cancele uma transação.
Mais informações :Cancelar / reembolsar uma transação.

Reembolsar

  • Status obrigatório:
    • CAPTURED (Présenté)

O reembolso tem 2 etapas sucessivas.

  1. O reembolso éEm andamentotratamento.
    Transações tem um statusPENDING.
  2. O reembolso é validado.
    Transações tem um statusAUTHORISED.
  • Para ser notificado sobre a mudança de status (dePENDINGparaAUTHORISED), crie uma regra personalizada na seção “bom_expert" :Criar uma notificação de tipo Reembolso.

Você pode descobrir o status de uma transação usando o Web Service, Transaction/Get , (parâmetro detailedStatus,).

  • Reembolso parcial :

    • Utilize o serviço Web Transação/Reembolso e transmita um valor inferior ao valor da transação.
    • Você pode reembolsar parcialmente uma transação várias vezes, até que o reembolso seja integral.

  • Reembolso total:

    • Utilize o serviço Web Transação/Reembolso e transmita um valor igual ao valor da transação.

Cancelar

  • Status obrigatórios:
    • AUTORIZADO_A_VALIDAR (A ser validado)
    • AGUARDANDO_AUTORIZAÇÃO_PARA_VALIDAR (A ser validado e autorizado)
    • AGUARDANDO_AUTORIZAÇÃO (Autorização pendente)
    • AUTORIZADO (Entrega pendente)

Você pode descobrir o status de uma transação usando o Web Service, Transaction/Get , (parâmetro detailedStatus,).

  • Cancelamento parcial : use o Web Service Transaction/Update para modificar o valor da transação.

  • Cancelamento Total : use o serviço Web Transação/Cancelar para cancelar uma transação.

Configurações de entrada

uuid

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

Formato

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

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

resolutionMode

Uma transação pode ser autorizada e com a captura em andamento no banco, ou capturada no banco. Dependendo do status de captura, diversas operações são possíveis:

Se a transação tiver o status de captura em andamento:

Pode-se neste caso cancelar a transação. A captura no banco não acontecerá. Os novos status da transação serão:

status UNPAID
detailedStatus CANCELLED

Se a transação tiver o status capturada:

Neste caso não é mais possível cancelar a transação.

É preciso criar uma nova transação de reembolso (ou refund em inglês).

O que Transaction/CancelOrRefund faz efetivamente:

o Web Service REST Transaction/CancelOrRefund escolhe a operação que será automaticamente realizada.

Mas pode-se forçar o tipo de operação com o parâmetro resolutionMode.

Se o campo for enviado vazio, o valor por padrão será AUTO.

Valores possíveis

Os valores possíveis são os seguintes:

VALOR Descrição Cancelar Reembolsar
AUTO Effectue automatiquement une annulation ou un remboursement
(valeur Por padrão).		 Sim "*"
 Sim "*"
CANCELLATION_ONLY Effectue une annulation.

Si la transaction est remisée, une erreur est retournée.		 Sim Não
REFUND_ONLY Effectue un remboursement.

Si la transaction n'est pas remisée, une erreur est retournée.		 Não Sim

"*" Verificar o status da transação:

  • Transação com captura em andamento: cancelar.
  • Transação capturada: reembolso.

Para maiores detalhes sobre a noção de captura, consultar o artigo Cancelar / reembolsar uma transação

Formato

comment

Comentário livre.

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 Validation automatique par la plateforme de paiement.
YES Validation manuelle par le marchand.
null Configuration par défaut de la boutique retenue (paramétrable dans le bom).

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

mid

Número de contrato e-commerce EC no qual será realizado o reembolso de uma transação presencial Se este campo é informado, tomar cuidado em utilizar o contrato VADS certo em relação à rede do cartão.

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.