StoredValue Request
It conveys Information related to the Stored Value transaction to process. Content of the Stored Value Request message.
Request Parameters
Data associated with the Sale System, with a particular value during the processing of the payment by the POI, including the cards acquisition.
Identification of the Cashier or Operator.
Language of the Cashier or Operator. If different from the Login.
Shift number. If different from the Login, see Login SaleData.
Identification of a transaction for the Sale System or the POI System.
Unique identification of a transaction to identify the transaction on the Sale System (e.g. ticket number), or the POI System.
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.
Identification of a Sale global transaction for a sequence of related POI transactions. If payment reservation.
Information related to the software and hardware features of the Sale Terminal. Sent in the Login Request if a Sale Terminal is involved in the login. In other messages, sent when a logical device is out of order (SaleCapabilities) or when other data have changed or were missing in the Login.
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.
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
Additional and optional identification of a customer order.
List of customer order open, closed or both to be sent in the response messages. Possible values:
- Both
- Closed
- Open
Sale information intended for the POI. Stored with the transaction.
Sale information intended for the Acquirer. Send to the Acquirer if present.
Sale information intended for the Issuer. The POI System receives this information and sends it to the Acquirer for the Issuer without any change.
Label to print on the bank statement.
Data related to the stored value card.
Identification of the provider of the stored value account load/reload. If more than one provider to manage on the POI, and StoredValueAccountID absent.
Identification of operation to proceed on the stored value account or the stored value card. Possible values:
- Activate
- Duplicate
- Load
- Reserve
- Reverse
- Unload
Identification of the stored value account or the stored value card and the associated product sold by the Sale System for stored value requests.
Type of stored value account. Allows the distinction of the stored value instrument to access the stored value account. Possible values:
- GiftCard
- Other
- PhoneCard
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.)
Name of the owner of a stored value account.
Date after which the card cannot be used. If EMV expiry date is present, it overrides Track2 information. Format is MMYY.
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
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
Stored value account identification. The identification of the stored value account conforming to the IdentificationType.
Identification of a previous POI transaction. In the Payment or the Loyalty Request message, it allows using the card of a previous CardAcquisition or Payment/Loyalty request.
Identification of a Sale System for the NEXO SaletoPOI protocol.
Identification of a payment terminal for the NEXO SaletoPOI protocol. If original transaction is coming from another POI.
Identification of a transaction for the Sale System or the POI System.
Unique identification of a transaction to identify the transaction on the Sale System (e.g. ticket number), or the POI System.
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.
Indicates if the card data has to be retrieved from a previous transaction.
Code assigned to a transaction approval by the Acquirer. If referral.
Identification of the Acquirer. Restrict to the Acquirer if present.
Value of an amount.
Identification of a transaction for the Sale System or the POI System.
Unique identification of a transaction to identify the transaction on the Sale System (e.g. ticket number), or the POI System.
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.
Product code of item purchased with the transaction.
Standard product code of item purchased with the transaction.
Total amount of the item line.
Currency of a monetary amount.
Response parameters
After submitting a call, you receive a response message to inform you that your request was received and processed.
Depending on the HTTP status code of the response message, it is helpful to build some logic to handle any errors that a request or the system may return.
HTTP Responses
200
It conveys Information related to the Stored Value transaction processed by the POI System. Content of the Stored Value Response message.
Show moreShow lessResponseobjectResult of a message request processing. If Result is Success,
ErrorConditionis absent or not used in the processing of the message. In the other cases, theErrorConditionhas to be present and can refine the processing of the message response.AdditionalResponsegives more information about the success or the failure of the message request processing, for logging without real time involvements.ResultstringResult of the processing of the message. Possible values:
- Failure
- Partial
- Success
ErrorConditionstringCondition that has produced an error on the processing of a message request. Returned if Result is not Success. Possible values:
- Aborted
- Busy
- Cancel
- DeviceOut
- InProgress
- InsertedCard
- InvalidCard
- LoggedOut
- MessageFormat
- NotAllowed
- NotFound
- PaymentRestriction
- Refusal
- UnavailableDevice
- UnavailableService
- UnreachableHost
- WrongPIN
AdditionalResponsestringAdditional information related to processing status of a message request. If present, the POI logs it for further examination.
SaleDataobjectData associated with the Sale System, with a particular value during the processing of the payment by the POI, including the cards acquisition.
OperatorIDstringIdentification of the Cashier or Operator.
OperatorLanguagestringLanguage of the Cashier or Operator. If different from the Login.
ShiftNumberstringShift number. If different from the Login, see Login SaleData.
SaleTransactionIDobjectIdentification of a transaction for the Sale System or the POI System.
TransactionIDstringUnique identification of a transaction to identify the transaction on the Sale System (e.g. ticket number), or the POI System.
TimeStampstringDate 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.
SaleReferenceIDstringIdentification of a Sale global transaction for a sequence of related POI transactions. If payment reservation.
SaleTerminalDataobjectInformation related to the software and hardware features of the Sale Terminal. Sent in the Login Request if a Sale Terminal is involved in the login. In other messages, sent when a logical device is out of order (SaleCapabilities) or when other data have changed or were missing in the Login.
TotalsGroupIDstringIdentification 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.
TokenRequestedTypestringType 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
CustomerOrderIDstringAdditional and optional identification of a customer order.
CustomerOrderReqarray[string]List of customer order open, closed or both to be sent in the response messages. Possible values:
- Both
- Closed
- Open
SaleToPOIDatastringSale information intended for the POI. Stored with the transaction.
SaleToAcquirerDatastringSale information intended for the Acquirer. Send to the Acquirer if present.
SaleToIssuerDataobjectSale information intended for the Issuer. The POI System receives this information and sends it to the Acquirer for the Issuer without any change.
StatementReferencestringLabel to print on the bank statement.
POIDataobjectData related to the POI System. In the Message Response, identification of the POI transaction.
POITransactionIDobjectIdentification of a transaction for the Sale System or the POI System.
TransactionIDstringUnique identification of a transaction to identify the transaction on the Sale System (e.g. ticket number), or the POI System.
TimeStampstringDate 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.
POIReconciliationIDintegerIdentification of the reconciliation period between Sale and POI. If Result is Success.
StoredValueResultarray[object]Result of loading/reloading a stored value card.. If StoredValueResponse.Result is Success or Partial, one entry per StoredValueRequest.StoredValueData loaded or activated.
StoredValueTransactionTypestringIdentification of operation to proceed on the stored value account or the stored value card. Copy. Possible values:
- Activate
- Duplicate
- Load
- Reserve
- Reverse
- Unload
ProductCodeintegerMinimum: 1Maximum: 20Product code of item purchased with the transaction. Copy.
EanUpcintegerStandard product code of item purchased with the transaction. Copy.
ItemAmountnumberMaximum: 99999999.999999Total amount of the item line.
CurrencystringCurrency of a monetary amount. Copy.
StoredValueAccountStatusobjectData related to the result of the stored value card transaction.
StoredValueAccountIDobjectIdentification of the stored value account or the stored value card and the associated product sold by the Sale System for stored value requests.
StoredValueAccountTypestringType of stored value account. Allows the distinction of the stored value instrument to access the stored value account. Possible values:
- GiftCard
- Other
- PhoneCard
StoredValueProviderstringIdentification 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.)
OwnerNamestringName of the owner of a stored value account.
ExpiryDateintegerMinimum: 4Maximum: 4Date after which the card cannot be used. If EMV expiry date is present, it overrides Track2 information. Format is MMYY.
EntryModearray[string]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
IdentificationTypestringType 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
StoredValueIDstringStored value account identification. The identification of the stored value account conforming to the IdentificationType.
CurrentBalancenumberMaximum: 99999999.999999If relevant and known.
HostTransactionIDobjectIdentification of a transaction for the Sale System or the POI System.
TransactionIDstringUnique identification of a transaction to identify the transaction on the Sale System (e.g. ticket number), or the POI System.
TimeStampstringDate 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.
PaymentReceiptarray[object]DocumentQualifierstringQualification of the document to print to the Cashier or the Customer. SaleReceipt or CashierReceipt. Possible values:
- CashierReceipt
- CustomerReceipt
- Document
- Journal
- SaleReceipt
- Voucher
IntegratedPrintFlagbooleanType of the print integrated to other prints.
RequiredSignatureFlagbooleanIndicate that the cardholder payment receipt requires a physical signature by the Customer.
OutputContentobjectContent to display or print. This is a sequence of elements if they have different formats.
OutputFormatstringFormat of the content to display or print. Display or print device function. Possible values:
- BarCode
- MessageRef
- Text
- XHTML
PredefinedContentobjectReference of a predefined message to display or print. It conveys information related to the predefined message.
ReferenceIDstringIdentification of a predefined message to display or print.
LanguagestringIdentification of a language.
OutputTextarray[object]Content of text message to display or print. Mandatory, if
OutputFormatis Text, not allowed otherwise. One instance ofOutputTextper shared format.TextstringContent of text message to display, print or play.
CharacterSetintegerCharacter height of the text string to display or print. Absence of this data element means the characters have normal height.
FontstringName of the font. Used to change character font of the output, as agreed between the POI and Sale Systems.
StartRowintegerMinimum: 1Maximum: 500Row where the text string has to be displayed or printed.
StartColumnintegerMinimum: 1Maximum: 500Column where the text string has to be displayed or printed.
ColorstringColor of the text string to display or print. Possible values:
- Black
- Blue
- Cyan
- Green
- Magenta
- Red
- White
- Yellow
CharacterWidthstringCharacter width of the text string to display or print. Absence of this data element means the characters have normal width. Possible values:
- DoubleWidth
- SingleWidth
CharacterHeightstringCharacter height of the text string to display or print. Absence of this data element means the characters have normal height. Possible values:
- DoubleHeight
- HalfHeight
- SingleHeight
CharacterStylestringTypographic style of the sequence of characters to display or print. Absence of this data element means the characters have normal style. Possible values:
- Bold
- Italic
- Normal
- Underline
AlignmentstringAlignment of the text string on the display line or print line. Absence of this data element means the characters have normal alignment. Possible values:
- Centred
- Justified
- Left
- Right
EndOfLineFlagbooleanIndicates if the text is at the end of a line. Allows the display or the print of a new line and a carry-over return characters after the formatted text.
OutputXHTMLstringXHTML document body containing the message to display or print. Mandatory if
OutputFormatis XHTML, not allowed otherwise.OutputBarcodeobjectBarcode content to display or print. Mandatory if
OutputFormatis Barcode, not allowed otherwise.BarcodeTypestringType of Barcode coding. Qualification of the barcode value to display or print. Possible values:
- Code128
- Code25
- EAN13
- EAN8
- PDF417
- QRCode
- UPCA
BarcodeValuestringValue with a Barcode coding. The barcode value to display or print.