support
Volver a la documentación
Buscar
Categoria
Tags
parámetros principalesdesplegar todo
uuid
requerido
opciones generales de la transacción
amount
currency
resolutionMode
comment
opciones relacionadas con la tarjeta
transactionOptions
cardOptions
manualValidation
captureDelay
mid
Pruébame
Documentación

Web Service Transaction/CancelOrRefund

L'appel aux Web Services requiert une authentification HTTP Basic Authentication. Plus d'infos : "Phase d'authentification".

POSThttps://api.lyra.com/api-payment/V4/Transaction/CancelOrRefund

El servicio web RESTTransaction/CancelOrRefundpermet de rembourser (total ou partiel si l'acquéreur le supporte) ou d'annuler une transaction.
Más información :Anular / Reembolsar una transacción.

Reembolsar

  • Estado requerido:
    • CAPTURED (Présenté)

El reembolso se efectúa en 2 etapas sucesivas.

  1. El reembolso esEn cursode procesamiento.
    La transacción tiene un estadoPENDING.
  2. El reembolso es válido.
    La transacción tiene un estadoAUTHORISED.
  • Para ser notificado del cambio de estado (dePENDINGAAUTHORISED), cree una regla personalizada en la sección "bom_expert" :Crear una notificación de Reembolso.

Puede conocer el estado de una transacción utilizando el Servicio Web, Transacción/Obtener , (parámetro detailedStatus,).

  • Reembolso parcial :

    • Utilice el servicio web Transacción/Reembolso y transmita un monto menor que el monto de la transacción.
    • Puede reembolsar parcialmente muchas veces una transacción hasta hacer el reembolso total.

  • Reembolso completo:

    • Utilice el servicio web Transacción/Reembolso y transmita un monto igual al monto de la transacción.

Anular

  • Estados requeridos:
    • AUTHORISED_TO_VALIDATE (A valider)
    • WAITING_AUTHORISATION_TO_VALIDATE (A valider et autoriser)
    • WAITING_AUTHORISATION (En attente d'autorisation)
    • AUTHORISED (En attente de remise)

Puede conocer el estado de una transacción utilizando el Servicio Web, Transacción/Obtener , (parámetro detailedStatus,).

  • Anulación parcial : utilice el Web Service Transaction/Update para modificar el monto de la transacción.

  • Cancelación Total : utilice el Servicio Web Transacción/Cancelar para cancelar una transacción.

Parámetros de entrada

uuid

Referencia única de la transacción generada por la plataforma de pago.

Formato

amount

Monto del pago en su fracción monetaria más pequeña (el céntimo para el euro).

Ejemplo: 30050 para 300,50 EUR.

Formato

currency

Moneda del pago. Código alfabético un mayúsculas según ISO 4217 alpha-3.

Ejemplo: "EUR" para el euro.

Formato

Valores posibles

. Los valores posibles son:

Moneda CODIFICACIÓN ISO 4217 Unidad fraccionaria
Dólar australiano (036) AUD 2
Dólar canadiense (124) CAD 2
Franco suizo (756) CHF 2
Corona danesa (208) DKK 2
Euro (978) EUR 2
Libra esterlina (826) GBP 2
Yen (392) JPY 0
Corona noruega (578) NOK 2
Corona sueca (752) SEK 2
Dólar estadounidense (840) USD 2

resolutionMode

Una transacción puede estar autorizada y en espera de depósito bancario, o haber sido depositada. Dependiendo del estado de la entrega, existen varias operaciones posibles:

Si la transacción está pendiente de entrega:

En este caso, es posible anular la transacción. El depósito no se efectuará. El nuevo estado de la transacción será:

status UNPAID
detailedStatus CANCELLED

Si la transacción fue guardada:

En este caso, ya no es posible anular la transacción.

Deberá crear una nueva transacción de reembolso (o "refund" en inglés).

Qué hace exactamente Transaction / CancelOrRefund:

El Web Service REST Transaction/CancelOrRefund elige la operación que se realizará automáticamente.

Pero es posible forzar el tipo de operación gracias al parámetro resolutionMode.

Si el campo se envía vacío, el valor por defecto será AUTO.

Valores posibles

. Los valores posibles son:

VALOR Descripción Anular Reembolsar
AUTO Effectue automatiquement une annulation ou un remboursement
(valeur por defecto).		 Sí "*"
 Sí "*"
CANCELLATION_ONLY Effectue une annulation.

Si la transaction est remisée, une erreur est retournée.		 Sí NO
REFUND_ONLY Effectue un remboursement.

Si la transaction n'est pas remisée, une erreur est retournée.		 NO Sí

"*" en función del estado de la transacción:

  • Transacción en espera de captura: cancelación.
  • Transacción entregada: reembolso.

Para más información sobre el concepto de "presentación", lea el artículo Anular / reembolsar una transacción

Formato

comment

Comentario libre.

Formato

manualValidation

Camino: transactionOptions.cardOptions.manualValidation

Modo de validación de la transacción.

Formato

Valores posibles

. Los valores posibles son:

VALOR Descripción
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

Camino: transactionOptions.cardOptions.captureDelay

Fecha límite para aplicar en la fecha de captura.

Descripción

Indica el número de días antes de la captura.

Si no se transmite este parámetro, se utiliza el valor predeterminado definido en el Back Office Vendedor.

Este último es configurable en el Back Office Vendedor por todas las personas debidamente autorizadas.

Si el tiempo de entrega es mayor a 365 días en la solicitud de pago, se reposiciona automáticamente a 365 días.

Formato

mid

Número de la afiliación e-commerce en la que se debe realizar el reembolso de una transacción de proximidad. Si este campo es completado, asegúrese de utilizar el contrato VADS correcto en función de la red de la tarjeta.

Formato

Referencia de la respuesta

El Web Service devuelve el siguiente objeto:

Respuesta Contexto
Transaction Objeto que contiene la información de la transacción.

Vea la referencia de la respuesta para más información.