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

The\u00a0create_tender_request<\/code>\u00a0contains the following data elements:<\/p>\n<\/colgroup>
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

An enum of type TRANSACTION_TYPES<\/code>. For a sale transaction, it must have the value GOODS_SERVICES<\/code>.<\/p>\n<\/td><\/tr>

\n

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

\n

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

\n

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

\n

A reference for this request.\u00a0Allows the merchant to identify the transaction.<\/p>\n<\/td><\/tr>

\n

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

\n

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

\n

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

\n

Adyen order reference, used to reference an earlier transaction. It must refer to the psp_reference<\/code> of an earlier existing transaction, unless the transaction fails.<\/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

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

\n

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

\n

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

\n

Tender gratuity currency (if applicable). Should match the tender currency.<\/p>\n<\/td><\/tr>

\n

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

\n

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

\n

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

\n

Tender gratuity amount, if applicable, in minor units (100 is EUR\u00a01.00).<\/p>\n<\/td><\/tr>

\n

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

\n

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

\n

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

\n

For digital shopper recognition, provide a shopper reference and\/or a shopper email address. See also the\u00a0additional data callback<\/a>. If the additional data callback indicates that there is currently no shopper email registered for this customer, the shopper can be asked for their email address as part of the payment process.<\/p>\n<\/td><\/tr>

\n

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

\n

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

\n

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

\n

Records the shopper reference with the transaction and to set up recurring or one-click functionality.<\/p>\n<\/td><\/tr>

\n

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

\n

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

\n

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

\n

The recurring contract specification.<\/p>\n<\/td><\/tr>

\n

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

\n

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

\n

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

\n

The recurring contract detail name.<\/p>\n<\/td><\/tr>

\n

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

\n

tender_options_struct<\/p>\n<\/td>

\n

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

\n

An enum of type\u00a0TENDER_OPTIONS<\/code>. For a list of tender options, see\u00a0Tender Options<\/a>.<\/p>\n<\/td><\/tr>

\n

additional_data_obj<\/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.For gift cards, the stored_value_redemption_type additional data key is used for cashback, gratuity and card deactivation.Perform a cash back or deactivate a card by passing a stored value redemption type in additional data.

  • cashback<\/b><\/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 cannot cash out a specific amount. <\/li>
  • deactivate<\/b><\/span>: deactivates a gift card (not available for SVS).<\/li>
  • gratuity<\/b><\/span>: used to provide a tip from a gift card (for SVS cards only).<\/li><\/ul> The cashback and deactivate values can be piped to chain the tasks by passing \"cashback|deactivate<\/b><\/span>\".<\/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\/create_tender_request","articleFields":{"id":"28869384","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\/create_tender_request","title":"create_tender_request","content":"The\u00a0create_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\nAn enum of type TRANSACTION_TYPES. For a sale transaction, it must have the value GOODS_SERVICES.\n\nreference\n\nchar\n\n\n\nA reference for this request.\u00a0Allows the merchant to identify the transaction.\n\norder_reference\n\nchar\n\n\n\nAdyen order reference, used to reference an earlier transaction. It must refer to the psp_reference of an earlier existing transaction, unless the transaction fails.\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\ngratuity_amount_currency\n\nchar\n\n\n\nTender gratuity currency (if applicable). Should match the tender currency.\n\ngratuity_amount_value\n\nlong\n\n\n\nTender gratuity amount, if applicable, in minor units (100 is EUR\u00a01.00).\n\nshopper_email\n\nchar\n\n\n\nFor digital shopper recognition, provide a shopper reference and\/or a shopper email address. See also the\u00a0additional data callback. If the additional data callback indicates that there is currently no shopper email registered for this customer, the shopper can be asked for their email address as part of the payment process.\n\nshopper_reference\n\nchar\n\n\n\nRecords the shopper reference with the transaction and to set up recurring or one-click functionality.\n\nrecurring_contract\n\nchar\n\n\n\nThe recurring contract specification.\n\nrecurring_contract_detail_name\n\nchar\n\n\n\nThe recurring contract detail name.\n\ntender_options_obj\n\ntender_options_struct\n\n\n\nAn enum of type\u00a0TENDER_OPTIONS. For a list of tender options, see\u00a0Tender Options.\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 stored_value_redemption_type additional data key is used for cashback, gratuity and card deactivation.Perform a cash back or deactivate a card by passing a stored value redemption type in additional data. cashback: 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 cannot cash out a specific amount. deactivate: deactivates a gift card (not available for SVS). gratuity: used to provide a tip from a gift card (for SVS cards only). The cashback and deactivate values can be piped to chain the tasks by passing \"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":"create_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\/create_tender_request"},"levels":7,"category":"In-person payments","category_color":"green","tags":["create_tender_request"]}}