Gift card - add money - V2
Last updated: 22-Jan-2024
This API is used to initiate storedValue requests specifying the following details:
| Request Details | Values |
|---|---|
| Method | POST |
| URL | https://{ENVIRONMENT}/oidc/poscloud/nexo/v2/storedValue |
| Authorization | https://verifone.cloud/docs/in-store-payments/integration-set-terminal#step-3__003a__00a0setting-up-basic-auth-in-postman |
|
Headers: Content-Type x-terminal-simulator x-site-entity-id
Authorization |
application/json true Entity ID of child to be passed in case parent token is used while calling this API "user-uid:api" key pair encoded in base64. See the Obtaining API Keys guide for more information. |
| Body > Raw | See the request example below. |
Check the POS Cloud API reference for more details on the required parameters.
| Required parameters | Description |
|---|---|
MessageHeader |
Object |
MessageHeader.MessageClass |
"SERVICE" |
MessageHeader.MessageCategory |
"STOREDVALUE" |
| MessageHeader.MessageType | "REQUEST" |
| MessageHeader.ServiceID | String |
| MessageHeader.SaleID | String |
| MessageHeader.POIID | String |
| StoredValueRequest | Object |
| StoredValueRequest.SaleData | Object |
| StoredValueRequest.StoredValueData | Array of objects |
| StoredValueRequest.StoredValueTransactionType | String |
| StoredValueRequest.StoredValueAccountType | String |
| StoredValueRequest.EntryMode | String |
| StoredValueRequest.IdentificationType | String |
| StoredValueRequest.StoredValueID | String |
{
"MessageHeader": {
"MessageClass": "SERVICE",
"MessageCategory": "STOREDVALUE",
"MessageType": "REQUEST",
"ServiceID": "1234",
"SaleID": "1992",
"POIID": "275-106-109"
},
"StoredValueRequest": {
"SaleData": {
"OperatorID": "string",
"SaleTransactionID": {
"TransactionID": "1234",
"TimeStamp": "2021-09-13T10:11:11.586Z"
},
"SaleReferenceID": "string",
"SaleTerminalData": {},
"CustomerOrderReq": null,
"SaleToPOIData": null,
"SaleToAcquirerData": null
},
"CustomerLanguage": "string",
"StoredValueData": [
{
"StoredValueProvider": "string",
"StoredValueTransactionType": "LOAD",
"StoredValueAccountID": {
"StoredValueAccountType": "GIFTCARD",
"StoredValueProvider": "string",
"OwnerName": "string",
"ExpiryDate": "string",
"EntryMode": "RFID",
"IdentificationType": "PAN",
"StoredValueID": "string"
},
"OriginalPOITransaction": {
"poiid": "string",
"SaleID": "string",
"POIID": "string",
"POITransactionID": {
"TransactionID": "string",
"TimeStamp": "2021-09-13T10:11:11.586Z"
}
},
"ProductCode": "string",
"EanUpc": "string",
"ItemAmount": "10",
"Currency": "USD"
}
]
}
}Based on the response from the terminal, the POS Cloud will send back the response:
{
"MessageHeader": {
"MessageClass": "SERVICE",
"MessageCategory": "STOREDVALUE",
"MessageType": "RESPONSE",
"ServiceID": "1234",
"SaleID": "1992",
"POIID": "275-106-109"
},
"StoredValueResponse": {
"Response": {
"Result": "SUCCESS",
"ErrorCondition": null,
"AdditionalResponse": "Transaction Success"
},
"SaleData": {
"OperatorID": null,
"SaleTransactionID": {
"TransactionID": "1234",
"TimeStamp": "2021-09-13T10:11:11.586Z"
},
"SaleReferenceID": null,
"SaleTerminalData": null,
"CustomerOrderReq": null,
"SaleToPOIData": null,
"SaleToAcquirerData": null
},
"POIData": {
"POITransactionID": {
"TransactionID": null,
"TimeStamp": "2021-09-13T10:11:11.586Z"
},
"POIReconciliationID": null
},
"StoredValueResult": [
{
"StoredValueTransactionType": "LOAD",
"ProductCode": null,
"ItemAmount": null,
"EanUpc": null,
"Currency": null,
"StoredValueAccountStatus": null,
"HostTransactionID": null
}
],
"PaymentReceipt": null
}
}
Rate this article:
