{"title":"balance_inquiry_request","category":"default","creationDate":1776961627,"content":"
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.\u00a0<\/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

char<\/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

int<\/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

int<\/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

String<\/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

String<\/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

String<\/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

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

\n

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

\n

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

\n

\u00a0Tender options define the behavior of the PED.An object that can have the following values:

  1. ReceiptHandler<\/code><\/li>
  2. GetAdditionalData<\/code><\/li>
  3. Recurring<\/code><\/li>
  4. OneClick<\/code><\/li>
  5. BypassPin<\/code><\/li>
  6. AskGratuity<\/code><\/li>
  7. NoProcess<\/code><\/li>
  8. KeyedEntry<\/code><\/li>
  9. DontPrintReceipt<\/code><\/li>
  10. Error<\/code><\/li>
  11. ForcedOnline<\/code><\/li>
  12. ForcedDecline<\/code><\/li>
  13. EnableMagstripeFallback<\/code><\/li>
  14. NoCTLS<\/code><\/li>
  15. AllowPartialAuthorisation<\/code><\/li><\/ol>

    number_of_additional_data_entries: defines the number of entries in the additional_data<\/code> array.<\/p><\/div><\/div>

    \u00a0<\/p>

    \u00a0<\/p><\/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\/balance_inquiry_request","articleFields":{"id":"28871338","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\/balance_inquiry_request","title":"balance_inquiry_request","content":"NameTypeRequiredDefinition\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.\u00a0\n\nreference\n\nchar\n\n\n\nA reference for this request.\u00a0Allows the merchant to identify the transaction.\n\ncard_number\n\nchar\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\nint\n\n\n\nMonth of expiration.\nUse of this parameter depends on selection of the Manual Keyed Entry\u00a0option.\n\n\nexpiry_year\n\nint\n\n\n\nYear of expiration.\nUse of this parameter depends on selection of the Manual Keyed Entry\u00a0option.\n\n\ncard_mask\n\nString\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\nString\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\nString\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\ntender_options_obj\n\ntender_options_struct\n\n\n\n\u00a0Tender options define the behavior of the PED.An object that can have the following values:ReceiptHandlerGetAdditionalDataRecurringOneClickBypassPinAskGratuityNoProcessKeyedEntryDontPrintReceiptErrorForcedOnlineForcedDeclineEnableMagstripeFallbackNoCTLSAllowPartialAuthorisationnumber_of_additional_data_entries: defines the number of entries in the additional_data array.\u00a0\u00a0\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":"balance_inquiry_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\/balance_inquiry_request"},"levels":7,"category":"In-person payments","category_color":"green","tags":["balance_inquiry_request"]}}