{"title":"Deactivate or cash out a gift card","category":"default","creationDate":1779620071,"content":"<p>When the balance of a gift card has gone below a certain amount or when you suspect fraud, you can stop further use of the card. You can:<\/p>\n<ul>\n<li>Make a <a href=\"#cashing-back-gift-card\">cashback request<\/a> to take funds off the gift card and give this back to the shopper as cash. If you cash out the full remaining balance, the card is no longer active and cannot be used again.<\/li>\n<li>Make a <a href=\"#deactivate-gift-card\">deactivation request<\/a> to disable the card without cashing it out.<\/li>\n<\/ul>\n<h2>Requirements<\/h2>\n<p>Before you begin, take into account the following requirements, limitations, and preparations.<\/p>\n<table>\n<thead>\n<tr>\n<th style=\"text-align: left;\">Requirement<\/th>\n<th style=\"text-align: left;\">Description<\/th>\n<\/tr>\n<\/thead>\n<tbody>\n<tr>\n<td style=\"text-align: left;\"><strong>Integration type<\/strong><\/td>\n<td style=\"text-align: left;\">A <a href=\"\/point-of-sale\/design-your-integration\/terminal-api\">Terminal API<\/a> integration with payment terminals.<\/td>\n<\/tr>\n<tr>\n<td style=\"text-align: left;\"><strong>Limitations<\/strong><\/td>\n<td style=\"text-align: left;\">Deactivation is only supported for gift cards provided by Givex.<\/td>\n<\/tr>\n<tr>\n<td style=\"text-align: left;\"><strong>Setup steps<\/strong><\/td>\n<td style=\"text-align: left;\">Before you begin: <ul><li markdown=\"1\"><a href=\"\/point-of-sale\/what-we-support\/payment-methods#add-payment-methods-to-your-account\">Add the payment method to your Adyen account<\/a>.<\/li><li markdown=\"1\">Complete the onboarding process with the gift card provider.<\/li><\/ul><\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<h2 id=\"cashing-back-gift-card\">Cash back a gift card<\/h2>\n<p>Your options with a cashback request depend on the gift card provider, the scheme rules, and the applicable law. If cashbacks are allowed, you can normally only cash out the full amount remaining on the card. But if the gift card was provided by Givex, it is possible in some cases to give a cashback for a partial amount.<\/p>\n<p>The funds taken off the gift card can be given back to the shopper in cash, or transferred to their credit or debit card by <a href=\"\/point-of-sale\/gift-cards-terminal-api\/refund-gift-cards#make-an-unreferenced-refund\">making an unreferenced refund<\/a>.<\/p>\n<p>To make a gift card cashback request:<\/p>\n<ol>\n<li>\n<p>Determine the <a href=\"\/point-of-sale\/gift-cards-terminal-api#card-entry\">card entry method<\/a>:<\/p>\n<ul>\n<li>If you want to scan the card, do that first and use the obtained card details in your request.<\/li>\n<li>If you want to swipe the card or use manual keyed entry (MKE), send the request first. The payment terminal will show a prompt to swipe the card or enter the card details.<\/li>\n<\/ul>\n<\/li>\n<li>\n<p><a href=\"\/point-of-sale\/gift-cards-terminal-api\/query-the-balance\">Check the balance<\/a> remaining on the gift card.<\/p>\n<\/li>\n<li>\n<p><a href=\"\/point-of-sale\/basic-tapi-integration\/make-a-payment\">Make a payment request<\/a>, specifying:<\/p>\n<ul>\n<li>\n<p>The standard <a href=\"\/point-of-sale\/design-your-integration\/terminal-api#request-message-header\">\n  <code>SaleToPOIRequest.MessageHeader<\/code>\n<\/a> object, with <code>MessageClass<\/code> set to <span translate=\"no\"><strong>Service<\/strong><\/span> and <code>MessageCategory<\/code> set to <span translate=\"no\"><strong>Payment<\/strong><\/span>.<\/p>\n<table>\n<thead>\n<tr>\n<th style=\"text-align: left;\">Parameter<\/th>\n<th style=\"text-align: center;\">Required<\/th>\n<th style=\"text-align: left;\">Description<\/th>\n<\/tr>\n<\/thead>\n<tbody>\n<tr>\n<td style=\"text-align: left;\"><code>ProtocolVersion<\/code><\/td>\n<td style=\"text-align: center;\"><img title=\"-white_check_mark-\" alt=\"-white_check_mark-\" class=\"smileys\" src=\"\/user\/data\/smileys\/emoji\/white_check_mark.png\" \/><\/td>\n<td style=\"text-align: left;\"><strong>3.0<\/strong><\/td>\n<\/tr>\n<tr>\n<td style=\"text-align: left;\"><code>MessageClass<\/code><\/td>\n<td style=\"text-align: center;\"><img title=\"-white_check_mark-\" alt=\"-white_check_mark-\" class=\"smileys\" src=\"\/user\/data\/smileys\/emoji\/white_check_mark.png\" \/><\/td>\n<td style=\"text-align: left;\"><span translate=\"no\"><strong>Service<\/strong><\/span><\/td>\n<\/tr>\n<tr>\n<td style=\"text-align: left;\"><code>MessageCategory<\/code><\/td>\n<td style=\"text-align: center;\"><img title=\"-white_check_mark-\" alt=\"-white_check_mark-\" class=\"smileys\" src=\"\/user\/data\/smileys\/emoji\/white_check_mark.png\" \/><\/td>\n<td style=\"text-align: left;\"><span translate=\"no\"><strong>Payment<\/strong><\/span><\/td>\n<\/tr>\n<tr>\n<td style=\"text-align: left;\"><code>MessageType<\/code><\/td>\n<td style=\"text-align: center;\"><img title=\"-white_check_mark-\" alt=\"-white_check_mark-\" class=\"smileys\" src=\"\/user\/data\/smileys\/emoji\/white_check_mark.png\" \/><\/td>\n<td style=\"text-align: left;\"><span translate=\"no\"><strong>Request<\/strong><\/span><\/td>\n<\/tr>\n<tr>\n<td style=\"text-align: left;\"><code>ServiceID<\/code><\/td>\n<td style=\"text-align: center;\"><img title=\"-white_check_mark-\" alt=\"-white_check_mark-\" class=\"smileys\" src=\"\/user\/data\/smileys\/emoji\/white_check_mark.png\" \/><\/td>\n<td style=\"text-align: left;\">Your unique ID for this request, consisting of 1-10 alphanumeric characters. Must be unique within the last 48 hours for the terminal (<code>POIID<\/code>) being used.<\/td>\n<\/tr>\n<tr>\n<td style=\"text-align: left;\"><code>SaleID<\/code><\/td>\n<td style=\"text-align: center;\"><img title=\"-white_check_mark-\" alt=\"-white_check_mark-\" class=\"smileys\" src=\"\/user\/data\/smileys\/emoji\/white_check_mark.png\" \/><\/td>\n<td style=\"text-align: left;\">Your unique ID for the POS system component to send this request from.<\/td>\n<\/tr>\n<tr>\n<td style=\"text-align: left;\"><code>POIID<\/code><\/td>\n<td style=\"text-align: center;\"><img title=\"-white_check_mark-\" alt=\"-white_check_mark-\" class=\"smileys\" src=\"\/user\/data\/smileys\/emoji\/white_check_mark.png\" \/><\/td>\n<td style=\"text-align: left;\">The unique ID of the terminal to send this request to. Format: <em>[device model]-[serial number]<\/em>.<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<\/li>\n<\/ul>\n<ul>\n<li>\n<p>The  <a href=\"https:\/\/docs.adyen.com\/api-explorer\/terminal-api\/latest\/post\/payment#request-SaleData\" class=\"codeLabel  external-link no-image\" target=\"_blank\" rel=\"nofollow noopener noreferrer\">SaleData<\/a> object with:<\/p>\n<table>\n<thead>\n<tr>\n<th style=\"text-align: left;\">Parameter<\/th>\n<th style=\"text-align: center;\">Required<\/th>\n<th style=\"text-align: left;\">Description<\/th>\n<\/tr>\n<\/thead>\n<tbody>\n<tr>\n<td style=\"text-align: left;\"><code>SaleTransactionID.TransactionID<\/code><\/td>\n<td style=\"text-align: center;\"><img title=\"-white_check_mark-\" alt=\"-white_check_mark-\" class=\"smileys\" src=\"\/user\/data\/smileys\/emoji\/white_check_mark.png\" \/><\/td>\n<td style=\"text-align: left;\">Your reference to identify this cashback request. We recommend using a unique value.<\/td>\n<\/tr>\n<tr>\n<td style=\"text-align: left;\"><code>SaleTransactionID.TimeStamp<\/code><\/td>\n<td style=\"text-align: center;\"><img title=\"-white_check_mark-\" alt=\"-white_check_mark-\" class=\"smileys\" src=\"\/user\/data\/smileys\/emoji\/white_check_mark.png\" \/><\/td>\n<td style=\"text-align: left;\">Date and time of the cashback request, in <a href=\"https:\/\/en.wikipedia.org\/wiki\/ISO_8601#Coordinated_Universal_Time_(UTC)\" target=\"_blank\" rel=\"nofollow noopener noreferrer\" class=\"external-link no-image\">UTC format<\/a>.<\/td>\n<\/tr>\n<tr>\n<td style=\"text-align: left;\"><code>SaleReferenceID<\/code><\/td>\n<td style=\"text-align: center;\"><img title=\"-white_check_mark-\" alt=\"-white_check_mark-\" class=\"smileys\" src=\"\/user\/data\/smileys\/emoji\/white_check_mark.png\" \/><\/td>\n<td style=\"text-align: left;\">Optional parameter to provide your order number. You can use this to connect different gift card transactions to the same order. In the <a href=\"https:\/\/ca-test.adyen.com\/\" target=\"_blank\" rel=\"nofollow noopener noreferrer\" class=\"external-link no-image\">Customer Area<\/a>, it will appear as the <strong>Merchant Order<\/strong> for the transaction.<\/td>\n<\/tr>\n<tr>\n<td style=\"text-align: left;\"><code>SaleToAcquirerData<\/code><\/td>\n<td style=\"text-align: center;\"><img title=\"-white_check_mark-\" alt=\"-white_check_mark-\" class=\"smileys\" src=\"\/user\/data\/smileys\/emoji\/white_check_mark.png\" \/><\/td>\n<td style=\"text-align: left;\"><span translate=\"no\"><strong>redemptionType=cashback<\/strong><\/span><\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<p><a id=\"sale-to-acquirer-data\"><\/a><br \/>\nIn <code>SaleData.SaleToAcquirerData<\/code>, specify the tender option in one of the following formats:<\/p>\n<ul>\n<li>\n<p>Option 1: a JSON object converted to a Base64 encoded string.<br \/>\nEncode <code>{\"redemptionType\": \"cashback\"}<\/code> to Base64, and pass the resulting string:<br \/>\n<code>\"SaleToAcquirerData\": \"eyJyZWRlbXB0aW9uVHlwZSI6ICJjYXNoYmFjayJ9\"<\/code><\/p>\n<\/li>\n<li>\n<p>Option 2: a key-value pair:<br \/>\n<code>\"SaleToAcquirerData\": \"redemptionType=cashback\"<\/code><\/p>\n<\/li>\n<\/ul>\n<p>The format that you use here will also be the format of the <code>AdditionalResponse<\/code> that you receive. If there are more tender options (for example, <span translate=\"no\"><strong>ReceiptHandler<\/strong><\/span> ) or other data elements that you need to pass in the <code>SaleToAcquirerData<\/code> field, refer to <a href=\"\/point-of-sale\/add-data\">Add information to a payment<\/a>.<br \/>\n<br><\/p>\n<\/li>\n<li>\n<p>The  <a href=\"https:\/\/docs.adyen.com\/api-explorer\/terminal-api\/latest\/post\/payment#request-PaymentTransaction\" class=\"codeLabel  external-link no-image\" target=\"_blank\" rel=\"nofollow noopener noreferrer\">PaymentTransaction<\/a> object with:<\/p>\n<table>\n<thead>\n<tr>\n<th style=\"text-align: left;\">Parameter<\/th>\n<th style=\"text-align: center;\">Required<\/th>\n<th style=\"text-align: left;\">Description<\/th>\n<\/tr>\n<\/thead>\n<tbody>\n<tr>\n<td style=\"text-align: left;\"><code>AmountsReq<\/code><\/td>\n<td style=\"text-align: center;\"><img title=\"-white_check_mark-\" alt=\"-white_check_mark-\" class=\"smileys\" src=\"\/user\/data\/smileys\/emoji\/white_check_mark.png\" \/><\/td>\n<td style=\"text-align: left;\">The <code>Currency<\/code> and <code>RequestedAmount<\/code> being given back to the shopper.<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<\/li>\n<li>\n<p>The  <a href=\"https:\/\/docs.adyen.com\/api-explorer\/terminal-api\/latest\/post\/payment#request-PaymentData\" class=\"codeLabel  external-link no-image\" target=\"_blank\" rel=\"nofollow noopener noreferrer\">PaymentData<\/a> object with:<\/p>\n<table>\n<thead>\n<tr>\n<th style=\"text-align: left;\">Parameter<\/th>\n<th style=\"text-align: center;\">Required<\/th>\n<th style=\"text-align: left;\">Description<\/th>\n<\/tr>\n<\/thead>\n<tbody>\n<tr>\n<td style=\"text-align: left;\"><code>PaymentType<\/code><\/td>\n<td style=\"text-align: center;\"><img title=\"-white_check_mark-\" alt=\"-white_check_mark-\" class=\"smileys\" src=\"\/user\/data\/smileys\/emoji\/white_check_mark.png\" \/><\/td>\n<td style=\"text-align: left;\"><span translate=\"no\"><strong>Normal<\/strong><\/span><\/td>\n<\/tr>\n<tr>\n<td style=\"text-align: left;\"><code>PaymentInstrumentData.PaymentInstrumentType<\/code><\/td>\n<td style=\"text-align: center;\"><img title=\"-white_check_mark-\" alt=\"-white_check_mark-\" class=\"smileys\" src=\"\/user\/data\/smileys\/emoji\/white_check_mark.png\" \/><\/td>\n<td style=\"text-align: left;\"><span translate=\"no\"><strong>StoredValue<\/strong><\/span><\/td>\n<\/tr>\n<tr>\n<td style=\"text-align: left;\"><code>PaymentInstrumentData.StoredValueAccountID<\/code><\/td>\n<td style=\"text-align: center;\"><img title=\"-white_check_mark-\" alt=\"-white_check_mark-\" class=\"smileys\" src=\"\/user\/data\/smileys\/emoji\/white_check_mark.png\" \/><\/td>\n<td style=\"text-align: left;\">The gift card details: <ul> <li markdown=\"1\"><code>StoredValueAccountType<\/code>: <span translate=\"no\"><strong>GiftCard<\/strong><\/span><\/li> <li markdown=\"1\"><code>StoredValueProvider<\/code>: the gift card issuer: <span translate=\"no\"><strong>givex<\/strong><\/span>, <span translate=\"no\"><strong>svs<\/strong><\/span>, <span translate=\"no\"><strong>valuelink<\/strong><\/span>, or <strong><a href=\"\/payment-methods\/gift-cards#supported-gift-cards\">any Intersolve-supported card type<\/a><\/strong>.<\/li> <li markdown=\"1\"><code>IdentificationType<\/code>: <span translate=\"no\"><strong>PAN<\/strong><\/span><\/li> <li markdown=\"1\"><code>EntryMode<\/code>, <code>StoredValueID<\/code> and <code>ExpiryDate<\/code>: these parameters depend on the <a href=\"\/point-of-sale\/gift-cards-terminal-api#card-entry\">card entry method<\/a> you are using. See the table below.<\/li> <\/ul><\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<table>\n<thead>\n<tr>\n<th style=\"text-align: left;\">Card entry<\/th>\n<th style=\"text-align: left;\">Parameters<\/th>\n<\/tr>\n<\/thead>\n<tbody>\n<tr>\n<td style=\"text-align: left;\">Scan<\/td>\n<td style=\"text-align: left;\"><ul><li markdown=\"1\"><code>EntryMode<\/code>: <span translate=\"no\"><strong>Scanned<\/strong><\/span><\/li><li markdown=\"1\"><code>StoredValueID<\/code>: gift card number.<\/li><li markdown=\"1\"><code>ExpiryDate<\/code>: expiry date of the gift card.<\/li><\/ul><\/td>\n<\/tr>\n<tr>\n<td style=\"text-align: left;\">Swipe<\/td>\n<td style=\"text-align: left;\"><ul><li markdown=\"1\"><code>EntryMode<\/code>: <span translate=\"no\"><strong>MagStripe<\/strong><\/span><\/li><li markdown=\"1\"><code>StoredValueID<\/code>: include this parameter but do not provide a value.<\/li><\/td>\n<\/tr>\n<tr>\n<td style=\"text-align: left;\">MKE<\/td>\n<td style=\"text-align: left;\"><ul><li markdown=\"1\"><code>EntryMode<\/code>: <span translate=\"no\"><strong>Keyed<\/strong><\/span><\/li><li markdown=\"1\"><code>StoredValueID<\/code>: include this parameter but do not provide a value.<\/li><\/ul><\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<\/li>\n<\/ul>\n<p>The example below shows how to initiate a GBP&nbsp;4.50 cashback request for a scanned gift card.<\/p>\n<div data-component-wrapper=\"code-sample\">\n<code-sample :title=\"''\" :id=\"'cashback-and-cash-out-gift-cards_0'\" :code-data='[{\"language\":\"json\",\"tabTitle\":\"JSON\",\"content\":\"{\\n  \\\"SaleToPOIRequest\\\": {\\n    \\\"MessageHeader\\\": {\\n      \\\"ProtocolVersion\\\": \\\"3.0\\\",\\n      \\\"MessageClass\\\": \\\"Service\\\",\\n      \\\"MessageCategory\\\": \\\"Payment\\\",\\n      \\\"MessageType\\\": \\\"Request\\\",\\n      \\\"ServiceID\\\": \\\"9269\\\",\\n      \\\"SaleID\\\": \\\"POSTerminal\\\",\\n      \\\"POIID\\\": \\\"V400m-324688179\\\"\\n    },\\n    \\\"PaymentRequest\\\": {\\n      \\\"SaleData\\\": {\\n        \\\"SaleTransactionID\\\": {\\n          \\\"TransactionID\\\": \\\"44750\\\",\\n          \\\"TimeStamp\\\": \\\"2019-06-22T12:55:20+00:00\\\"\\n        },\\n        \\\"SaleReferenceID\\\": \\\"YOUR_ORDER_REFERENCE\\\",\\n        \\\"SaleToAcquirerData\\\": \\\"redemptionType=cashback\\\"\\n      },\\n      \\\"PaymentTransaction\\\": {\\n        \\\"AmountsReq\\\": {\\n          \\\"Currency\\\": \\\"GBP\\\",\\n          \\\"RequestedAmount\\\": 4.50\\n        }\\n      },\\n      \\\"PaymentData\\\": {\\n        \\\"PaymentType\\\": \\\"Normal\\\",\\n        \\\"PaymentInstrumentData\\\": {\\n          \\\"PaymentInstrumentType\\\": \\\"StoredValue\\\",\\n          \\\"StoredValueAccountID\\\": {\\n            \\\"StoredValueAccountType\\\": \\\"GiftCard\\\",\\n            \\\"StoredValueProvider\\\": \\\"svs\\\",\\n            \\\"IdentificationType\\\": \\\"PAN\\\",\\n            \\\"EntryMode\\\": [\\n              \\\"Scanned\\n            ],\\n            \\\"StoredValueID\\\": \\\"6006491260550218066\\\",\\n            \\\"ExpiryDate\\\": \\\"1122\\\"\\n          }\\n        }\\n      }\\n    }\\n  }\\n}\"},{\"language\":\"java\",\"tabTitle\":\"Java\",\"content\":\"String serviceID = \\\"YOUR_UNIQUE_ATTEMPT_ID\\\";\\nString saleID = \\\"YOUR_CASH_REGISTER_ID\\\";\\nString POIID = \\\"YOUR_TERMINAL_ID\\\";\\nString transactionID = \\\"YOUR_UNIQUE_TRANSACTION_ID\\\";\\n\\nSaleToPOIRequest saleToPOIRequest = new SaleToPOIRequest();\\nMessageHeader messageHeader = new MessageHeader();\\nmessageHeader.setProtocolVersion(\\\"3.0\\\");\\nmessageHeader.setMessageClass( MessageClassType.SERVICE );\\nmessageHeader.setMessageCategory( MessageCategoryType.PAYMENT );\\nmessageHeader.setMessageType( MessageType.REQUEST );\\nmessageHeader.setServiceID(serviceID);\\nmessageHeader.setSaleID(saleID);\\nmessageHeader.setPOIID(POIID);\\nsaleToPOIRequest.setMessageHeader(messageHeader);\\n\\nPaymentRequest paymentRequest = new PaymentRequest();\\nSaleData saleData = new SaleData();\\nTransactionIdentification saleTransactionID = new TransactionIdentification();\\nsaleTransactionID.setTransactionID(transactionID);\\nsaleTransactionID.setTimeStamp(DatatypeFactory.newInstance().newXMLGregorianCalendar(new GregorianCalendar()));\\nsaleData.setSaleTransactionID(saleTransactionID);\\nsaleData.setSaleReferenceID(\\\"YOUR_ORDER_REFERENCE\\\");\\nsaleData.setSaleToAcquirerData(\\\"redemptionType=cashback\\\");\\npaymentRequest.setSaleData(saleData);\\n\\nPaymentTransaction paymentTransaction = new PaymentTransaction();\\nAmountsReq amountsReq = new AmountsReq();\\namountsReq.setCurrency(\\\"GBP\\\");\\namountsReq.setRequestedAmount( BigDecimal.valueOf(4.50) );\\npaymentTransaction.setAmountsReq(amountsReq);\\npaymentRequest.setPaymentTransaction(paymentTransaction);\\n\\nPaymentData paymentData = new PaymentData();\\npaymentData.setPaymentType( PaymentType.NORMAL );\\nPaymentInstrumentData paymentInstrumentData = new PaymentInstrumentData();\\npaymentInstrumentData.setPaymentInstrumentType( PaymentInstrumentType.STORED_VALUE );\\nStoredValueAccountID storedValueAccountID = new StoredValueAccountID();\\nstoredValueAccountID.setStoredValueAccountType( StoredValueAccountType.GIFT_CARD );\\nstoredValueAccountID.setStoredValueProvider(\\\"svs\\\");\\nstoredValueAccountID.setIdentificationType( IdentificationType.PAN );\\nstoredValueAccountID.getEntryMode().add( EntryModeType.SCANNED );\\nstoredValueAccountID.setStoredValueID(\\\"6006491260550218066\\\");\\nstoredValueAccountID.setExpiryDate(\\\"1122\\\");\\npaymentInstrumentData.setStoredValueAccountID(storedValueAccountID);\\npaymentData.setPaymentInstrumentData(paymentInstrumentData);\\npaymentRequest.setPaymentData(paymentData);\\nsaleToPOIRequest.setPaymentRequest(paymentRequest);\\nterminalAPIRequest.setSaleToPOIRequest(saleToPOIRequest);\"}]' :enable-copy-link-to-code-block=\"true\" :code-sample-card-size=\"'fullsize'\"><\/code-sample>\n<\/div>\n<p>The cashback request is sent to the Adyen payments platform for processing. Once processed, your integration receives the cashback result.<\/p>\n<\/li>\n<li>\n<p>In the  <a href=\"https:\/\/docs.adyen.com\/api-explorer\/terminal-api\/latest\/post\/payment#responses-200\" class=\"codeLabel  external-link no-image\" target=\"_blank\" rel=\"nofollow noopener noreferrer\">PaymentResponse<\/a>, check the following:<\/p>\n<ul>\n<li><code>POIData.POITransactionID.TransactionID<\/code>: The <a href=\"\/point-of-sale\/design-your-integration\/terminal-api#transaction-identifier\">transaction identifier<\/a> for the cashback.<\/li>\n<li><code>PaymentReceipt<\/code>: An object containing data you can use to <a href=\"\/point-of-sale\/basic-tapi-integration\/generate-receipts\">generate a receipt<\/a>.<\/li>\n<li><code>Response.Result<\/code>: <span translate=\"no\"><strong>Success<\/strong><\/span><\/li>\n<\/ul>\n<p>The example below indicates that the cashback request was successful, and GBP&nbsp;4.50 was removed from the balance of the gift card.<\/p>\n<pre><code class=\"language-json\">{\n    \"SaleToPOIResponse\":{\n        \"PaymentResponse\":{\n            \"POIData\":{\n                \"POITransactionID\":{\n                    \"TimeStamp\":\"2019-06-22T12:55:24.000Z\",\n                    \"TransactionID\":\"u6W7001529672124004.NC6HT9CRT65ZGN82\"\n                }\n            },\n            \"SaleData\":{\n                \"SaleTransactionID\":{\n                    \"TimeStamp\":\"2019-06-22T12:55:20.000Z\",\n                    \"TransactionID\":\"44742\"\n                },\n                \"SaleReferenceID\":\"YOUR_ORDER_REFERENCE\"\n            },\n            \"PaymentReceipt\":[...],\n            \"PaymentResult\":{\n                \"PaymentAcquirerData\":{\n                    \"AcquirerPOIID\":\"V400m-324688179\",\n                    \"AcquirerTransactionID\":{\n                        \"TimeStamp\":\"2019-06-22T12:55:24.000Z\",\n                        \"TransactionID\":\"NC6HT9CRT65ZGN82\"\n                    },\n                    \"MerchantID\":\"TestMerchantPOS\"\n                },\n                \"PaymentInstrumentData\":{\n                    \"StoredValueAccountID\":{\n                        \"IdentificationType\":\"PAN\",\n                        \"EntryMode\":[\n                            \"MagStripe\"\n                        ],\n                        \"StoredValueID\":\"9826150911219687\",\n                        \"StoredValueAccountType\":\"GiftCard\",\n                        \"StoredValueProvider\":\"svs\",\n                        \"ExpiryDate\":\"1122\"\n                    },\n                    \"PaymentInstrumentType\":\"StoredValue\"\n                },\n                \"AmountsResp\":{\n                    \"AuthorizedAmount\":4.50,\n                    \"Currency\":\"GBP\"\n                },\n                \"PaymentType\":\"Normal\"\n            },\n            \"Response\":{\n                \"Result\":\"Success\",\n                \"AdditionalResponse\":\"...\"\n            }\n        },\n        \"MessageHeader\":{\n            \"ProtocolVersion\":\"3.0\",\n            \"SaleID\":\"POSTerminal\",\n            \"MessageClass\":\"Service\",\n            \"MessageCategory\":\"Payment\",\n            \"ServiceID\":\"9269\",\n            \"POIID\":\"V400m-324688179\",\n            \"MessageType\":\"Response\"\n        }\n    }\n}<\/code><\/pre>\n<\/li>\n<\/ol>\n<h2 id=\"deactivate-gift-card\">Deactivate a gift card<\/h2>\n<p>If the gift card was issued by Givex, you can make a deactivation request to disable the card.<\/p>\n<p>To make a deactivation request:<\/p>\n<ol>\n<li>\n<p>Determine the <a href=\"\/point-of-sale\/gift-cards-terminal-api#card-entry\">card entry method<\/a>:<\/p>\n<ul>\n<li>If you want to scan the card, do that first and use the obtained card details in your request.<\/li>\n<li>If you want to swipe the card or use manual keyed entry (MKE), send the request first. The payment terminal will show a prompt to swipe the card or enter the card details.<\/li>\n<\/ul>\n<\/li>\n<li>\n<p>Make a <a href=\"\/point-of-sale\/design-your-integration\/terminal-api\">Terminal API<\/a> stored value request, specifying:<\/p>\n<ul>\n<li>\n<p>The standard <a href=\"\/point-of-sale\/design-your-integration\/terminal-api#request-message-header\">\n  <code>SaleToPOIRequest.MessageHeader<\/code>\n<\/a> object, with <code>MessageClass<\/code> set to <span translate=\"no\"><strong>Service<\/strong><\/span> and <code>MessageCategory<\/code> set to <span translate=\"no\"><strong>StoredValue<\/strong><\/span>.<\/p>\n<table>\n<thead>\n<tr>\n<th style=\"text-align: left;\">Parameter<\/th>\n<th style=\"text-align: center;\">Required<\/th>\n<th style=\"text-align: left;\">Description<\/th>\n<\/tr>\n<\/thead>\n<tbody>\n<tr>\n<td style=\"text-align: left;\"><code>ProtocolVersion<\/code><\/td>\n<td style=\"text-align: center;\"><img title=\"-white_check_mark-\" alt=\"-white_check_mark-\" class=\"smileys\" src=\"\/user\/data\/smileys\/emoji\/white_check_mark.png\" \/><\/td>\n<td style=\"text-align: left;\"><strong>3.0<\/strong><\/td>\n<\/tr>\n<tr>\n<td style=\"text-align: left;\"><code>MessageClass<\/code><\/td>\n<td style=\"text-align: center;\"><img title=\"-white_check_mark-\" alt=\"-white_check_mark-\" class=\"smileys\" src=\"\/user\/data\/smileys\/emoji\/white_check_mark.png\" \/><\/td>\n<td style=\"text-align: left;\"><span translate=\"no\"><strong>Service<\/strong><\/span><\/td>\n<\/tr>\n<tr>\n<td style=\"text-align: left;\"><code>MessageCategory<\/code><\/td>\n<td style=\"text-align: center;\"><img title=\"-white_check_mark-\" alt=\"-white_check_mark-\" class=\"smileys\" src=\"\/user\/data\/smileys\/emoji\/white_check_mark.png\" \/><\/td>\n<td style=\"text-align: left;\"><span translate=\"no\"><strong>StoredValue<\/strong><\/span><\/td>\n<\/tr>\n<tr>\n<td style=\"text-align: left;\"><code>MessageType<\/code><\/td>\n<td style=\"text-align: center;\"><img title=\"-white_check_mark-\" alt=\"-white_check_mark-\" class=\"smileys\" src=\"\/user\/data\/smileys\/emoji\/white_check_mark.png\" \/><\/td>\n<td style=\"text-align: left;\"><span translate=\"no\"><strong>Request<\/strong><\/span><\/td>\n<\/tr>\n<tr>\n<td style=\"text-align: left;\"><code>ServiceID<\/code><\/td>\n<td style=\"text-align: center;\"><img title=\"-white_check_mark-\" alt=\"-white_check_mark-\" class=\"smileys\" src=\"\/user\/data\/smileys\/emoji\/white_check_mark.png\" \/><\/td>\n<td style=\"text-align: left;\">Your unique ID for this request, consisting of 1-10 alphanumeric characters. Must be unique within the last 48 hours for the terminal (<code>POIID<\/code>) being used.<\/td>\n<\/tr>\n<tr>\n<td style=\"text-align: left;\"><code>SaleID<\/code><\/td>\n<td style=\"text-align: center;\"><img title=\"-white_check_mark-\" alt=\"-white_check_mark-\" class=\"smileys\" src=\"\/user\/data\/smileys\/emoji\/white_check_mark.png\" \/><\/td>\n<td style=\"text-align: left;\">Your unique ID for the POS system component to send this request from.<\/td>\n<\/tr>\n<tr>\n<td style=\"text-align: left;\"><code>POIID<\/code><\/td>\n<td style=\"text-align: center;\"><img title=\"-white_check_mark-\" alt=\"-white_check_mark-\" class=\"smileys\" src=\"\/user\/data\/smileys\/emoji\/white_check_mark.png\" \/><\/td>\n<td style=\"text-align: left;\">The unique ID of the terminal to send this request to. Format: <em>[device model]-[serial number]<\/em>.<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<\/li>\n<\/ul>\n<ul>\n<li>\n<p>The  <a href=\"https:\/\/docs.adyen.com\/api-explorer\/terminal-api\/latest\/post\/storedvalue#request-SaleData\" class=\"codeLabel  external-link no-image\" target=\"_blank\" rel=\"nofollow noopener noreferrer\">StoredValueRequest.SaleData<\/a> object with:<\/p>\n<table>\n<thead>\n<tr>\n<th style=\"text-align: left;\">Parameter<\/th>\n<th style=\"text-align: center;\">Required<\/th>\n<th style=\"text-align: left;\">Description<\/th>\n<\/tr>\n<\/thead>\n<tbody>\n<tr>\n<td style=\"text-align: left;\"><code>SaleTransactionID.TransactionID<\/code><\/td>\n<td style=\"text-align: center;\"><img title=\"-white_check_mark-\" alt=\"-white_check_mark-\" class=\"smileys\" src=\"\/user\/data\/smileys\/emoji\/white_check_mark.png\" \/><\/td>\n<td style=\"text-align: left;\">Your reference to identify this deactivation request. We recommend using a unique value.<\/td>\n<\/tr>\n<tr>\n<td style=\"text-align: left;\"><code>SaleTransactionID.TimeStamp<\/code><\/td>\n<td style=\"text-align: center;\"><img title=\"-white_check_mark-\" alt=\"-white_check_mark-\" class=\"smileys\" src=\"\/user\/data\/smileys\/emoji\/white_check_mark.png\" \/><\/td>\n<td style=\"text-align: left;\">Date and time of the request, in <a href=\"https:\/\/en.wikipedia.org\/wiki\/ISO_8601#Coordinated_Universal_Time_(UTC)\" target=\"_blank\" rel=\"nofollow noopener noreferrer\" class=\"external-link no-image\">UTC format<\/a>.<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<\/li>\n<li>\n<p>The  <a href=\"https:\/\/docs.adyen.com\/api-explorer\/terminal-api\/latest\/post\/storedvalue#request-StoredValueData\" class=\"codeLabel  external-link no-image\" target=\"_blank\" rel=\"nofollow noopener noreferrer\">StoredValueRequest.StoredValueData<\/a> object with:<\/p>\n<table>\n<thead>\n<tr>\n<th style=\"text-align: left;\">Parameter<\/th>\n<th style=\"text-align: center;\">Required<\/th>\n<th style=\"text-align: left;\">Description<\/th>\n<\/tr>\n<\/thead>\n<tbody>\n<tr>\n<td style=\"text-align: left;\"><code>StoredValueTransactionType<\/code><\/td>\n<td style=\"text-align: center;\"><\/td>\n<td style=\"text-align: left;\"><span translate=\"no\"><strong>Unload<\/strong><\/span><\/td>\n<\/tr>\n<tr>\n<td style=\"text-align: left;\"><code>StoredValue.StoredValueAccountID<\/code><\/td>\n<td style=\"text-align: center;\"><\/td>\n<td style=\"text-align: left;\">The gift card details: <ul> <li markdown=\"1\"><code>StoredValueAccountType<\/code>: <span translate=\"no\"><strong>GiftCard<\/strong><\/span><\/li> <li markdown=\"1\"><code>StoredValueProvider<\/code>: the gift card issuer: <span translate=\"no\"><strong>givex<\/strong><\/span>, <span translate=\"no\"><strong>svs<\/strong><\/span>, or <span translate=\"no\"><strong>valuelink<\/strong><\/span>.<\/li> <li markdown=\"1\"><code>IdentificationType<\/code>: <span translate=\"no\"><strong>PAN<\/strong><\/span><\/li> <li markdown=\"1\"><code>ItemAmount<\/code>: <strong>0<\/strong><\/li> <li markdown=\"1\"><code>Currency<\/code>: currency of the gift card.<\/li> <li markdown=\"1\"><code>EntryMode<\/code>, <code>StoredValueID<\/code> and <code>ExpiryDate<\/code>: these parameters depend on the <a href=\"\/point-of-sale\/gift-cards-terminal-api#card-entry\">card entry method<\/a> you are using.<\/li><\/ul><\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<table>\n<thead>\n<tr>\n<th style=\"text-align: left;\">Card entry<\/th>\n<th style=\"text-align: left;\">Parameters<\/th>\n<\/tr>\n<\/thead>\n<tbody>\n<tr>\n<td style=\"text-align: left;\">Scan<\/td>\n<td style=\"text-align: left;\"><ul><li markdown=\"1\"><code>EntryMode<\/code>: <span translate=\"no\"><strong>Scanned<\/strong><\/span><\/li><li markdown=\"1\"><code>StoredValueID<\/code>: gift card number.<\/li><li markdown=\"1\"><code>ExpiryDate<\/code>: expiry date of the gift card.<\/li><\/ul><\/td>\n<\/tr>\n<tr>\n<td style=\"text-align: left;\">Swipe<\/td>\n<td style=\"text-align: left;\"><ul><li markdown=\"1\"><code>EntryMode<\/code>: <span translate=\"no\"><strong>MagStripe<\/strong><\/span><\/li><\/td>\n<\/tr>\n<tr>\n<td style=\"text-align: left;\">MKE<\/td>\n<td style=\"text-align: left;\"><ul><li markdown=\"1\"><code>EntryMode<\/code>: <span translate=\"no\"><strong>Keyed<\/strong><\/span><\/li><li markdown=\"1\"><code>StoredValueID<\/code>: <span translate=\"no\"><strong>xxxxxxxxxxxxxxxxxxx<\/strong><\/span>.<\/li><\/ul><\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<\/li>\n<\/ul>\n<p>The example below shows how to deactivate of a scanned gift card.<\/p>\n<div data-component-wrapper=\"code-sample\">\n<code-sample :title=\"''\" :id=\"'deactivate_0'\" :code-data='[{\"language\":\"json\",\"tabTitle\":\"JSON\",\"content\":\"{\\n  \\\"SaleToPOIRequest\\\": {\\n    \\\"MessageHeader\\\": {\\n      \\\"ProtocolVersion\\\": \\\"3.0\\\",\\n      \\\"MessageClass\\\": \\\"Service\\\",\\n      \\\"MessageCategory\\\": \\\"StoredValue\\\",\\n      \\\"MessageType\\\": \\\"Request\\\",\\n      \\\"ServiceID\\\": \\\"9270\\\",\\n      \\\"SaleID\\\": \\\"POSSystemID12345\\\",\\n      \\\"POIID\\\": \\\"P400Plus-275008713\\\"\\n    },\\n    \\\"StoredValueRequest\\\": {\\n      \\\"SaleData\\\": {\\n        \\\"SaleTransactionID\\\": {\\n          \\\"TransactionID\\\": \\\"44743\\\",\\n          \\\"TimeStamp\\\": \\\"2019-05-17T14:13:03+00:00\\\"\\n        }\\n      },\\n      \\\"StoredValueData\\\": [\\n        {\\n          \\\"StoredValueTransactionType\\\": \\\"Unload\\\",\\n          \\\"StoredValueAccountID\\\": {\\n            \\\"StoredValueAccountType\\\": \\\"GiftCard\\\",\\n            \\\"StoredValueProvider\\\": \\\"givex\\\",\\n            \\\"IdentificationType\\\": \\\"PAN\\\",\\n            \\\"EntryMode\\\": [\\n              \\\"Scanned\\\"\\n            ],\\n            \\\"StoredValueID\\\": \\\"6006491260550218066\\\",\\n            \\\"ExpiryDate\\\": \\\"1122\\\"\\n          },\\n          \\\"ItemAmount\\\": 0,\\n          \\\"Currency\\\": \\\"GBP\\\"\\n        }\\n      ]\\n    }\\n  }\\n}\"},{\"language\":\"java\",\"tabTitle\":\"Java\",\"content\":\"String serviceID = \\\"YOUR_UNIQUE_ATTEMPT_ID\\\";\\nString saleID = \\\"YOUR_CASH_REGISTER_ID\\\";\\nString POIID = \\\"YOUR_TERMINAL_ID\\\";\\nString transactionID = \\\"YOUR_UNIQUE_TRANSACTION_ID\\\";\\n\\nSaleToPOIRequest saleToPOIRequest = new SaleToPOIRequest();\\nMessageHeader messageHeader = new MessageHeader();\\nmessageHeader.setProtocolVersion(\\\"3.0\\\");\\nmessageHeader.setMessageClass( MessageClassType.SERVICE );\\nmessageHeader.setMessageCategory( MessageCategoryType.STORED_VALUE );\\nmessageHeader.setMessageType( MessageType.REQUEST );\\nmessageHeader.setServiceID(serviceID);\\nmessageHeader.setSaleID(saleID);\\nmessageHeader.setPOIID(POIID);\\nsaleToPOIRequest.setMessageHeader(messageHeader);\\n\\nStoredValueRequest storedValueRequest = new StoredValueRequest();\\nSaleData saleData = new SaleData();\\nTransactionIdentification saleTransactionID = new TransactionIdentification();\\nsaleTransactionID.setTransactionID(transactionID);\\nsaleTransactionID.setTimeStamp(DatatypeFactory.newInstance().newXMLGregorianCalendar(new GregorianCalendar()));\\nsaleData.setSaleTransactionID(saleTransactionID);\\nstoredValueRequest.setSaleData(saleData);\\n\\nStoredValueData storedValueData = new StoredValueData();\\nstoredValueData.setStoredValueTransactionType( StoredValueTransactionType.UNLOAD );\\nStoredValueAccountID storedValueAccountID = new StoredValueAccountID();\\nstoredValueAccountID.setStoredValueAccountType( StoredValueAccountType.GIFT_CARD );\\nstoredValueAccountID.setStoredValueProvider(\\\"givex\\\");\\nstoredValueAccountID.setIdentificationType( IdentificationType.PAN );\\nstoredValueAccountID.getEntryMode().add( EntryModeType.SCANNED );\\nstoredValueAccountID.setStoredValueID(\\\"6006491260550218066\\\");\\nstoredValueAccountID.setExpiryDate(\\\"1122\\\");\\nstoredValueData.setStoredValueAccountID(storedValueAccountID);\\nstoredValueData.setItemAmount( BigDecimal.valueOf(0) );\\nstoredValueData.setCurrency(\\\"GBP\\\");\\nstoredValueRequest.setStoredValueData(storedValueData);\\nsaleToPOIRequest.setStoredValueRequest(storedValueRequest);\\nterminalAPIRequest.setSaleToPOIRequest(saleToPOIRequest);\"}]' :enable-copy-link-to-code-block=\"true\" :code-sample-card-size=\"'fullsize'\"><\/code-sample>\n<\/div>\n<\/li>\n<li>\n<p>In the  <a href=\"https:\/\/docs.adyen.com\/api-explorer\/terminal-api\/latest\/post\/storedvalue#responses-200-Response\" class=\"codeLabel  external-link no-image\" target=\"_blank\" rel=\"nofollow noopener noreferrer\">StoredValueResponse<\/a>, check the following:<\/p>\n<ul>\n<li><code>POIData.POITransactionID.TransactionID<\/code>: The <a href=\"\/point-of-sale\/design-your-integration\/terminal-api#transaction-identifier\">transaction identifier<\/a> for the deactivation.<\/li>\n<li><code>StoredValueResult.StoredValueTransactionType<\/code>: <span translate=\"no\"><strong>Unload<\/strong><\/span> and <code>Response.Result<\/code>: <span translate=\"no\"><strong>Success<\/strong><\/span> indicate that funds were loaded.<\/li>\n<li><code>StoredValueAccountStatus.CurrentBalance<\/code>: The current balance on the gift card, which is <strong>0<\/strong> because the card was deactivated.<\/li>\n<\/ul>\n<!-- list separator -->\n<p>The example below indicates that the deactivation request was successful, and card <strong>6006491260550218157<\/strong> was deactivated. This card now has a balance of GBP&nbsp;0.<\/p>\n<pre><code class=\"language-json\">{\n  \"SaleToPOIResponse\":{\n    \"StoredValueResponse\":{\n      \"POIData\":{\n        \"POITransactionID\":{\n          \"TimeStamp\":\"2019-05-17T14:13:03.000Z\",\n          \"TransactionID\":\"oLkO001526566383000.KHQC5N7G84BLNK43\"\n        }\n      },\n      ...\n      \"StoredValueResult\":[\n        {\n          \"StoredValueTransactionType\":\"Unload\",\n          \"ItemAmount\":0,\n          \"StoredValueAccountStatus\":{\n            \"StoredValueAccountID\":{\n              \"IdentificationType\":\"PAN\",\n              \"EntryMode\":[\n                \"MagStripe\"\n              ],\n              \"StoredValueID\":\"6006491260550218157\",\n              \"StoredValueAccountType\":\"GiftCard\",\n              \"ExpiryDate\":\"1122\"\n            },\n            \"CurrentBalance\":0\n          },\n          \"Currency\":\"GBP\"\n        }\n      ],\n      \"Response\":{\n        \"Result\":\"Success\",\n        \"AdditionalResponse\":\"...\"\n      }\n    },\n    \"MessageHeader\":{\n      \"ProtocolVersion\":\"3.0\",\n      \"SaleID\":\"POSSystemID12345\",\n      \"MessageClass\":\"Service\",\n      \"MessageCategory\":\"StoredValue\",\n      \"ServiceID\":\"9270\",\n      \"POIID\":\"V400m-324688179\",\n      \"MessageType\":\"Response\"\n    }\n  }\n}<\/code><\/pre>\n<\/li>\n<\/ol>\n<h2 id=\"see-also\">See also<\/h2>\n<div class=\"see-also-links output-inline\" id=\"see-also\">\n<ul><li><a href=\"\/point-of-sale\/gift-cards-terminal-api\"\n                        target=\"_self\"\n                        >\n                    Gift cards and other stored value cards\n                <\/a><\/li><li><a href=\"\/point-of-sale\/gift-cards-terminal-api\/activate\"\n                        target=\"_self\"\n                        >\n                    Activate a gift card\n                <\/a><\/li><li><a href=\"\/point-of-sale\/gift-cards-terminal-api\/load-a-balance\"\n                        target=\"_self\"\n                        >\n                    Check the balance of a gift card\n                <\/a><\/li><\/ul><\/div>\n","url":"https:\/\/docs.adyen.com\/point-of-sale\/alternative-payment-methods\/gift-cards-terminal-api\/deactivate","articleFields":{"description":"Disable or cash out a gift card at the point of sale.","id":"39949870","type":"page","_expandable":{"operations":""},"status":"current","last_edit_on":"01-10-2019 17:32","page_id":"2fb6c843-80d1-4244-b63b-8d95534dd9d3","feedback_component":true,"filters_component":false,"decision_tree":"[]"},"algolia":{"url":"https:\/\/docs.adyen.com\/point-of-sale\/alternative-payment-methods\/gift-cards-terminal-api\/deactivate","title":"Deactivate or cash out a gift card","content":"When the balance of a gift card has gone below a certain amount or when you suspect fraud, you can stop further use of the card. You can:\n\nMake a cashback request to take funds off the gift card and give this back to the shopper as cash. If you cash out the full remaining balance, the card is no longer active and cannot be used again.\nMake a deactivation request to disable the card without cashing it out.\n\nRequirements\nBefore you begin, take into account the following requirements, limitations, and preparations.\n\n\n\nRequirement\nDescription\n\n\n\n\nIntegration type\nA Terminal API integration with payment terminals.\n\n\nLimitations\nDeactivation is only supported for gift cards provided by Givex.\n\n\nSetup steps\nBefore you begin: Add the payment method to your Adyen account.Complete the onboarding process with the gift card provider.\n\n\n\nCash back a gift card\nYour options with a cashback request depend on the gift card provider, the scheme rules, and the applicable law. If cashbacks are allowed, you can normally only cash out the full amount remaining on the card. But if the gift card was provided by Givex, it is possible in some cases to give a cashback for a partial amount.\nThe funds taken off the gift card can be given back to the shopper in cash, or transferred to their credit or debit card by making an unreferenced refund.\nTo make a gift card cashback request:\n\n\nDetermine the card entry method:\n\nIf you want to scan the card, do that first and use the obtained card details in your request.\nIf you want to swipe the card or use manual keyed entry (MKE), send the request first. The payment terminal will show a prompt to swipe the card or enter the card details.\n\n\n\nCheck the balance remaining on the gift card.\n\n\nMake a payment request, specifying:\n\n\nThe standard \n  SaleToPOIRequest.MessageHeader\n object, with MessageClass set to Service and MessageCategory set to Payment.\n\n\n\nParameter\nRequired\nDescription\n\n\n\n\nProtocolVersion\n\n3.0\n\n\nMessageClass\n\nService\n\n\nMessageCategory\n\nPayment\n\n\nMessageType\n\nRequest\n\n\nServiceID\n\nYour unique ID for this request, consisting of 1-10 alphanumeric characters. Must be unique within the last 48 hours for the terminal (POIID) being used.\n\n\nSaleID\n\nYour unique ID for the POS system component to send this request from.\n\n\nPOIID\n\nThe unique ID of the terminal to send this request to. Format: [device model]-[serial number].\n\n\n\n\n\n\n\nThe  SaleData object with:\n\n\n\nParameter\nRequired\nDescription\n\n\n\n\nSaleTransactionID.TransactionID\n\nYour reference to identify this cashback request. We recommend using a unique value.\n\n\nSaleTransactionID.TimeStamp\n\nDate and time of the cashback request, in UTC format.\n\n\nSaleReferenceID\n\nOptional parameter to provide your order number. You can use this to connect different gift card transactions to the same order. In the Customer Area, it will appear as the Merchant Order for the transaction.\n\n\nSaleToAcquirerData\n\nredemptionType=cashback\n\n\n\n\nIn SaleData.SaleToAcquirerData, specify the tender option in one of the following formats:\n\n\nOption 1: a JSON object converted to a Base64 encoded string.\nEncode {\"redemptionType\": \"cashback\"} to Base64, and pass the resulting string:\n\"SaleToAcquirerData\": \"eyJyZWRlbXB0aW9uVHlwZSI6ICJjYXNoYmFjayJ9\"\n\n\nOption 2: a key-value pair:\n\"SaleToAcquirerData\": \"redemptionType=cashback\"\n\n\nThe format that you use here will also be the format of the AdditionalResponse that you receive. If there are more tender options (for example, ReceiptHandler ) or other data elements that you need to pass in the SaleToAcquirerData field, refer to Add information to a payment.\n\n\n\nThe  PaymentTransaction object with:\n\n\n\nParameter\nRequired\nDescription\n\n\n\n\nAmountsReq\n\nThe Currency and RequestedAmount being given back to the shopper.\n\n\n\n\n\nThe  PaymentData object with:\n\n\n\nParameter\nRequired\nDescription\n\n\n\n\nPaymentType\n\nNormal\n\n\nPaymentInstrumentData.PaymentInstrumentType\n\nStoredValue\n\n\nPaymentInstrumentData.StoredValueAccountID\n\nThe gift card details:  StoredValueAccountType: GiftCard StoredValueProvider: the gift card issuer: givex, svs, valuelink, or any Intersolve-supported card type. IdentificationType: PAN EntryMode, StoredValueID and ExpiryDate: these parameters depend on the card entry method you are using. See the table below. \n\n\n\n\n\n\nCard entry\nParameters\n\n\n\n\nScan\nEntryMode: ScannedStoredValueID: gift card number.ExpiryDate: expiry date of the gift card.\n\n\nSwipe\nEntryMode: MagStripeStoredValueID: include this parameter but do not provide a value.\n\n\nMKE\nEntryMode: KeyedStoredValueID: include this parameter but do not provide a value.\n\n\n\n\n\nThe example below shows how to initiate a GBP&nbsp;4.50 cashback request for a scanned gift card.\n\n\n\nThe cashback request is sent to the Adyen payments platform for processing. Once processed, your integration receives the cashback result.\n\n\nIn the  PaymentResponse, check the following:\n\nPOIData.POITransactionID.TransactionID: The transaction identifier for the cashback.\nPaymentReceipt: An object containing data you can use to generate a receipt.\nResponse.Result: Success\n\nThe example below indicates that the cashback request was successful, and GBP&nbsp;4.50 was removed from the balance of the gift card.\n{\n    \"SaleToPOIResponse\":{\n        \"PaymentResponse\":{\n            \"POIData\":{\n                \"POITransactionID\":{\n                    \"TimeStamp\":\"2019-06-22T12:55:24.000Z\",\n                    \"TransactionID\":\"u6W7001529672124004.NC6HT9CRT65ZGN82\"\n                }\n            },\n            \"SaleData\":{\n                \"SaleTransactionID\":{\n                    \"TimeStamp\":\"2019-06-22T12:55:20.000Z\",\n                    \"TransactionID\":\"44742\"\n                },\n                \"SaleReferenceID\":\"YOUR_ORDER_REFERENCE\"\n            },\n            \"PaymentReceipt\":[...],\n            \"PaymentResult\":{\n                \"PaymentAcquirerData\":{\n                    \"AcquirerPOIID\":\"V400m-324688179\",\n                    \"AcquirerTransactionID\":{\n                        \"TimeStamp\":\"2019-06-22T12:55:24.000Z\",\n                        \"TransactionID\":\"NC6HT9CRT65ZGN82\"\n                    },\n                    \"MerchantID\":\"TestMerchantPOS\"\n                },\n                \"PaymentInstrumentData\":{\n                    \"StoredValueAccountID\":{\n                        \"IdentificationType\":\"PAN\",\n                        \"EntryMode\":[\n                            \"MagStripe\"\n                        ],\n                        \"StoredValueID\":\"9826150911219687\",\n                        \"StoredValueAccountType\":\"GiftCard\",\n                        \"StoredValueProvider\":\"svs\",\n                        \"ExpiryDate\":\"1122\"\n                    },\n                    \"PaymentInstrumentType\":\"StoredValue\"\n                },\n                \"AmountsResp\":{\n                    \"AuthorizedAmount\":4.50,\n                    \"Currency\":\"GBP\"\n                },\n                \"PaymentType\":\"Normal\"\n            },\n            \"Response\":{\n                \"Result\":\"Success\",\n                \"AdditionalResponse\":\"...\"\n            }\n        },\n        \"MessageHeader\":{\n            \"ProtocolVersion\":\"3.0\",\n            \"SaleID\":\"POSTerminal\",\n            \"MessageClass\":\"Service\",\n            \"MessageCategory\":\"Payment\",\n            \"ServiceID\":\"9269\",\n            \"POIID\":\"V400m-324688179\",\n            \"MessageType\":\"Response\"\n        }\n    }\n}\n\n\nDeactivate a gift card\nIf the gift card was issued by Givex, you can make a deactivation request to disable the card.\nTo make a deactivation request:\n\n\nDetermine the card entry method:\n\nIf you want to scan the card, do that first and use the obtained card details in your request.\nIf you want to swipe the card or use manual keyed entry (MKE), send the request first. The payment terminal will show a prompt to swipe the card or enter the card details.\n\n\n\nMake a Terminal API stored value request, specifying:\n\n\nThe standard \n  SaleToPOIRequest.MessageHeader\n object, with MessageClass set to Service and MessageCategory set to StoredValue.\n\n\n\nParameter\nRequired\nDescription\n\n\n\n\nProtocolVersion\n\n3.0\n\n\nMessageClass\n\nService\n\n\nMessageCategory\n\nStoredValue\n\n\nMessageType\n\nRequest\n\n\nServiceID\n\nYour unique ID for this request, consisting of 1-10 alphanumeric characters. Must be unique within the last 48 hours for the terminal (POIID) being used.\n\n\nSaleID\n\nYour unique ID for the POS system component to send this request from.\n\n\nPOIID\n\nThe unique ID of the terminal to send this request to. Format: [device model]-[serial number].\n\n\n\n\n\n\n\nThe  StoredValueRequest.SaleData object with:\n\n\n\nParameter\nRequired\nDescription\n\n\n\n\nSaleTransactionID.TransactionID\n\nYour reference to identify this deactivation request. We recommend using a unique value.\n\n\nSaleTransactionID.TimeStamp\n\nDate and time of the request, in UTC format.\n\n\n\n\n\nThe  StoredValueRequest.StoredValueData object with:\n\n\n\nParameter\nRequired\nDescription\n\n\n\n\nStoredValueTransactionType\n\nUnload\n\n\nStoredValue.StoredValueAccountID\n\nThe gift card details:  StoredValueAccountType: GiftCard StoredValueProvider: the gift card issuer: givex, svs, or valuelink. IdentificationType: PAN ItemAmount: 0 Currency: currency of the gift card. EntryMode, StoredValueID and ExpiryDate: these parameters depend on the card entry method you are using.\n\n\n\n\n\n\nCard entry\nParameters\n\n\n\n\nScan\nEntryMode: ScannedStoredValueID: gift card number.ExpiryDate: expiry date of the gift card.\n\n\nSwipe\nEntryMode: MagStripe\n\n\nMKE\nEntryMode: KeyedStoredValueID: xxxxxxxxxxxxxxxxxxx.\n\n\n\n\n\nThe example below shows how to deactivate of a scanned gift card.\n\n\n\n\n\nIn the  StoredValueResponse, check the following:\n\nPOIData.POITransactionID.TransactionID: The transaction identifier for the deactivation.\nStoredValueResult.StoredValueTransactionType: Unload and Response.Result: Success indicate that funds were loaded.\nStoredValueAccountStatus.CurrentBalance: The current balance on the gift card, which is 0 because the card was deactivated.\n\n\nThe example below indicates that the deactivation request was successful, and card 6006491260550218157 was deactivated. This card now has a balance of GBP&nbsp;0.\n{\n  \"SaleToPOIResponse\":{\n    \"StoredValueResponse\":{\n      \"POIData\":{\n        \"POITransactionID\":{\n          \"TimeStamp\":\"2019-05-17T14:13:03.000Z\",\n          \"TransactionID\":\"oLkO001526566383000.KHQC5N7G84BLNK43\"\n        }\n      },\n      ...\n      \"StoredValueResult\":[\n        {\n          \"StoredValueTransactionType\":\"Unload\",\n          \"ItemAmount\":0,\n          \"StoredValueAccountStatus\":{\n            \"StoredValueAccountID\":{\n              \"IdentificationType\":\"PAN\",\n              \"EntryMode\":[\n                \"MagStripe\"\n              ],\n              \"StoredValueID\":\"6006491260550218157\",\n              \"StoredValueAccountType\":\"GiftCard\",\n              \"ExpiryDate\":\"1122\"\n            },\n            \"CurrentBalance\":0\n          },\n          \"Currency\":\"GBP\"\n        }\n      ],\n      \"Response\":{\n        \"Result\":\"Success\",\n        \"AdditionalResponse\":\"...\"\n      }\n    },\n    \"MessageHeader\":{\n      \"ProtocolVersion\":\"3.0\",\n      \"SaleID\":\"POSSystemID12345\",\n      \"MessageClass\":\"Service\",\n      \"MessageCategory\":\"StoredValue\",\n      \"ServiceID\":\"9270\",\n      \"POIID\":\"V400m-324688179\",\n      \"MessageType\":\"Response\"\n    }\n  }\n}\n\n\nSee also\n\n\n                    Gift cards and other stored value cards\n                \n                    Activate a gift card\n                \n                    Check the balance of a gift card\n                \n","type":"page","locale":"en","boost":16,"hierarchy":{"lvl0":"Home","lvl1":"In-person payments","lvl2":"Alternative payment methods","lvl3":"Gift cards and other stored value cards","lvl4":"Deactivate or cash out a gift card"},"hierarchy_url":{"lvl0":"https:\/\/docs.adyen.com\/","lvl1":"https:\/\/docs.adyen.com\/point-of-sale","lvl2":"https:\/\/docs.adyen.com\/point-of-sale\/alternative-payment-methods","lvl3":"https:\/\/docs.adyen.com\/point-of-sale\/alternative-payment-methods\/gift-cards-terminal-api","lvl4":"\/point-of-sale\/alternative-payment-methods\/gift-cards-terminal-api\/deactivate"},"levels":5,"category":"In-person payments","category_color":"green","tags":["Deactivate"]},"articleFiles":{"cashback-and-cash-out-gift-cards_0.json":"<p alt=\"\">cashback-and-cash-out-gift-cards_0.json<\/p>","deactivate_0.json":"<p alt=\"\">deactivate_0.json<\/p>"}}