{"title":"card_operation_request","category":"default","creationDate":1776961627,"content":"<p>The\u00a0<code>card_operation_request<\/code>\u00a0contains the following data elements:<\/p>\n<table><thead><tr class=\"header\"><th>Field<\/th><th>Type<\/th><th>Required<\/th><th>Description<\/th><\/tr><\/thead><tbody><tr><td>\n<p><code>ped<\/code><\/p>\n<\/td><td>\n<p>void<\/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>if not specified the PED object will be automatically populated.<\/p>\n<\/td><\/tr><tr><td>\n<p><code>merchant_account<\/code><\/p>\n<\/td><td>\n<p>char<\/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 merchant account processing this transaction.\u00a0Transactions can be performed with any of the merchant accounts that were returned when registering the POS.<\/p>\n<\/td><\/tr><tr><td>\n<p><code>terminal_id<\/code><\/p>\n<\/td><td>\n<p>char<\/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\u00a0<code>terminal_id<\/code>\u00a0of the PED.<\/p>\n<\/td><\/tr><tr><td>\n<p><code>tender_reference<\/code><\/p>\n<\/td><td>\n<p>char<\/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>A reference to the tender provided by the PED.<\/p>\n<\/td><\/tr><tr><td>\n<p><code>card_type<\/code>\u00a0<\/p>\n<\/td><td>\n<p>char<\/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 type of gift card.<\/p>\n<\/td><\/tr><tr><td>\n<p><code>card_number<\/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 gift card number.<div class=\"sc-notice note\"><div><\/p>\n<p>Use of this parameter depends on selection of the <a href=\"\/pt\/point-of-sale\/classic-library-deprecation\/classic-library-integrations\/c-library-integration\/extras-c-library\/start-gift-card-transactions-c-library\/manual-keyed-entry-and-passing-of-card-details-c-library\">Manual Keyed Entry<\/a>\u00a0option.<\/p>\n<\/div><\/div>\n<\/td><\/tr><tr><td>\n<p><code>expiry_month<\/code><\/p>\n<\/td><td>\n<p>Long<\/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>Month of expiration.<div class=\"sc-notice note\"><div><\/p>\n<p>Use of this parameter depends on selection of the <a href=\"\/pt\/point-of-sale\/classic-library-deprecation\/classic-library-integrations\/c-library-integration\/extras-c-library\/start-gift-card-transactions-c-library\/manual-keyed-entry-and-passing-of-card-details-c-library\">Manual Keyed Entry<\/a>\u00a0option.<\/p>\n<\/div><\/div>\n<\/td><\/tr><tr><td>\n<p><code>expiry_year<\/code><\/p>\n<\/td><td>\n<p>Long<\/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>Year of expiration.<div class=\"sc-notice note\"><div><\/p>\n<p>Use of this parameter depends on selection of the <a href=\"\/pt\/point-of-sale\/classic-library-deprecation\/classic-library-integrations\/c-library-integration\/extras-c-library\/start-gift-card-transactions-c-library\/manual-keyed-entry-and-passing-of-card-details-c-library\">Manual Keyed Entry<\/a>\u00a0option.<\/p>\n<\/div><\/div>\n<\/td><\/tr><tr><td>\n<p><code>card_mask<\/code><\/p>\n<\/td><td>\n<p>char<\/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>A mask to validate the correct number of digits to enter.<div class=\"sc-notice note\"><div><\/p>\n<p>Use of this parameter depends on selection of the <a href=\"\/pt\/point-of-sale\/classic-library-deprecation\/classic-library-integrations\/c-library-integration\/extras-c-library\/start-gift-card-transactions-c-library\/manual-keyed-entry-and-passing-of-card-details-c-library\">Manual Keyed Entry<\/a>\u00a0option.<\/p>\n<\/div><\/div>\n<\/td><\/tr><tr><td>\n<p><code>card_mask_min<\/code><\/p>\n<\/td><td>\n<p>int<\/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>Minimum number of characters in the card mask.<div class=\"sc-notice note\"><div><\/p>\n<p>Use of this parameter depends on selection of the <a href=\"\/pt\/point-of-sale\/classic-library-deprecation\/classic-library-integrations\/c-library-integration\/extras-c-library\/start-gift-card-transactions-c-library\/manual-keyed-entry-and-passing-of-card-details-c-library\">Manual Keyed Entry<\/a>\u00a0option.<\/p>\n<\/div><\/div>\n<\/td><\/tr><tr><td>\n<p><code>card_mask_max<\/code><\/p>\n<\/td><td>\n<p>int<\/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>Maximum number of characters in the card mask.<\/p>\n<\/td><\/tr><tr><td>\n<p><code>additional_data_obj<\/code><\/p>\n<\/td><td>\n<p>additional_data_struct<\/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>Contains key\/value pairs that can be used by the merchant to return specific additional data, in particular in the final transaction result.For gift cards, the\u00a0<code>stored_value_redemption_type<\/code>\u00a0additional data key is used for cashback, gratuity and card deactivation.<ul><li markdown=\"1\"><span translate=\"no\"><strong>cashback -\u00a0<\/strong><\/span>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.<\/li><li markdown=\"1\"><span translate=\"no\"><strong>deactivate\u00a0<\/strong><\/span>(not available for SVS) - Deactivates a gift card.<\/li><li><span translate=\"no\"><strong>gratuity\u00a0<\/strong><\/span>(SVS cards only) -\u00a0Used to provide a tip from a gift card.<br><br \/>\nThe cashback and deactivate values can be piped to chain the tasks by passing\u00a0 \"<span translate=\"no\"><strong>cashback|deactivate<\/strong><\/span>\".<\/li><\/ul><\/p>\n<\/td><\/tr><\/tbody><\/table>","url":"https:\/\/docs.adyen.com\/pt\/point-of-sale\/classic-library-deprecation\/classic-library-integrations\/c-library-integration\/structs\/card_operation_request","articleFields":{"id":"28873433","type":"page","_expandable":{"operations":""},"status":"current"},"algolia":{"url":"https:\/\/docs.adyen.com\/pt\/point-of-sale\/classic-library-deprecation\/classic-library-integrations\/c-library-integration\/structs\/card_operation_request","title":"card_operation_request","content":"The\u00a0card_operation_request\u00a0contains the following data elements:\nFieldTypeRequiredDescription\nped\n\nvoid\n\n\n\nif not specified the PED object will be automatically populated.\n\nmerchant_account\n\nchar\n\n\n\nThe merchant account processing this transaction.\u00a0Transactions can be performed with any of the merchant accounts that were returned when registering the POS.\n\nterminal_id\n\nchar\n\n\n\nThe\u00a0terminal_id\u00a0of the PED.\n\ntender_reference\n\nchar\n\n\n\nA reference to the tender provided by the PED.\n\ncard_type\u00a0\n\nchar\n\n\n\nThe type of gift card.\n\ncard_number\n\nString\n\n\n\nThe gift card number.\nUse of this parameter depends on selection of the Manual Keyed Entry\u00a0option.\n\n\nexpiry_month\n\nLong\n\n\n\nMonth of expiration.\nUse of this parameter depends on selection of the Manual Keyed Entry\u00a0option.\n\n\nexpiry_year\n\nLong\n\n\n\nYear of expiration.\nUse of this parameter depends on selection of the Manual Keyed Entry\u00a0option.\n\n\ncard_mask\n\nchar\n\n\n\nA mask to validate the correct number of digits to enter.\nUse of this parameter depends on selection of the Manual Keyed Entry\u00a0option.\n\n\ncard_mask_min\n\nint\n\n\n\nMinimum number of characters in the card mask.\nUse of this parameter depends on selection of the Manual Keyed Entry\u00a0option.\n\n\ncard_mask_max\n\nint\n\n\n\nMaximum number of characters in the card mask.\n\nadditional_data_obj\n\nadditional_data_struct\n\n\n\nContains key\/value pairs that can be used by the merchant to return specific additional data, in particular in the final transaction result.For gift cards, the\u00a0stored_value_redemption_type\u00a0additional data key is used for cashback, gratuity and card deactivation.cashback -\u00a0Cash 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.deactivate\u00a0(not available for SVS) - Deactivates a gift card.gratuity\u00a0(SVS cards only) -\u00a0Used to provide a tip from a gift card.\nThe cashback and deactivate values can be piped to chain the tasks by passing\u00a0 \"cashback|deactivate\".\n","type":"page","locale":"pt","boost":14,"hierarchy":{"lvl0":"Home","lvl1":"Terminais","lvl2":"Deprecation of classic libraries","lvl3":"Library integrations","lvl4":"C library integration","lvl5":"Structs","lvl6":"card_operation_request"},"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\/c-library-integration","lvl5":"https:\/\/docs.adyen.com\/pt\/point-of-sale\/classic-library-deprecation\/classic-library-integrations\/c-library-integration\/structs","lvl6":"\/pt\/point-of-sale\/classic-library-deprecation\/classic-library-integrations\/c-library-integration\/structs\/card_operation_request"},"levels":7,"category":"In-person payments","category_color":"green","tags":["card_operation_request"]}}
