support
Back to documentation
Search
Categories
Tags
main parametersexpand all
uuid
required
general transaction options
amount
currency
comment
card related options
transactionOptions
cardOptions
manualValidation
captureDelay
mid
Try me
Documentation

Web service Transaction/Refund

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

The REST Web Service Transaction/Refund allows you to refund a transaction (total or partial if the acquirer supports it).

  • Status required:
    • CAPTURED(Présented)

Repayment is made in 2 successive stages.

  1. The refund isIn progresstreatment.
    Transaction statusPENDING.
  2. The refund is validated.
    Transaction statusAUTHORISED.
  • To be notified of a change in status (fromPENDINGtoAUTHORISED), create a custom rule in the "bom_expert" :Creates a Refund notification.

You can find out the status of a transaction using the Web Service, Transaction/Get , (parameter detailedStatus,).

  • Partial refund :

    • Use the Transaction/Refund Web Service and transmit an amount less than the transaction amount.
    • You can partially refund a transaction several times, until it is fully refunded.

  • Full refund:

    • Use the Transaction/Refund Web Service and transmit an amount equal to the transaction amount.

Input parameters

uuid

Unique transaction ID generated by the payment gateway.

Format

amount

Payment amount in its smallest currency unit (cent for euro).

Example: 30050 for EUR 300.50.

Format

currency

Payment currency. Alphabetic code in uppercase according to alpha-3 (ISO 4217).

Eg: "EUR" for the euro.

Format

Possible values

. The possible values are:

Currency ISO 4217 ENCODING Fractional unit
Australian dollar (036) AUD 2
Canadian dollar (124) CAD 2
Swiss franc (756) CHF 2
Danish crown (208) DKK 2
Euro (978) EUR 2
Pound Sterling (826) GBP 2
Japanese yen (392) JPY 0
Norwegian crown (578) NOK 2
Swedish krona (752) SEK 2
US dollar (840) USD 2

comment

Public comment.

Format

manualValidation

Path: transactionOptions.cardOptions.manualValidation

Transaction validation mode.

Format

Possible values

. The possible values are:

value Description
NO Automatic validation by the payment gateway.
YES Manual validation by the Merchant.
null Default configuration of the selected shop (configurable in the Merchant Back Office).

captureDelay

Path: transactionOptions.cardOptions.captureDelay

Delay to be applied to the capture date.

Description

Indicates the delay (in days) before the capture.

If this parameter is not passed, then the default value set in the Merchant Back Office will be used.

It can be set in the Merchant Back Office by all authorized persons.

If the capture delay is higher than 365 days in the payment request, it will be automatically reset to 365 days.

Format

mid

MID number used for refunding a proximity transaction. If this field is filled in, make sure you use the correct VADS contract based on the card network.

Format

Response reference

The web service returns the following object:

Response Context
Transaction Object containing transaction details.

See response reference for more information.