refundTransaction

POST

/rest/transactionWebService/refundTransaction

Maintainer:Martin DA COSTA NETO

Permet de générer une transaction négative, dans le cas d'un retour produit. Le retrait des points se base soit sur le montant de la transaction, soit sur un nombre de points précisés.

La transaction est automatiquement validée.

Le refundTransaction ne permet pas de recréditer les offres qui ont été utilisées sur la transaction originale.

Il est important de prendre connaissance des chapitres concernant le moteur marketing & les montants de transactions.

Request

Authorization

Send your HTTP requests with an

Authorization

header that contains the word Basic followed by a space and a base64-encoded string username:password

Example:

Authorization: Basic *****************

Body Params application/json

Example

{
  "DetailsRequest": {
    "nbItems": "2",
    "nbOfferNumbers": "0",
    "TransactionItemRequest": [
      {
        "allTaxesIncludedUnitPrice": "12.57",
        "discountAmount": "2",
        "ean": "111111",
        "mainReference": "PREMIER_ITEM_DE_TEST",
        "name": "MON ITEM DE TEST",
        "preTaxUnitPrice": "10.76",
        "quantity": "1",
        "storeReference": "12",
        "AccountAdvantageRequest": [
          {
            "type": "1",
            "value": "10"
          }
        ],
        "universReference": "345"
      },
      {
        "allTaxesIncludedUnitPrice": "24.99",
        "discountAmount": "0",
        "ean": "222222",
        "mainReference": "DEUXIEME_ITEM_DE_TEST",
        "name": "UN AUTRE ITEM DE TEST",
        "preTaxUnitPrice": "21.47",
        "quantity": "1"
      }
    ]
  },
  "ReceiptRequest": {
    "allTaxesIncludedAmount": "37.56",
    "cashdeskIpAddress": "127.0.0.1",
    "cashdeskNumber": "2",
    "currency": "1",
    "discountAmount": "2",
    "EntityRequest": {
      "entityIdentifier": "666666"
    },
    "IdentifierRequest": {
      "identifierType": "1",
      "identifierValue": "1234567891011"
    },
    "preTaxAmount": "34.58",
    "receiptNumber": "MON-TICKET-270925-1",
    "AccountAdvantageRequest": [
      {
        "type": "1",
        "value": "0"
      }
    ],
    "transactionDate": "27/09/2025 16:30:00"
  }
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST '/rest/transactionWebService/refundTransaction' \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--data-raw '{
  "DetailsRequest": {
    "nbItems": "2",
    "nbOfferNumbers": "0",
    "TransactionItemRequest": [
      {
        "allTaxesIncludedUnitPrice": "12.57",
        "discountAmount": "2",
        "ean": "111111",
        "mainReference": "PREMIER_ITEM_DE_TEST",
        "name": "MON ITEM DE TEST",
        "preTaxUnitPrice": "10.76",
        "quantity": "1",
        "storeReference": "12",
        "AccountAdvantageRequest": [
          {
            "type": "1",
            "value": "10"
          }
        ],
        "universReference": "345"
      },
      {
        "allTaxesIncludedUnitPrice": "24.99",
        "discountAmount": "0",
        "ean": "222222",
        "mainReference": "DEUXIEME_ITEM_DE_TEST",
        "name": "UN AUTRE ITEM DE TEST",
        "preTaxUnitPrice": "21.47",
        "quantity": "1"
      }
    ]
  },
  "ReceiptRequest": {
    "allTaxesIncludedAmount": "37.56",
    "cashdeskIpAddress": "127.0.0.1",
    "cashdeskNumber": "2",
    "currency": "1",
    "discountAmount": "2",
    "EntityRequest": {
      "entityIdentifier": "666666"
    },
    "IdentifierRequest": {
      "identifierType": "1",
      "identifierValue": "1234567891011"
    },
    "preTaxAmount": "34.58",
    "receiptNumber": "MON-TICKET-270925-1",
    "AccountAdvantageRequest": [
      {
        "type": "1",
        "value": "0"
      }
    ],
    "transactionDate": "27/09/2025 16:30:00"
  }
}'

Responses

🟢200Success

application/json

Body

Example

{
    "responseCode": "000",
    "infos": "Request successfully processed\nserver.instance.name=API-DOG preprod serveur 1 instance 1\n",
    "ReceiptResponse": {
        "currency": 1,
        "transactionDate": "27/09/2025 16:30:00",
        "transactionId": "A167",
        "allTaxesIncludedAmount": -37.56,
        "preTaxAmount": -34.58,
        "cashdeskIpAddress": "127.0.0.1",
        "cashdeskNumber": "2",
        "discountAmount": 2.0,
        "receiptNumber": "MON-TICKET-270925-1",
        "OldAccountResponse": [
            {
                "name": "point",
                "value": 31,
                "unit": "pts",
                "EntityResponse": {
                    "entityIdentifier": "111111"
                }
            },
            {
                "name": "visites",
                "value": 0,
                "unit": "visites",
                "EntityResponse": {
                    "entityIdentifier": "111111"
                }
            }
        ],
        "NewAccountResponse": [
            {
                "name": "point",
                "value": 31,
                "unit": "pts",
                "EntityResponse": {
                    "entityIdentifier": "111111"
                }
            },
            {
                "name": "visites",
                "value": 0,
                "unit": "visites",
                "EntityResponse": {
                    "entityIdentifier": "111111"
                }
            }
        ]
    },
    "DetailsResponse": {
        "OfferResponse": []
    }
}

Modified at 2025-09-30 09:35:50

sendSimpleTransaction

getLastTransaction