verifyTransaction

POST

/rest/transactionWebService/verifyTransaction

Maintainer:Martin DA COSTA NETO

Permet de prévisualiser le résultat d'une transaction (application des offres, calculs des points & remises, etc..)

Le retour du verifyTransaction est identique à celui du sendTransaction, mais la transaction est considérée comme « fictive », et ne sera pas enregistrée dans le système.

Les offres qui s'éditent en échange de points auront un impact (fictif) sur les points, sans que l'offre ne soit éditée dans le retour.

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": "1",
    "OfferNumberRequest": [
      {
        "offerNumber": "2558000057275"
      }
    ],
    "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/verifyTransaction' \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--data-raw '{
  "DetailsRequest": {
    "nbItems": "2",
    "nbOfferNumbers": "1",
    "OfferNumberRequest": [
      {
        "offerNumber": "2558000057275"
      }
    ],
    "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",
        "allTaxesIncludedAmount": 22.56,
        "preTaxAmount": 19.26,
        "cashdeskIpAddress": "127.0.0.1",
        "cashdeskNumber": "2",
        "discountAmount": 17.0,
        "receiptNumber": "MON-TICKET-270925-1",
        "OldAccountResponse": [
            {
                "name": "point",
                "value": 62,
                "unit": "pts",
                "EntityResponse": {
                    "entityIdentifier": "111111"
                }
            },
            {
                "name": "visites",
                "value": 0,
                "unit": "visites",
                "EntityResponse": {
                    "entityIdentifier": "111111"
                }
            }
        ],
        "NewAccountResponse": [
            {
                "name": "point",
                "value": 94,
                "unit": "pts",
                "EntityResponse": {
                    "entityIdentifier": "111111"
                }
            },
            {
                "name": "visites",
                "value": 0,
                "unit": "visites",
                "EntityResponse": {
                    "entityIdentifier": "111111"
                }
            }
        ]
    },
    "DetailsResponse": {
        "OfferResponse": [
            {
                "used": true,
                "edited": false,
                "name": "PALIER 450 PTS (15€) - COUPON CAISSE",
                "value": 15.0,
                "type": 1,
                "order": 0,
                "offerNumber": "2558000157272",
                "AccountResponse": []
            }
        ]
    }
}

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

sendAndValidFullTransaction

cancelTransactionsNotValidated