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

Parameters<\/h2>\n
Name<\/th>Type<\/th>Required<\/th>Definition<\/th><\/tr><\/thead>
\n

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

\n

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

\n

\"-x-\"<\/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

\u00a0The merchant account processing this transaction.\u00a0Transactions can be performed with any of the merchant accounts that were returned when registering the POS. Use a merchant account that you provided during app registration<\/a> .\u00a0<\/p>\n<\/td><\/tr>

\n

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

\n

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

\n

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

\n

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

\n

card_type<\/code>\u00a0<\/p>\n<\/td>

\n

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

\n

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

\n

The type of gift card.<\/p>\n<\/td><\/tr>

\n

load_type<\/code>\u00a0<\/p>\n<\/td>

\n

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

\n

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

\n

Gift Card Providers allow for many types of loads to cards. For example, merchandising return loads are used to credit returns to a card. Pass the default value: load<\/strong><\/span>. For Givex cards pass either load<\/strong><\/span> for balance load, or merchandise_return<\/strong><\/span> for refunds. load_type<\/code> can take the following values:activate<\/strong><\/span> - Activates a gift card.load<\/strong><\/strong><\/span> - Loads a balance to a gift card.<\/strong><\/strong>merchandise_return<\/strong><\/strong><\/strong><\/span> - Load a refund balance back on to a gift card. This uses the same functionally as a load but is separated for accounting purposes.<\/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

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

\n

String<\/p>\n<\/td>

\n

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

\n

The gift card number.

<\/p>\n

Use of this parameter depends on selection of the Manual Keyed Entry<\/a>\u00a0option.<\/p>\n<\/div><\/div>\n<\/td><\/tr>

\n

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

\n

Long<\/p>\n<\/td>

\n

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

\n

Month of expiration.

<\/p>\n

Use of this parameter depends on selection of the Manual Keyed Entry<\/a>\u00a0option.<\/p>\n<\/div><\/div>\n<\/td><\/tr>

\n

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

\n

Long<\/p>\n<\/td>

\n

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

\n

Year of expiration.

<\/p>\n

Use of this parameter depends on selection of the Manual Keyed Entry<\/a>\u00a0option.<\/p>\n<\/div><\/div>\n<\/td><\/tr>

\n

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

\n

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

\n

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

\n

A mask to validate the correct number of digits to enter.

<\/p>\n

Use of this parameter depends on selection of the Manual Keyed Entry<\/a>\u00a0option.<\/p>\n<\/div><\/div>\n<\/td><\/tr>

\n

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

\n

int<\/p>\n<\/td>

\n

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

\n

Minimum number of characters in the card mask.

<\/p>\n

Use of this parameter depends on selection of the Manual Keyed Entry<\/a>\u00a0option.<\/p>\n<\/div><\/div>\n<\/td><\/tr>

\n

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

\n

int<\/p>\n<\/td>

\n

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

\n

Maximum number of characters in the card mask.

<\/p>\n

Use of this parameter depends on selection of the Manual Keyed Entry<\/a>\u00a0option.<\/p>\n<\/div><\/div>\n<\/td><\/tr>

\n

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

\n

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

\n

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

\n

The currency of the balance.\u00a0<\/p>\n<\/td><\/tr>

\n

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

\n

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

\n

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

\n

The value of the balance.<\/p>\n<\/td><\/tr>

\n

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

\n

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

\n

\"-x-\"<\/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

Register additional data with the transaction if necessary.\u00a0

number_of_additional_data_entries: defines the number of entries in the additional_data<\/code> array.<\/div><\/div><\/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\/load_request","articleFields":{"id":"28873359","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\/load_request","title":"load_request","content":"Parameters\nNameTypeRequiredDefinition\nped\n\nvoid\n\n\n\nIf not specified the PED object will be automatically populated\n\nmerchant_account\n\nchar\n\n\n\n\u00a0The merchant account processing this transaction.\u00a0Transactions can be performed with any of the merchant accounts that were returned when registering the POS. Use a merchant account that you provided during app registration .\u00a0\n\nterminal_id\n\nchar\n\n\n\nThe\u00a0terminal_id\u00a0of the PED.\n\ncard_type\u00a0\n\nchar\n\n\n\nThe type of gift card.\n\nload_type\u00a0\n\nchar\n\n\n\nGift Card Providers allow for many types of loads to cards. For example, merchandising return loads are used to credit returns to a card. Pass the default value: load. For Givex cards pass either load for balance load, or merchandise_return for refunds. load_type can take the following values:activate - Activates a gift card.load - Loads a balance to a gift card.merchandise_return - Load a refund balance back on to a gift card. This uses the same functionally as a load but is separated for accounting purposes.\n\nreference\n\nchar\n\n\n\nA reference for this request.\u00a0Allows the merchant to identify the transaction.\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.\nUse of this parameter depends on selection of the Manual Keyed Entry\u00a0option.\n\n\namount_currency\n\nchar\n\n\n\nThe currency of the balance.\u00a0\n\namount_value\n\nlong\n\n\n\nThe value of the balance.\n\ntender_options_obj\n\nttender_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\nRegister additional data with the transaction if necessary.\u00a0number_of_additional_data_entries: defines the number of entries in the additional_data array.\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":"load_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\/load_request"},"levels":7,"category":"In-person payments","category_color":"green","tags":["load_request"]}}