POST /storedvalue

It conveys Information related to the Stored Value transaction to process. Content of the Stored Value Request message.

Servers

Request headers

Name Type Required Description
Content-Type String Yes The media type of the request body.

Default value: "application/json"

Request body fields

Name Type Required Description
StoredValueData[] Array Yes

Data related to the stored value card.

StoredValueData[].ItemAmount Number No

Total amount of the item line.

StoredValueData[].Currency String No

Currency of a monetary amount.

StoredValueData[].StoredValueProvider String No

Identification of the provider of the stored value account load/reload. If more than one provider to manage on the POI, and StoredValueAccountID absent.

StoredValueData[].OriginalPOITransaction Object No

Identification of a previous POI transaction. If StoredValueTransactionType is Reverse or Duplicate.

StoredValueData[].OriginalPOITransaction.AcquirerID Integer No

Identification of the Acquirer. Restrict to the Acquirer if present.

StoredValueData[].OriginalPOITransaction.ReuseCardDataFlag Boolean No

Indicates if the card data has to be retrieved from a previous transaction.

Default value: true

StoredValueData[].OriginalPOITransaction.POITransactionID Object No

Unique identification of a POI transaction for a POI. Absent if SaleReferenceID is sufficient to identify the transaction.

StoredValueData[].OriginalPOITransaction.POITransactionID.TimeStamp String Yes

Date and time of a transaction for the Sale System, the POI System or the Acquirer. Ensures the uniqueness of a transaction and indicates the time when the event occurs in the EventNotification message.

StoredValueData[].OriginalPOITransaction.POITransactionID.TransactionID String Yes

Unique identification of a transaction to identify the transaction on the Sale System (e.g. ticket number), or the POI System.

StoredValueData[].OriginalPOITransaction.POIID String No

Identification of a payment terminal for the NEXO SaletoPOI protocol. If original transaction is coming from another POI.

StoredValueData[].OriginalPOITransaction.HostTransactionID Object No

Identification of the transaction by the host in charge of the stored value transaction. If POITransactionID not present.

StoredValueData[].OriginalPOITransaction.HostTransactionID.TimeStamp String Yes

Date and time of a transaction for the Sale System, the POI System or the Acquirer. Ensures the uniqueness of a transaction and indicates the time when the event occurs in the EventNotification message.

StoredValueData[].OriginalPOITransaction.HostTransactionID.TransactionID String Yes

Unique identification of a transaction to identify the transaction on the Sale System (e.g. ticket number), or the POI System.

StoredValueData[].OriginalPOITransaction.ApprovalCode String No

Code assigned to a transaction approval by the Acquirer. If referral.

StoredValueData[].OriginalPOITransaction.AmountValue Number No

Value of an amount.

StoredValueData[].OriginalPOITransaction.SaleID String No

Identification of a Sale System for the NEXO SaletoPOI protocol.

StoredValueData[].EanUpc Integer No

Standard product code of item purchased with the transaction.

StoredValueData[].StoredValueAccountID Object No

Identification of the stored value account or the stored value card. If the identification of the Stored Value account or card has been made by the Sale System before the request.

StoredValueData[].StoredValueAccountID.StoredValueProvider String No

Identification of the provider of the stored value account load/reload. When the ProductCode is not sufficient to identify the provider host which delivers the load or reload of the stored value account (for example if it contains the identification of the application.)

StoredValueData[].StoredValueAccountID.ExpiryDate Integer No

Date after which the card cannot be used. If EMV expiry date is present, it overrides Track2 information. Format is MMYY.

StoredValueData[].StoredValueAccountID.EntryMode[] Array Yes

Entry mode of the payment instrument information. In the Payment, Loyalty, or StoredValue Request messages, it informs the POI System the entry mode of the payment instrument information when read by the Sale Terminal. (e.g. because the payment instrument information are a barcode read by the Cashier on a scanner device). Possible values:

  • Contactless
  • File
  • ICC
  • Keyed
  • MagStripe
  • Manual
  • Mobile
  • RFID
  • Scanned
  • SynchronousICC
  • Tapped
