{"title":"special_tender_request","category":"default","creationDate":1776961627,"content":"

The\u00a0special_tender_request<\/code>\u00a0contains the following data elements:<\/p>\n
Field<\/th>Type<\/th>Required<\/th>Description<\/th><\/tr><\/thead>
\n

ped<\/code><\/p>\n<\/td>

\n

void<\/p>\n<\/td>

\n

\"-white_check_mark-\"<\/p>\n<\/td>

\n

if not specified the PED object will be automatically populated.<\/p>\n<\/td><\/tr>

\n

merchant_account<\/code><\/p>\n<\/td>

\n

char<\/p>\n<\/td>

\n

\"-white_check_mark-\"<\/p>\n<\/td>

\n

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>

\n

transaction_type<\/code><\/p>\n<\/td>

\n

ADYTransactionType<\/p>\n<\/td>

\n

\"-white_check_mark-\"<\/p>\n<\/td>

\n

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).\u00a0transaction_type<\/code>\u00a0takes the following values:

  • redeem<\/li>
  • load<\/li>
  • balanceInquiry<\/li><\/ul><\/p>\n<\/td><\/tr>
\n

reference<\/code><\/p>\n<\/td>

\n

char<\/p>\n<\/td>

\n

\"-white_check_mark-\"<\/p>\n<\/td>

\n

A merchant-supplied reference for the transaction.<\/p>\n<\/td><\/tr>

\n

terminal_id<\/code><\/p>\n<\/td>

\n

char<\/p>\n<\/td>

\n

\"-white_check_mark-\"<\/p>\n<\/td>

\n

The\u00a0terminal_id<\/code>\u00a0of the PED.<\/p>\n<\/td><\/tr>

\n

amount_currency<\/code><\/p>\n<\/td>

\n

char<\/p>\n<\/td>

\n

\"-white_check_mark-\"<\/p>\n<\/td>

\n

Currency of the transaction (ISO 4217).<\/p>\n<\/td><\/tr>

\n

amount_value<\/code><\/p>\n<\/td>

\n

long<\/p>\n<\/td>

\n

\"-white_check_mark-\"<\/p>\n<\/td>

\n

Amount of the transaction in minor currency units.<\/p>\n<\/td><\/tr>

\n

payment_method_type<\/code><\/p>\n<\/td>

\n

char<\/p>\n<\/td>

\n

\"-white_check_mark-\"<\/p>\n<\/td>

\n

Payment method used for the transaction, such as a gift card, Alipay etc.For Gift Cards:

  • Pass givex<\/strong><\/span> for a Givex card.<\/li>
  • Pass svs<\/strong><\/span> for a SVS card.<\/li><\/ul>

    For Alipay and WeChat Pay:<\/p>

    • Pass alipay<\/strong><\/span> for an Alipay transaction.<\/li>
    • Pass wechatpay_pos<\/strong><\/span> for WeChat Pay transaction.<\/li><\/ul><\/p>\n<\/td><\/tr>
\n

options<\/code><\/p>\n<\/td>

\n

void<\/p>\n<\/td>

\n

\"-white_check_mark-\"<\/p>\n<\/td>

\n

Special options are dictionary key value pairs. This information is passed directly to the PED, which interprets it.Activate, load, or refund a balance to a card by creating a special tender and passing the following values as the loadType<\/code> in special options:<\/p>\n

    \n
  • activate<\/strong> - Activates a gift card.<\/li>\n
  • load<\/strong> - Adds a balance to a gift card.<\/li>\n
  • 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
    \n

    The activate and load values can be piped to chain the tasks by passing \"activate|load<\/strong>\".<\/p>\n

    <\/div><\/div>Perform a cash back or deactivate a card by creating a special tender and passing a redemptionType<\/code>\u00a0as a special option.\u00a0<\/p>\n

      \n
    • \n

      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

    • \n

      deactivate\u00a0<\/strong>- Deactivates a gift card.\u00a0\u00a0(Deactivate is not available for SVS).<\/p>\n<\/li>\n

    • \n

      gratuity<\/strong> - Used to provide a tip from a gift card. (For SVS cards only).<\/p>\n<\/li>\n<\/ul>\n

      \n

      The cashback and deactivate values can be piped to chain the tasks by passing\u00a0 \"cashback|deactivate<\/strong>\".<\/p>\n<\/div><\/div>\n<\/td><\/tr>

\n

handle_receipt<\/code><\/p>\n<\/td>

\n

boolean<\/p>\n<\/td>

\n

\"-x-\"<\/p>\n<\/td>

\n

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>

\n

additional_data<\/code><\/p>\n<\/td>

\n

additional_data_struct<\/p>\n<\/td>

\n

\"-x-\"<\/p>\n<\/td>

\n

Contains key\/value pairs that can be used by the merchant to return specific additional data, in particular in the final transaction result.<\/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\/special_tender_request","articleFields":{"id":"31501149","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\/special_tender_request","title":"special_tender_request","content":"The\u00a0special_tender_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\ntransaction_type\n\nADYTransactionType\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).\u00a0transaction_type\u00a0takes the following values:redeemloadbalanceInquiry\n\nreference\n\nchar\n\n\n\nA merchant-supplied reference for the transaction.\n\nterminal_id\n\nchar\n\n\n\nThe\u00a0terminal_id\u00a0of the PED.\n\namount_currency\n\nchar\n\n\n\nCurrency of the transaction (ISO 4217).\n\namount_value\n\nlong\n\n\n\nAmount of the transaction in minor currency units.\n\npayment_method_type\n\nchar\n\n\n\nPayment method used for the transaction, such as a gift card, Alipay etc.For Gift Cards:Pass givex for a Givex card.Pass svs for a SVS card.For Alipay and WeChat Pay:Pass alipay for an Alipay transaction.Pass wechatpay_pos for WeChat Pay transaction.\n\noptions\n\nvoid\n\n\n\nSpecial options are dictionary key value pairs. This information is passed directly to the PED, which interprets it.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\nhandle_receipt\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\nadditional_data\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.\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":"special_tender_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\/special_tender_request"},"levels":7,"category":"In-person payments","category_color":"green","tags":["special_tender_request"]}}