To activate or update a giftcart it's necessary to make a POST call, passing a JSON body as specified below.

This web service is asynchronous, this means that the operation is enqueued. If a callback has been specified in the request, this callback will be called in POST when the queue has ended.

The web service response will be composed of:

success: Boolean that indicated wether the request was successful enqueued or not

Actors

API Client: The system or user initiating the request.

4ws.trade: The backend system that processes the request.

Examples

Example of activation of a giftcard

  {
    entityCode : 440,
    barcode: "0098260111383",
    amount : 100.0,
    activationDate : "2021-08-31 10:00:00",
    country : "IT",
    branchCode : "1150",
    priceList : "1150",
    currencySymbol : "€",
    currency : "EUR",
    clientBarcode : "clientBarcode",
    clientCode : "clientCode",
    clientDenomination : "GINO"
  }

Example of consumption of a giftcard

  {
    entityCode : 440,
    barcode: "0098260111383",
    amount : -50.0,
  }

Fields

Field	Description	Type
entityCode	The entity code String	✓
barcode	Giftcard barcode String	✓
amount	The consumed (negative) value of the gift card. In case of activation, pass the (positive) value of the gift card number	✓
activationDate	Activation date with format "yyyy-MM-dd HH:mm:ss", using GMT time String	Only on insert
country	Country String	Only on insert
branchCode	Branch code String	Only on insert
priceList	Price list String	Only on insert
currencySymbol	Currency symbol String	Only on insert
currency	Currency code String	Only on insert
clientBarcode	Client barcode String
clientCode	Client code String
clientDenomination	Client denomination String
callback	callback url
payload	in case of callback this payload will be passed

Request

Query Params

Header Params

Body Params text/plain

Example

Example:{ entityCode : 440, barcode: "0098260111383", amount : 100.0, activationDate : "2021-08-31 10:00:00", country : "IT", branchCode : "1150", priceList : "1150", currencySymbol : "€", currency : "EUR", clientBarcode : "clientBarcode", clientCode : "clientCode", clientDenomination : "GINO", callback : "https://..." }

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Update Giftcard

Actors

Examples

Example of activation of a giftcard

Example of consumption of a giftcard

Fields

Request

Request Code Samples

Responses

Update Giftcard

Actors#

Examples#

Example of activation of a giftcard#

Example of consumption of a giftcard#

Fields#

Request

Request Code Samples

Responses

Actors

Examples

Example of activation of a giftcard

Example of consumption of a giftcard

Fields