StoredValueData[].StoredValueAccountID.StoredValueAccountType String Yes

Type of stored value account. Allows the distinction of the stored value instrument to access the stored value account. Possible values:

  • GiftCard
  • Other
  • PhoneCard

Possible values:

  • "PhoneCard"
  • "GiftCard"
  • "Other"
StoredValueData[].StoredValueAccountID.IdentificationType String Yes

Type of account identification. In a request message, it informs the POI System the type of the account or card identification, when provided by the Sale Terminal. (e.g. because the card information is a barcode read by the Cashier on a scanner device). In a response message, it informs the Sale System the type of the account or card identification. Possible values:

  • AccountNumber
  • BarCode
  • ISOTrack2
  • PAN
  • PhoneNumber

Possible values:

  • "PAN"
  • "AccountNumber"
  • "BarCode"
  • "PhoneNumber"
  • "ISOTrack2"
StoredValueData[].StoredValueAccountID.StoredValueID String Yes

Stored value account identification. The identification of the stored value account conforming to the IdentificationType.

StoredValueData[].StoredValueAccountID.OwnerName String No

Name of the owner of a stored value account.

StoredValueData[].ProductCode Integer No

Product code of item purchased with the transaction.

StoredValueData[].StoredValueTransactionType String Yes

Identification of operation to proceed on the stored value account or the stored value card. Possible values:

  • Activate
  • Duplicate
  • Load
  • Reserve
  • Reverse
  • Unload

Possible values:

  • "Duplicate"
  • "Unload"
  • "Reserve"
  • "Activate"
  • "Load"
  • "Reverse"
SaleData Object Yes

Data related to the Sale System.

SaleData.OperatorID String No

Identification of the Cashier or Operator.

SaleData.SaleToAcquirerData String No

Sale information intended for the Acquirer. Send to the Acquirer if present.

SaleData.ShiftNumber String No

Shift number. If different from the Login, see Login SaleData.

SaleData.SaleTransactionID Object Yes

Identification of a Sale transaction.

SaleData.SaleTransactionID.TimeStamp String Yes

Date and time of a transaction for the Sale System, the POI System or the Acquirer. Ensures the uniqueness of a transaction and indicates the time when the event occurs in the EventNotification message.

SaleData.SaleTransactionID.TransactionID String Yes

Unique identification of a transaction to identify the transaction on the Sale System (e.g. ticket number), or the POI System.

SaleData.SaleReferenceID String No

Identification of a Sale global transaction for a sequence of related POI transactions. If payment reservation.

SaleData.CustomerOrderReq[] Array No

List of customer order open, closed or both to be sent in the response messages. Possible values:

  • Both
  • Closed
  • Open
SaleData.SaleToPOIData String No

Sale information intended for the POI. Stored with the transaction.

SaleData.OperatorLanguage String No

Language of the Cashier or Operator. If different from the Login.

SaleData.SaleTerminalData Object No

Information related to the software and hardware features of the Sale Terminal. If content is not empty.

SaleData.SaleTerminalData.TotalsGroupID String No

Identification of a group of transactions on a POI Terminal, having the same Sale features. Could be used to group POI for reconciliation or other purpose defined by the Sale System. The default value is assigned by the Login Request.

SaleData.TokenRequestedType String No

Type of token replacing the PAN of a payment card to identify the payment mean of the customer. It allows, for a merchant, to use a token for a transaction only or for a longer period. Possible values:

  • Customer
  • Transaction

Possible values:

  • "Customer"
  • "Transaction"
SaleData.CustomerOrderID String No

Additional and optional identification of a customer order.

SaleData.SaleToIssuerData Object No

Sale information intended for the Issuer. Send to the Acquirer if present.

SaleData.SaleToIssuerData.StatementReference String No

Label to print on the bank statement.

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.