{"title":"Start gift card transactions","category":"default","creationDate":1776961627,"content":"<h2 id=\"peddevice-object\">PedDevice Object<\/h2>\n<table>\n<thead>\n<tr>\n<th>Name<\/th>\n<th>Description<\/th>\n<\/tr>\n<\/thead>\n<tbody>\n<tr>\n<td><code>PedDevice<\/code><\/td>\n<td>PED object that represents the terminal.<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<h2 id=\"create-a-special-tender-request\">Create a special tender request<\/h2>\n<table style=\"width:100%;\"><colgroup><col style=\"width: 25%\"><col style=\"width: 74%\"><\/colgroup><thead><tr class=\"header\"><th>Name<\/th><th>Description<\/th><\/tr><\/thead><tbody><tr><td>\n<p><code>CreateSpecialTenderRequest<\/code><\/p>\n<\/td><td>\n<p>Use this method to create a request object to hold the special tender details. Instantiates an <code>Adyen.SpecialTenderRequest<\/code>\u00a0object.<\/p>\n<\/td><\/tr><\/tbody><\/table>\n<h2 id=\"adding-parameters-to-a-specialtenderrequest\">Adding Parameters to a\u00a0SpecialTenderRequest<\/h2>\n<h3 id=\"parameters\">Parameters<\/h3>\n<table style=\"width:100%;\"><colgroup><col style=\"width: 13%\"><col style=\"width: 6%\"><col style=\"width: 9%\"><col style=\"width: 70%\"><\/colgroup><thead><tr class=\"header\"><th><p>Key<\/p><\/th><th><p>Type<\/p><\/th><th><p>Required<\/p><\/th><th><p>Description<\/p><\/th><\/tr><\/thead><tbody><tr><td>\n<p><code>merchantAccount<\/code><\/p>\n<\/td><td>\n<p>String<\/p>\n<\/td><td>\n<p><img title=\"-white_check_mark-\" alt=\"-white_check_mark-\" class=\"smileys\" src=\"\/user\/data\/smileys\/emoji\/white_check_mark.png\" \/><\/p>\n<\/td><td>\n<p>The transaction reference provided by the Merchant (reported in the plataforma de pagamentos da Adyen).<\/p>\n<\/td><\/tr><tr><td>\n<p><code>amountValue<\/code><\/p>\n<\/td><td>\n<p>String<\/p>\n<\/td><td>\n<p><img title=\"-white_check_mark-\" alt=\"-white_check_mark-\" class=\"smileys\" src=\"\/user\/data\/smileys\/emoji\/white_check_mark.png\" \/><\/p>\n<\/td><td>\n<p>The transaction amount in minor units (100 is 1.00 with EUR). The Amount field should be a strong typed field with a string for currency code and a number (long) for the minor digits value (similar to the current API (of the terminal)).<\/p>\n<\/td><\/tr><tr><td>\n<p><code>amountCurrency<\/code><\/p>\n<\/td><td>\n<p>long<\/p>\n<\/td><td>\n<p><img title=\"-white_check_mark-\" alt=\"-white_check_mark-\" class=\"smileys\" src=\"\/user\/data\/smileys\/emoji\/white_check_mark.png\" \/><\/p>\n<\/td><td>\n<p>The transaction currency.<\/p>\n<\/td><\/tr><tr><td>\n<p><code>transactionType<\/code><\/p>\n<\/td><td>\n<p>String<\/p>\n<\/td><td>\n<p><img title=\"-white_check_mark-\" alt=\"-white_check_mark-\" class=\"smileys\" src=\"\/user\/data\/smileys\/emoji\/white_check_mark.png\" \/><\/p>\n<\/td><td>\n<p>Type of gift card transaction (Redeem, which uses a card balance to pay for an item, Load, which loads a balance to a card, and Balance Inquiry which returns the current balance of the card). <code>TransactionType<\/code> takes the following values:<ul><li markdown=\"1\">redeem<\/li><li markdown=\"1\">load<\/li><li markdown=\"1\">balanceInquiry<\/li><\/ul><\/p>\n<\/td><\/tr><tr><td>\n<p><code>paymentMethodType<\/code><\/p>\n<\/td><td>\n<p>String<\/p>\n<\/td><td>\n<p><img title=\"-white_check_mark-\" alt=\"-white_check_mark-\" class=\"smileys\" src=\"\/user\/data\/smileys\/emoji\/white_check_mark.png\" \/><\/p>\n<\/td><td>\n<p>The type of payment method, in this case gift cards. For example, Givex, SVS, EagleEye. <code>PaymentMethodType<\/code> takes the following values:<ul><li markdown=\"1\">givex<\/li><li markdown=\"1\">svs<\/li><\/ul><\/p>\n<\/td><\/tr><tr><td>\n<p><code>specialOptions<\/code><\/p>\n<\/td><td>\n<p>SpecialTenderOptions<\/p>\n<\/td><td>\n<p><img title=\"-x-\" alt=\"-x-\" class=\"smileys\" src=\"\/user\/data\/smileys\/emoji\/x.png\" \/><\/p>\n<\/td><td>\n<p>Holds tender attributes.Activate, load, or refund a balance to a card by creating a special tender and passing the following values as the <code>loadType<\/code> in special options:<\/p>\n<ul>\n<li><strong>activate<\/strong> - Activates a gift card.<\/li>\n<li><strong>load<\/strong> - Adds a balance to a gift card.<\/li>\n<li><strong>merchandise_return<\/strong> -\u00a0Add a refund balance back on to a gift card. This uses the same functionally as a load but is separated for accounting purposes.<\/li>\n<\/ul>\n<div class=\"sc-notice info\"><div>\n<p>The activate and load values can be piped to chain the tasks by passing \"<strong>activate|load<\/strong>\".<\/p>\n<p><\/div><\/div>Perform a cash back or deactivate a card by creating a special tender and passing a <code>redemptionType<\/code>\u00a0as a special option.\u00a0<\/p>\n<ul>\n<li>\n<p><strong>cashback -<\/strong> Cash out the value of a gift card. For SVS, you must create a zero-value transaction to cash out the entire balance of a card. You can not cash out a specific amount.<\/p>\n<\/li>\n<li>\n<p><strong>deactivate\u00a0<\/strong>- Deactivates a gift card.\u00a0\u00a0(Deactivate is not available for SVS).<\/p>\n<\/li>\n<li>\n<p><strong>gratuity<\/strong> - Used to provide a tip from a gift card. (For SVS cards only).<\/p>\n<\/li>\n<\/ul>\n<div class=\"sc-notice info\"><div>\n<p>The cashback and deactivate values can be piped to chain the tasks by passing\u00a0 \"<strong>cashback|deactivate<\/strong>\".<\/p>\n<\/div><\/div>\n<\/td><\/tr><tr><td>\n<p><code>handleReceipt<\/code><\/p>\n<\/td><td>\n<p>Boolean<\/p>\n<\/td><td>\n<p><img title=\"-x-\" alt=\"-x-\" class=\"smileys\" src=\"\/user\/data\/smileys\/emoji\/x.png\" \/><\/p>\n<\/td><td>\n<p>Specifies that the POS handles and prints receipts. If omitted, it is required that the PED prints the receipt. If there is no printer unit, the transaction will fail.<\/p>\n<\/td><\/tr><\/tbody><\/table>\n<p>Add special options parameters to the\u00a0<code>SpecialTenderRequest<\/code>\u00a0using the\u00a0<code>SpecialOptions.Add<\/code>\u00a0method.\u00a0<\/p>\n<p>Remove parameters from the\u00a0<code>SpecialTenderRequest<\/code>\u00a0using the\u00a0<code>SpecialOptions.Rm<\/code>\u00a0method.\u00a0<\/p>\n<table><thead><tr class=\"header\"><th>Name<\/th><th>Type<\/th><th>Required<\/th><th>Description<\/th><\/tr><\/thead><tbody><tr><td>\n<p><code>cardNumber<\/code><\/p>\n<\/td><td>\n<p>String<\/p>\n<\/td><td>\n<p><img title=\"-x-\" alt=\"-x-\" class=\"smileys\" src=\"\/user\/data\/smileys\/emoji\/x.png\" \/><\/p>\n<\/td><td>\n<p>The scanned number from the gift card. If this number:<ul><li markdown=\"1\">Is passed from the POS, Keyed Entry will not be triggered on the PED.<\/li><li markdown=\"1\">Is not passed from the POS Keyed Entry will be triggered on the PED.<\/li><\/ul><\/p>\n<\/td><\/tr><tr><td>\n<p><code>forceEntryMode<\/code><\/p>\n<\/td><td>\n<p>String<\/p>\n<\/td><td>\n<p><img title=\"-white_check_mark-\" alt=\"-white_check_mark-\" class=\"smileys\" src=\"\/user\/data\/smileys\/emoji\/white_check_mark.png\" \/><\/p>\n<\/td><td>\n<p>The entry mode for the transaction.You can select from two entry modes:<ul><li markdown=\"1\">Keyed - on the PED or POS<\/li><li markdown=\"1\">Magstripe - Use the magnetic stripe from the card<\/li><\/ul><\/p>\n<\/td><\/tr><\/tbody><\/table>\n<div class=\"sc-notice note\"><div>\n<p>Not all languages using COM handle empty parameters equally. This has the potential to cause unexpected behavior. To prevent this, provide empty strings or pass <code>Null<\/code> objects for C++\/C#, and the default value <code>Nothing<\/code> for vb.net.<\/p>\n<\/div><\/div>\n<h3 id=\"code-example\">Code example<\/h3>\n<pre><code class=\"language-vb\">specialTenderRequest.SpecialOptions.Add(\"cardNumber\", \"60362821657200117610\")\nspecialTenderRequest.SpecialOptions.Add(\"cardNumber.expiryMonth\", \"12\")\nspecialTenderRequest.SpecialOptions.Add(\"cardNumber.expiryYear\", \"2049\")<\/code><\/pre>\n<h2 id=\"create-a-special-tender\">Create a special tender<\/h2>\n<table style=\"width:100%;\"><colgroup><col style=\"width: 25%\"><col style=\"width: 74%\"><\/colgroup><thead><tr class=\"header\"><th>Name<\/th><th>Description<\/th><\/tr><\/thead><tbody><tr><td>\n<p><code>CreateSpecialTender<\/code><\/p>\n<\/td><td>\n<p>Use this method to create a special tender and pass the <code>Adyen.SpecialTenderRequest<\/code>\u00a0object.<\/p>\n<\/td><\/tr><\/tbody><\/table>\n<h2 id=\"entry-modes\">Entry modes<\/h2>\n<p>The gift card can be presented in three ways:\u00a0<\/p>\n<ol>\n<li>Swipe: the gift card is read using a magnetic stripe reader.<\/li>\n<li>MKE on terminal: the card number is manually entered on the payment terminal. The tender should specify that it expects keyed entry on the terminal, and a card mask should be provided.<\/li>\n<li>MKE on POS app: scan a barcode on the back of the card from the POS app. In this scenario, the card number, card mask, and expiry should be provided in special options.<\/li>\n<\/ol>\n<p>You can specify entry modes by passing special tender options. See\u00a0<a href=\"\/pt\/point-of-sale\/gift-cards-terminal-api\">Gift Cards<\/a>.\u00a0<\/p>\n<h2 id=\"callbacks\">Callbacks<\/h2>\n<table><colgroup><col style=\"width: 22%\"><col style=\"width: 77%\"><\/colgroup><thead><tr class=\"header\"><th><p>Name<\/p><\/th><th>Description<\/th><\/tr><\/thead><tbody><tr><td>\n<p><a href=\"\/point-of-sale\/classic-library-deprecation\/classic-library-integrations\/com-extension-for-windows-integration\/key-steps-com-extension\/process-a-basic-transaction-com-extension\/handle-progress-events-com-extension\">Progress Event Callback<\/a><\/p>\n<\/td><td>\n<p>Reports the progress of a running tender.<\/p>\n<\/td><\/tr><tr><td>\n<p><a href=\"\/point-of-sale\/classic-library-deprecation\/classic-library-integrations\/com-extension-for-windows-integration\/key-steps-com-extension\/process-a-basic-transaction-com-extension\/handle-the-print-receipt-callback-com-extension\">PrintReceipt Callback<\/a><\/p>\n<\/td><td>\n<p>Returns the receipt for printing, and requests that the POS confirms it has received the receipt.<\/p>\n<\/td><\/tr><tr><td>\n<p><a href=\"\/point-of-sale\/classic-library-deprecation\/classic-library-integrations\/com-extension-for-windows-integration\/key-steps-com-extension\/process-a-basic-transaction-com-extension\/handle-the-final-state-callback-com-extension\">Final Callback<\/a><\/p>\n<\/td><td>\n<p>When the system finishes processing the tender, it triggers the final state callback.<\/p>\n<\/td><\/tr><\/tbody><\/table>","url":"https:\/\/docs.adyen.com\/pt\/point-of-sale\/classic-library-deprecation\/classic-library-integrations\/com-extension-for-windows-integration\/extras-com-extension\/start-gift-card-transactions-com-extension","articleFields":{"id":"28871494","type":"page","_expandable":{"operations":""},"status":"current"},"algolia":{"url":"https:\/\/docs.adyen.com\/pt\/point-of-sale\/classic-library-deprecation\/classic-library-integrations\/com-extension-for-windows-integration\/extras-com-extension\/start-gift-card-transactions-com-extension","title":"Start gift card transactions","content":"PedDevice Object\n\n\n\nName\nDescription\n\n\n\n\nPedDevice\nPED object that represents the terminal.\n\n\n\nCreate a special tender request\nNameDescription\nCreateSpecialTenderRequest\n\nUse this method to create a request object to hold the special tender details. Instantiates an Adyen.SpecialTenderRequest\u00a0object.\n\nAdding Parameters to a\u00a0SpecialTenderRequest\nParameters\nKeyTypeRequiredDescription\nmerchantAccount\n\nString\n\n\n\nThe transaction reference provided by the Merchant (reported in the plataforma de pagamentos da Adyen).\n\namountValue\n\nString\n\n\n\nThe transaction amount in minor units (100 is 1.00 with EUR). The Amount field should be a strong typed field with a string for currency code and a number (long) for the minor digits value (similar to the current API (of the terminal)).\n\namountCurrency\n\nlong\n\n\n\nThe transaction currency.\n\ntransactionType\n\nString\n\n\n\nType of gift card transaction (Redeem, which uses a card balance to pay for an item, Load, which loads a balance to a card, and Balance Inquiry which returns the current balance of the card). TransactionType takes the following values:redeemloadbalanceInquiry\n\npaymentMethodType\n\nString\n\n\n\nThe type of payment method, in this case gift cards. For example, Givex, SVS, EagleEye. PaymentMethodType takes the following values:givexsvs\n\nspecialOptions\n\nSpecialTenderOptions\n\n\n\nHolds tender attributes.Activate, load, or refund a balance to a card by creating a special tender and passing the following values as the loadType in special options:\n\nactivate - Activates a gift card.\nload - Adds a balance to a gift card.\nmerchandise_return -\u00a0Add a refund balance back on to a gift card. This uses the same functionally as a load but is separated for accounting purposes.\n\n\nThe activate and load values can be piped to chain the tasks by passing \"activate|load\".\nPerform a cash back or deactivate a card by creating a special tender and passing a redemptionType\u00a0as a special option.\u00a0\n\n\ncashback - Cash out the value of a gift card. For SVS, you must create a zero-value transaction to cash out the entire balance of a card. You can not cash out a specific amount.\n\n\ndeactivate\u00a0- Deactivates a gift card.\u00a0\u00a0(Deactivate is not available for SVS).\n\n\ngratuity - Used to provide a tip from a gift card. (For SVS cards only).\n\n\n\nThe cashback and deactivate values can be piped to chain the tasks by passing\u00a0 \"cashback|deactivate\".\n\n\nhandleReceipt\n\nBoolean\n\n\n\nSpecifies that the POS handles and prints receipts. If omitted, it is required that the PED prints the receipt. If there is no printer unit, the transaction will fail.\n\nAdd special options parameters to the\u00a0SpecialTenderRequest\u00a0using the\u00a0SpecialOptions.Add\u00a0method.\u00a0\nRemove parameters from the\u00a0SpecialTenderRequest\u00a0using the\u00a0SpecialOptions.Rm\u00a0method.\u00a0\nNameTypeRequiredDescription\ncardNumber\n\nString\n\n\n\nThe scanned number from the gift card. If this number:Is passed from the POS, Keyed Entry will not be triggered on the PED.Is not passed from the POS Keyed Entry will be triggered on the PED.\n\nforceEntryMode\n\nString\n\n\n\nThe entry mode for the transaction.You can select from two entry modes:Keyed - on the PED or POSMagstripe - Use the magnetic stripe from the card\n\n\nNot all languages using COM handle empty parameters equally. This has the potential to cause unexpected behavior. To prevent this, provide empty strings or pass Null objects for C++\/C#, and the default value Nothing for vb.net.\n\nCode example\nspecialTenderRequest.SpecialOptions.Add(\"cardNumber\", \"60362821657200117610\")\nspecialTenderRequest.SpecialOptions.Add(\"cardNumber.expiryMonth\", \"12\")\nspecialTenderRequest.SpecialOptions.Add(\"cardNumber.expiryYear\", \"2049\")\nCreate a special tender\nNameDescription\nCreateSpecialTender\n\nUse this method to create a special tender and pass the Adyen.SpecialTenderRequest\u00a0object.\n\nEntry modes\nThe gift card can be presented in three ways:\u00a0\n\nSwipe: the gift card is read using a magnetic stripe reader.\nMKE on terminal: the card number is manually entered on the payment terminal. The tender should specify that it expects keyed entry on the terminal, and a card mask should be provided.\nMKE on POS app: scan a barcode on the back of the card from the POS app. In this scenario, the card number, card mask, and expiry should be provided in special options.\n\nYou can specify entry modes by passing special tender options. See\u00a0Gift Cards.\u00a0\nCallbacks\nNameDescription\nProgress Event Callback\n\nReports the progress of a running tender.\n\nPrintReceipt Callback\n\nReturns the receipt for printing, and requests that the POS confirms it has received the receipt.\n\nFinal Callback\n\nWhen the system finishes processing the tender, it triggers the final state callback.\n","type":"page","locale":"pt","boost":14,"hierarchy":{"lvl0":"Home","lvl1":"Terminais","lvl2":"Deprecation of classic libraries","lvl3":"Library integrations","lvl4":"COM extension for Windows integration","lvl5":"Extras","lvl6":"Start gift card transactions"},"hierarchy_url":{"lvl0":"https:\/\/docs.adyen.com\/pt","lvl1":"https:\/\/docs.adyen.com\/pt\/point-of-sale","lvl2":"https:\/\/docs.adyen.com\/pt\/point-of-sale\/classic-library-deprecation","lvl3":"https:\/\/docs.adyen.com\/pt\/point-of-sale\/classic-library-deprecation\/classic-library-integrations","lvl4":"https:\/\/docs.adyen.com\/pt\/point-of-sale\/classic-library-deprecation\/classic-library-integrations\/com-extension-for-windows-integration","lvl5":"https:\/\/docs.adyen.com\/pt\/point-of-sale\/classic-library-deprecation\/classic-library-integrations\/com-extension-for-windows-integration\/extras-com-extension","lvl6":"\/pt\/point-of-sale\/classic-library-deprecation\/classic-library-integrations\/com-extension-for-windows-integration\/extras-com-extension\/start-gift-card-transactions-com-extension"},"levels":7,"category":"In-person payments","category_color":"green","tags":["Start","transactions"]}}