{"title":"Verifique o saldo de um cart\u00e3o vale presente","category":"default","creationDate":1776961627,"content":"<p>Para verificar os fundos restantes em um <a href=\"\/pt\/point-of-sale\/what-we-support\/payment-methods\/gift-cards-terminal-api\/activate\">cart\u00e3o vale presente ativado<\/a>, fa\u00e7a uma solicita\u00e7\u00e3o de saldo. Quando a solicita\u00e7\u00e3o de saldo \u00e9 processada, voc\u00ea recebe uma resposta especificando os fundos restantes no cart\u00e3o vale presente.<\/p>\n<h2>Antes de come\u00e7ar<\/h2>\n<p>Antes de realizar transa\u00e7\u00f5es com cart\u00e3o vale presente, certifique-se de:<\/p>\n<ul>\n<li>Ler e entender nossos <a href=\"\/pt\/point-of-sale\/design-your-integration\/terminal-api\">fundamentos da API de terminais<\/a>.<\/li>\n<li>Criar uma integra\u00e7\u00e3o que pode <a href=\"\/pt\/point-of-sale\/basic-tapi-integration\/make-a-payment\">efetuar um pagamento<\/a>.<\/li>\n<li>Concluir o processo de integra\u00e7\u00e3o com seu provedor de cart\u00e3o vale presente.<\/li>\n<li><a href=\"\/pt\/point-of-sale\/what-we-support\/payment-methods\/add-payment-methods\">Adicionado o m\u00e9todo de pagamento escolhido \u00e0 sua conta Adyen <\/a>.<\/li>\n<\/ul>\n<h2>Etapa 1: solicitar saldo do  cart\u00e3o vale presente<\/h2>\n<p>Para solicitar o saldo de um cart\u00e3o vale presente:<\/p>\n<ul>\n<li>\n<p>Fa\u00e7a uma solicita\u00e7\u00e3o POST para o <a href=\"\/pt\/point-of-sale\/design-your-integration\/terminal-api#endpoints\">endpoint da API de terminais <\/a>, especificando:<\/p>\n<ul>\n<li>\n<p><code>MessageHeader<\/code>: Segue a estrutura da <code>MessageHeader<\/code> padr\u00e3o, explicada nos <a href=\"\/pt\/point-of-sale\/design-your-integration\/terminal-api#request-message-header\">fundamentos da API de terminais<\/a>, que incluem:<\/p>\n<ul>\n<li><code>ProtocolVersion<\/code>: <strong>3.0<\/strong><\/li>\n<li><code>MessageCategory<\/code>: <strong>BalanceInquiry<\/strong><\/li>\n<li><code>MessageType<\/code>: <strong>Request<\/strong><\/li>\n<li><code>SaleID<\/code>: Seu ID exclusivo para a caixa registradora.<\/li>\n<li><code>ServiceID<\/code>: Seu ID exclusivo para esta tentativa de transa\u00e7\u00e3o. Este precisa ser \u00fanico nas \u00faltimas 48 horas<\/li>\n<li><code>POIID<\/code>: ID exclusivo do terminal. Isso indica para qual terminal a transa\u00e7\u00e3o ser\u00e1 roteada.<\/li>\n<\/ul>\n<!-- list separator -->\n<\/li>\n<li>\n<p><code>BalanceInquiryRequest<\/code>: O corpo da solicita\u00e7\u00e3o para a solicita\u00e7\u00e3o de saldo deve incluir:<\/p>\n<ul>\n<li><code>PaymentAccountReq.PaymentInstrumentData.PaymentInstrumentType<\/code>: <strong>StoredValue<\/strong><\/li>\n<li>\n<p><code>PaymentAccountReq.PaymentInstrumentData.StoredValueAccountID<\/code>: Os detalhes do cart\u00e3o vale presente:<\/p>\n<ul>\n<li><code>StoredValueAccountType<\/code>: <strong>GiftCard<\/strong><\/li>\n<li><code>StoredValueProvider<\/code>: O emissor do cart\u00e3o vale presente: <strong>givex<\/strong>, <strong>svs<\/strong>, ou <strong>valuelink<\/strong><\/li>\n<li><code>IdentificationType<\/code>: <strong>PAN<\/strong><\/li>\n<li>\n<p><code>EntryMode<\/code>, <code>StoredValueID<\/code> e <code>ExpiryDate<\/code>: Esses par\u00e2metros dependem do  <a href=\"\/pt\/point-of-sale\/what-we-support\/payment-methods\/gift-cards-terminal-api#card-entry\">metodo de leitura do cart\u00e3o<\/a> que voc\u00ea est\u00e1 usando.<\/p>\n<table>\n<thead>\n<tr>\n<th style=\"text-align: left;\">Leitura do cart\u00e3o<\/th>\n<th style=\"text-align: left;\">Par\u00e2metros<\/th>\n<\/tr>\n<\/thead>\n<tbody>\n<tr>\n<td style=\"text-align: left;\">Scan<\/td>\n<td style=\"text-align: left;\"><ul><li><code>EntryMode<\/code>: <strong>Scanned<\/strong><\/li><li><code>StoredValueID<\/code>: N\u00famero do cart\u00e3o vale presente.<\/li><li><code>ExpiryDate<\/code>: Data de validade do cart\u00e3o vale presente.<\/li><\/ul><\/td>\n<\/tr>\n<tr>\n<td style=\"text-align: left;\">Swipe or MKE<\/td>\n<td style=\"text-align: left;\"><ul><li><code>EntryMode<\/code>: <strong>MagStripe<\/strong><\/li><li><code>StoredValueID<\/code>: <strong>xxxxxxxxxxxxxxxxxxx<\/strong>.<\/li><li>N\u00e3o inclua o <code>ExpiryDate<\/code> par\u00e2metro.<\/li><\/ul><\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<\/li>\n<\/ul>\n<\/li>\n<\/ul>\n<\/li>\n<\/ul>\n<p>O exemplo abaixo mostra como voc\u00ea solicitaria o saldo de um cart\u00e3o vale presente que j\u00e1 teve suas informa\u00e7\u00f5es digitalizadas.<\/p>\n<div class=\"notices blue\">\n<p>Para obter mais informa\u00e7\u00f5es sobre a estrutura de solicita\u00e7\u00e3o da API de terminais, consulte os <a href=\"\/pt\/point-of-sale\/design-your-integration\/terminal-api#requests\">fundamentos da API de terminais<\/a>.<\/p>\n<\/div>\n<div data-component-wrapper=\"code-sample\">\n<code-sample :title=\"''\" :id=\"'query-the-balance_0'\" :code-data='[{\"language\":\"json\",\"tabTitle\":\"JSON\",\"content\":\"{\\n    \\\"SaleToPOIRequest\\\":{\\n        \\\"MessageHeader\\\":{\\n            \\\"ProtocolVersion\\\":\\\"3.0\\\",\\n            \\\"MessageClass\\\":\\\"Service\\\",\\n            \\\"MessageCategory\\\":\\\"BalanceInquiry\\\",\\n            \\\"MessageType\\\":\\\"Request\\\",\\n            \\\"ServiceID\\\":\\\"9266\\\",\\n            \\\"SaleID\\\":\\\"POSSystemID12345\\\",\\n            \\\"POIID\\\":\\\"V400m-324688179\\\"\\n        },\\n        \\\"BalanceInquiryRequest\\\":{\\n            \\\"PaymentAccountReq\\\":{\\n                \\\"PaymentInstrumentData\\\":{\\n                    \\\"ProtectedCardData\\\": \\\"eyJzc2MiOiIxMTExIn0=\\\",\\n                    \\\"PaymentInstrumentType\\\":\\\"StoredValue\\\",\\n                    \\\"StoredValueAccountID\\\":{\\n\\n                        \\\"StoredValueAccountType\\\":\\\"GiftCard\\\",\\n                        \\\"StoredValueProvider\\\":\\\"svs\\\",\\n                        \\\"IdentificationType\\\":\\\"PAN\\\",\\n                        \\\"EntryMode\\\":[\\n                            \\\"Scanned\\\"\\n                        ],\\n                        \\\"StoredValueID\\\":\\\"6006491260550218066\\\",\\n                        \\\"ExpiryDate\\\":\\\"1122\\\"\\n                    }\\n                }\\n            }\\n        }\\n    }\\n}\"},{\"language\":\"java\",\"tabTitle\":\"Java\",\"content\":\"String serviceID = \\\"YOUR_UNIQUE_ATTEMPT_ID\\\";\\nString saleID = \\\"YOUR_CASH_REGISTER_ID\\\";\\nString POIID = \\\"YOUR_TERMINAL_ID\\\";\\n\\nSaleToPOIRequest saleToPOIRequest = new SaleToPOIRequest();\\nMessageHeader messageHeader = new MessageHeader();\\nmessageHeader.setProtocolVersion(\\\"3.0\\\");\\nmessageHeader.setMessageClass( MessageClassType.SERVICE );\\nmessageHeader.setMessageCategory( MessageCategoryType.BALANCE_INQUIRY );\\nmessageHeader.setMessageType( MessageType.REQUEST );\\nmessageHeader.setServiceID(serviceID);\\nmessageHeader.setSaleID(saleID);\\nmessageHeader.setPOIID(POIID);\\nsaleToPOIRequest.setMessageHeader(messageHeader);\\n\\nBalanceInquiryRequest balanceInquiryRequest = new BalanceInquiryRequest();\\nPaymentAccountReq paymentAccountReq = new PaymentAccountReq();\\nPaymentInstrumentData paymentInstrumentData = new PaymentInstrumentData();\\npaymentInstrumentData.setPaymentInstrumentType( PaymentInstrumentType.STORED_VALUE );\\nStoredValueAccountID storedValueAccountID = new StoredValueAccountID();\\nstoredValueAccountID.setStoredValueAccountType( StoredValueAccountType.GIFT_CARD );\\nstoredValueAccountID.setStoredValueProvider(\\\"svs\\\");\\nstoredValueAccountID.setIdentificationType( IdentificationType.PAN );\\nstoredValueAccountID.getEntryMode().add( EntryModeType.SCANNED );\\nstoredValueAccountID.setStoredValueID(\\\"6006491260550218066\\\");\\nstoredValueAccountID.setExpiryDate(\\\"1122\\\");\\npaymentInstrumentData.setStoredValueAccountID(storedValueAccountID);\\npaymentAccountReq.setPaymentInstrumentData(paymentInstrumentData);\\nbalanceInquiryRequest.setPaymentAccountReq(paymentAccountReq);\\nsaleToPOIRequest.setBalanceInquiryRequest(balanceInquiryRequest);\\nterminalAPIRequest.setSaleToPOIRequest(saleToPOIRequest);\"}]' :enable-copy-link-to-code-block=\"true\" :code-sample-card-size=\"'fullsize'\"><\/code-sample>\n<\/div>\n<\/li>\n<\/ul>\n<p>Sua integra\u00e7\u00e3o receber\u00e1 o saldo do cart\u00e3o vale presente na resposta.<\/p>\n<h2>Etapa 2: receber o saldo do cart\u00e3o vale presente<\/h2>\n<p>Depois de processada, sua integra\u00e7\u00e3o recebe uma resposta contendo o saldo do cart\u00e3o vale presente. Esta \u00e9 fornecido em uma resposta de API s\u00edncrona, a menos que sua integra\u00e7\u00e3o use <a href=\"\/pt\/point-of-sale\/design-your-integration\/choose-your-architecture\/cloud#async\">comunica\u00e7\u00f5es em nuvem ass\u00edncronas<\/a>.<\/p>\n<div class=\"notices yellow\">\n<p>Se sua integra\u00e7\u00e3o usar comunica\u00e7\u00f5es em nuvem ass\u00edncronas, voc\u00ea receber\u00e1 o resultado em uma <a href=\"\/pt\/point-of-sale\/design-your-integration\/notifications\/display-notifications#tender-final\">notifica\u00e7\u00e3o de exibi\u00e7\u00e3o TENDER_FINAL<\/a><\/p>\n<\/div>\n<p>Se a solicita\u00e7\u00e3o de saldo for bem-sucedida:<\/p>\n<ul>\n<li>\n<p>Voc\u00ea recebe uma resposta com um objeto <code>BalanceInquiryResponse<\/code> que inclui:<\/p>\n<ul>\n<li><code>Response.Result<\/code>: <strong>Success<\/strong><\/li>\n<li><code>PaymentAccountStatus.CurrentBalance<\/code>: O valor do saldo do cart\u00e3o vale presente.<\/li>\n<li><code>PaymentAccountStatus.Currency<\/code>: A moeda escolhida para a exibi\u00e7\u00e3o do saldo do cart\u00e3o vale presente.<\/li>\n<\/ul>\n<p>O exemplo abaixo indica um cart\u00e3o vale presente que tem um saldo de <strong>GBP&nbsp;98,75<\/strong>.<\/p>\n<div class=\"notices blue\">\n<p>Para obter mais informa\u00e7\u00f5es sobre a estrutura de solicita\u00e7\u00e3o da API de terminais, consulte os <a href=\"\/pt\/point-of-sale\/design-your-integration\/terminal-api#requests\">fundamentos da API de terminais<\/a>.<\/p>\n<\/div>\n<pre><code class=\"language-json\">{\n  \"SaleToPOIResponse\":{\n    \"BalanceInquiryResponse\":{\n      \"Response\":{\n        \"Result\":\"Success\"\n      },\n      \"PaymentAccountStatus\":{\n        \"CurrentBalance\":98.75,\n          \"PaymentAcquirerData\":{\n            \"AcquirerPOIID\":\"V400m-324688179\"\n          },\n        \"Currency\":\"GBP\"\n      }\n    },\n    \"MessageHeader\":{\n      \"ProtocolVersion\":\"3.0\",\n      \"SaleID\":\"POSSystemID12345\",\n      \"MessageClass\":\"Service\",\n      \"MessageCategory\":\"BalanceInquiry\",\n      \"ServiceID\":\"9266\",\n      \"POIID\":\"V400m-324688179\",\n      \"MessageType\":\"Response\"\n    }\n  }\n}<\/code><\/pre>\n<\/li>\n<\/ul>\n<h2>Pr\u00f3ximos passos<\/h2>\n<div class=\"next-steps\" id=\"next-steps\" >\n<a href=\"\/point-of-sale\/what-we-support\/payment-methods\/gift-cards-terminal-api\/payment\" class=\"next-steps__step\" style=\"width:29%;\" target=\"_self\"><p class=\"next-steps__body\"><div style=\"text-align: center;\"><h6 class=\"next-steps__title\">Realizar um pagamento com cart\u00e3o vale presente<\/h6><p>Efetue um pagamento com um cart\u00e3o vale presente ativado.<\/p><\/div><\/p><\/a><a href=\"\/point-of-sale\/what-we-support\/payment-methods\/gift-cards-terminal-api\/load-a-balance\" class=\"next-steps__step\" style=\"width:29%;\" target=\"_self\"><p class=\"next-steps__body\"><div style=\"text-align: center;\"><h6 class=\"next-steps__title\">Carregar um cart\u00e3o vale presente<\/h6><p>Coloque um cr\u00e9dito adicional em um cart\u00e3o vale presente.<\/p><\/div><\/p><\/a><a href=\"\/point-of-sale\/what-we-support\/payment-methods\/gift-cards-terminal-api\/deactivate\" class=\"next-steps__step\" style=\"width:29%;\" target=\"_self\"><p class=\"next-steps__body\"><div style=\"text-align: center;\"><h6 class=\"next-steps__title\">Desativar ou realizar um saque<\/h6><p>Desative ou saque o saldo existente em um cart\u00e3o vale presente.<\/p><\/div><\/p><\/a><\/div>\n\n<h2 id=\"see-also\">Veja tamb\u00e9m<\/h2>\n<div class=\"see-also-links output-inline\" id=\"see-also\">\n<ul><li><a href=\"\/point-of-sale\/what-we-support\/payment-methods\/gift-cards-terminal-api\/activate\"\n                        target=\"_self\"\n                        >\n                    Ativar um cart\u00e3o vale presente\n                <\/a><\/li><li><a href=\"\/point-of-sale\/what-we-support\/payment-methods\/gift-cards-terminal-api\/refund-gift-cards\"\n                        target=\"_self\"\n                        >\n                    Realizar um reembolso n\u00e3o referenciado para um cart\u00e3o vale presente\n                <\/a><\/li><li><a href=\"\/point-of-sale\/what-we-support\/payment-methods\/gift-cards-terminal-api\/void\"\n                        target=\"_self\"\n                        >\n                    Desfazer uma transa\u00e7\u00e3o realizada para um cart\u00e3o vale presente nas \u00faltimas 24 horas\n                <\/a><\/li><\/ul><\/div>\n","url":"https:\/\/docs.adyen.com\/pt\/point-of-sale\/alternative-payment-methods\/gift-cards-terminal-api\/query-the-balance","articleFields":{"description":"Consulte o saldo de um cart\u00e3o vale presente em seu terminal.","id":"36196868","type":"page","_expandable":{"operations":""},"status":"current","last_edit_on":"03-04-2020 19:18"},"algolia":{"url":"https:\/\/docs.adyen.com\/pt\/point-of-sale\/alternative-payment-methods\/gift-cards-terminal-api\/query-the-balance","title":"Verifique o saldo de um cart\u00e3o vale presente","content":"Para verificar os fundos restantes em um cart\u00e3o vale presente ativado, fa\u00e7a uma solicita\u00e7\u00e3o de saldo. Quando a solicita\u00e7\u00e3o de saldo \u00e9 processada, voc\u00ea recebe uma resposta especificando os fundos restantes no cart\u00e3o vale presente.\nAntes de come\u00e7ar\nAntes de realizar transa\u00e7\u00f5es com cart\u00e3o vale presente, certifique-se de:\n\nLer e entender nossos fundamentos da API de terminais.\nCriar uma integra\u00e7\u00e3o que pode efetuar um pagamento.\nConcluir o processo de integra\u00e7\u00e3o com seu provedor de cart\u00e3o vale presente.\nAdicionado o m\u00e9todo de pagamento escolhido \u00e0 sua conta Adyen .\n\nEtapa 1: solicitar saldo do  cart\u00e3o vale presente\nPara solicitar o saldo de um cart\u00e3o vale presente:\n\n\nFa\u00e7a uma solicita\u00e7\u00e3o POST para o endpoint da API de terminais , especificando:\n\n\nMessageHeader: Segue a estrutura da MessageHeader padr\u00e3o, explicada nos fundamentos da API de terminais, que incluem:\n\nProtocolVersion: 3.0\nMessageCategory: BalanceInquiry\nMessageType: Request\nSaleID: Seu ID exclusivo para a caixa registradora.\nServiceID: Seu ID exclusivo para esta tentativa de transa\u00e7\u00e3o. Este precisa ser \u00fanico nas \u00faltimas 48 horas\nPOIID: ID exclusivo do terminal. Isso indica para qual terminal a transa\u00e7\u00e3o ser\u00e1 roteada.\n\n\n\n\nBalanceInquiryRequest: O corpo da solicita\u00e7\u00e3o para a solicita\u00e7\u00e3o de saldo deve incluir:\n\nPaymentAccountReq.PaymentInstrumentData.PaymentInstrumentType: StoredValue\n\nPaymentAccountReq.PaymentInstrumentData.StoredValueAccountID: Os detalhes do cart\u00e3o vale presente:\n\nStoredValueAccountType: GiftCard\nStoredValueProvider: O emissor do cart\u00e3o vale presente: givex, svs, ou valuelink\nIdentificationType: PAN\n\nEntryMode, StoredValueID e ExpiryDate: Esses par\u00e2metros dependem do  metodo de leitura do cart\u00e3o que voc\u00ea est\u00e1 usando.\n\n\n\nLeitura do cart\u00e3o\nPar\u00e2metros\n\n\n\n\nScan\nEntryMode: ScannedStoredValueID: N\u00famero do cart\u00e3o vale presente.ExpiryDate: Data de validade do cart\u00e3o vale presente.\n\n\nSwipe or MKE\nEntryMode: MagStripeStoredValueID: xxxxxxxxxxxxxxxxxxx.N\u00e3o inclua o ExpiryDate par\u00e2metro.\n\n\n\n\n\n\n\n\n\nO exemplo abaixo mostra como voc\u00ea solicitaria o saldo de um cart\u00e3o vale presente que j\u00e1 teve suas informa\u00e7\u00f5es digitalizadas.\n\nPara obter mais informa\u00e7\u00f5es sobre a estrutura de solicita\u00e7\u00e3o da API de terminais, consulte os fundamentos da API de terminais.\n\n\n\n\n\n\nSua integra\u00e7\u00e3o receber\u00e1 o saldo do cart\u00e3o vale presente na resposta.\nEtapa 2: receber o saldo do cart\u00e3o vale presente\nDepois de processada, sua integra\u00e7\u00e3o recebe uma resposta contendo o saldo do cart\u00e3o vale presente. Esta \u00e9 fornecido em uma resposta de API s\u00edncrona, a menos que sua integra\u00e7\u00e3o use comunica\u00e7\u00f5es em nuvem ass\u00edncronas.\n\nSe sua integra\u00e7\u00e3o usar comunica\u00e7\u00f5es em nuvem ass\u00edncronas, voc\u00ea receber\u00e1 o resultado em uma notifica\u00e7\u00e3o de exibi\u00e7\u00e3o TENDER_FINAL\n\nSe a solicita\u00e7\u00e3o de saldo for bem-sucedida:\n\n\nVoc\u00ea recebe uma resposta com um objeto BalanceInquiryResponse que inclui:\n\nResponse.Result: Success\nPaymentAccountStatus.CurrentBalance: O valor do saldo do cart\u00e3o vale presente.\nPaymentAccountStatus.Currency: A moeda escolhida para a exibi\u00e7\u00e3o do saldo do cart\u00e3o vale presente.\n\nO exemplo abaixo indica um cart\u00e3o vale presente que tem um saldo de GBP&nbsp;98,75.\n\nPara obter mais informa\u00e7\u00f5es sobre a estrutura de solicita\u00e7\u00e3o da API de terminais, consulte os fundamentos da API de terminais.\n\n{\n  \"SaleToPOIResponse\":{\n    \"BalanceInquiryResponse\":{\n      \"Response\":{\n        \"Result\":\"Success\"\n      },\n      \"PaymentAccountStatus\":{\n        \"CurrentBalance\":98.75,\n          \"PaymentAcquirerData\":{\n            \"AcquirerPOIID\":\"V400m-324688179\"\n          },\n        \"Currency\":\"GBP\"\n      }\n    },\n    \"MessageHeader\":{\n      \"ProtocolVersion\":\"3.0\",\n      \"SaleID\":\"POSSystemID12345\",\n      \"MessageClass\":\"Service\",\n      \"MessageCategory\":\"BalanceInquiry\",\n      \"ServiceID\":\"9266\",\n      \"POIID\":\"V400m-324688179\",\n      \"MessageType\":\"Response\"\n    }\n  }\n}\n\n\nPr\u00f3ximos passos\n\nRealizar um pagamento com cart\u00e3o vale presenteEfetue um pagamento com um cart\u00e3o vale presente ativado.Carregar um cart\u00e3o vale presenteColoque um cr\u00e9dito adicional em um cart\u00e3o vale presente.Desativar ou realizar um saqueDesative ou saque o saldo existente em um cart\u00e3o vale presente.\n\nVeja tamb\u00e9m\n\n\n                    Ativar um cart\u00e3o vale presente\n                \n                    Realizar um reembolso n\u00e3o referenciado para um cart\u00e3o vale presente\n                \n                    Desfazer uma transa\u00e7\u00e3o realizada para um cart\u00e3o vale presente nas \u00faltimas 24 horas\n                \n","type":"page","locale":"pt","boost":16,"hierarchy":{"lvl0":"Home","lvl1":"Terminais","lvl2":"Alternative payment methods","lvl3":"Cart\u00f5es vale presente para seu terminal","lvl4":"Verifique o saldo de um cart\u00e3o vale presente"},"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\/alternative-payment-methods","lvl3":"https:\/\/docs.adyen.com\/pt\/point-of-sale\/alternative-payment-methods\/gift-cards-terminal-api","lvl4":"\/pt\/point-of-sale\/alternative-payment-methods\/gift-cards-terminal-api\/query-the-balance"},"levels":5,"category":"In-person payments","category_color":"green","tags":["Verifique","saldo","cart\u00e3o","presente"]},"articleFiles":{"query-the-balance_0.json":"<p alt=\"\">query-the-balance_0.json<\/p>"}}