{"title":"Check the balance of a gift card","category":"default","creationDate":1776961628,"content":"<p>The <code>\/checkBalance<\/code> endpoint of our <a href=\"\/pt\/payment-methods\/gift-cards\/stored-value-api\">Stored Value API<\/a> lets you view the remaining balance on a gift card or other type of stored-value card.<\/p>\n<h3>Transaction per provider and channel<\/h3>\n<div class=\"sc-columns\" style=\"columns:2 auto;-moz-columns:2 auto;column-gap:normal;-moz-column-gap:normal;\">\n<h4>Online<\/h4>\n<table>\n<thead>\n<tr>\n<th style=\"text-align: left;\">Transaction<\/th>\n<th style=\"text-align: center;\">Givex<\/th>\n<th style=\"text-align: center;\">SVS<\/th>\n<th style=\"text-align: center;\">Fiserv (formerly ValueLink)<\/th>\n<th style=\"text-align: center;\">Intersolve<\/th>\n<\/tr>\n<\/thead>\n<tbody>\n<tr>\n<td style=\"text-align: left;\">Check balance<\/td>\n<td style=\"text-align: center;\"><img title=\"-white_check_mark-\" alt=\"-white_check_mark-\" class=\"smileys\" src=\"\/user\/data\/smileys\/emoji\/white_check_mark.png\" \/><\/td>\n<td style=\"text-align: center;\"><img title=\"-white_check_mark-\" alt=\"-white_check_mark-\" class=\"smileys\" src=\"\/user\/data\/smileys\/emoji\/white_check_mark.png\" \/><\/td>\n<td style=\"text-align: center;\"><img title=\"-white_check_mark-\" alt=\"-white_check_mark-\" class=\"smileys\" src=\"\/user\/data\/smileys\/emoji\/white_check_mark.png\" \/><\/td>\n<td style=\"text-align: center;\"><img title=\"-white_check_mark-\" alt=\"-white_check_mark-\" class=\"smileys\" src=\"\/user\/data\/smileys\/emoji\/white_check_mark.png\" \/><\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<h4>In-person payments<\/h4>\n<table>\n<thead>\n<tr>\n<th style=\"text-align: left;\">Transaction<\/th>\n<th style=\"text-align: center;\">Givex<\/th>\n<th style=\"text-align: center;\">SVS<\/th>\n<th style=\"text-align: center;\">Fiserv (formerly ValueLink)<\/th>\n<th style=\"text-align: center;\">Intersolve<\/th>\n<\/tr>\n<\/thead>\n<tbody>\n<tr>\n<td style=\"text-align: left;\">Check balance<\/td>\n<td style=\"text-align: center;\"><img title=\"-white_check_mark-\" alt=\"-white_check_mark-\" class=\"smileys\" src=\"\/user\/data\/smileys\/emoji\/white_check_mark.png\" \/><\/td>\n<td style=\"text-align: center;\"><img title=\"-white_check_mark-\" alt=\"-white_check_mark-\" class=\"smileys\" src=\"\/user\/data\/smileys\/emoji\/white_check_mark.png\" \/><\/td>\n<td style=\"text-align: center;\"><img title=\"-white_check_mark-\" alt=\"-white_check_mark-\" class=\"smileys\" src=\"\/user\/data\/smileys\/emoji\/white_check_mark.png\" \/><\/td>\n<td style=\"text-align: center;\"><img title=\"-white_check_mark-\" alt=\"-white_check_mark-\" class=\"smileys\" src=\"\/user\/data\/smileys\/emoji\/white_check_mark.png\" \/><\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<\/div>\n<h2 id=\"check-balance-request\">Check the balance<\/h2>\n<p>When you view the balance remaining on a gift card or other stored-value card, the way to specify the card details depends on whether you <a href=\"\/pt\/online-payments\/tokenization\">tokenized<\/a> a payment that the shopper made with this card.<\/p>\n\n<div id=\"tab2GJNp\">\n    <div data-component-wrapper=\"tabs\">\n        <tabs\n                        :items=\"[{&quot;title&quot;:&quot;Without token&quot;,&quot;content&quot;:&quot;\\n&lt;p&gt;To see the value of a gift card or other stored-value card that has not been tokenized:&lt;\\\/p&gt;\\n&lt;ul&gt;\\n&lt;li&gt;\\n&lt;p&gt;Make a POST request to the &lt;a href=\\&quot;\\\/pt\\\/payment-methods\\\/gift-cards\\\/stored-value-api#sv-api-endpoints\\&quot;&gt;&lt;code&gt;\\\/checkBalance&lt;\\\/code&gt; endpoint&lt;\\\/a&gt;, specifying:&lt;\\\/p&gt;\\n&lt;ul&gt;\\n&lt;li&gt;\\n&lt;p&gt;&lt;code&gt;merchantAccount&lt;\\\/code&gt;: ID of the merchant account that you want to process the transaction with.&lt;\\\/p&gt;\\n&lt;\\\/li&gt;\\n&lt;li&gt;\\n&lt;p&gt;&lt;code&gt;store&lt;\\\/code&gt;: &lt;div data-component-wrapper=\\&quot;tag\\&quot;&gt;\\n    &lt;tag :variant=&amp;quot;success&amp;quot;&gt;\\n        Optional\\n    &lt;\\\/tag&gt;\\n&lt;\\\/div&gt;\\n For transactions flagged as in-store, the ID of the physical store that you want to process the transaction for. Maximum length: 16 characters.&lt;\\\/p&gt;\\n&lt;\\\/li&gt;\\n&lt;li&gt;\\n&lt;p&gt;&lt;code&gt;paymentMethod&lt;\\\/code&gt; object with:&lt;\\\/p&gt;\\n&lt;ul&gt;\\n&lt;li&gt;&lt;code&gt;type&lt;\\\/code&gt;: Name or brand of the card. Accepted values: &lt;span translate=\\&quot;no\\&quot;&gt;&lt;strong&gt;givex&lt;\\\/strong&gt;&lt;\\\/span&gt; (only for in-person payments), &lt;span translate=\\&quot;no\\&quot;&gt;&lt;strong&gt;svs&lt;\\\/strong&gt;&lt;\\\/span&gt;, &lt;span translate=\\&quot;no\\&quot;&gt;&lt;strong&gt;valuelink&lt;\\\/strong&gt;&lt;\\\/span&gt;, &lt;strong&gt;&lt;a href=\\&quot;\\\/pt\\\/payment-methods\\\/gift-cards#supported-gift-cards\\&quot;&gt;any Intersolve-supported card type&lt;\\\/a&gt;&lt;\\\/strong&gt;.&lt;\\\/li&gt;\\n&lt;li&gt;&lt;code&gt;number&lt;\\\/code&gt;: Card number that identifies the card.&lt;\\\/li&gt;\\n&lt;li&gt;&lt;code&gt;securityCode&lt;\\\/code&gt;: If the card has a PIN code or other type of security code, obtain it from the shopper and provide it here.&lt;\\\/li&gt;\\n&lt;li&gt;&lt;code&gt;expiryMonth&lt;\\\/code&gt;: &lt;div data-component-wrapper=\\&quot;tag\\&quot;&gt;\\n    &lt;tag :variant=&amp;quot;success&amp;quot;&gt;\\n        Optional\\n    &lt;\\\/tag&gt;\\n&lt;\\\/div&gt;\\n Expiry month of the card.&lt;\\\/li&gt;\\n&lt;li&gt;&lt;code&gt;expiryYear&lt;\\\/code&gt;: &lt;div data-component-wrapper=\\&quot;tag\\&quot;&gt;\\n    &lt;tag :variant=&amp;quot;success&amp;quot;&gt;\\n        Optional\\n    &lt;\\\/tag&gt;\\n&lt;\\\/div&gt;\\n Expiry year of the card.&lt;\\\/li&gt;\\n&lt;li&gt;\\n&lt;p&gt;&lt;code&gt;holderName&lt;\\\/code&gt;: &lt;div data-component-wrapper=\\&quot;tag\\&quot;&gt;\\n    &lt;tag :variant=&amp;quot;success&amp;quot;&gt;\\n        Optional\\n    &lt;\\\/tag&gt;\\n&lt;\\\/div&gt;\\n Name of the shopper that the card belongs to.&lt;\\\/p&gt;\\n&lt;!-- list separator --&gt;\\n&lt;\\\/li&gt;\\n&lt;\\\/ul&gt;\\n&lt;\\\/li&gt;\\n&lt;li&gt;\\n&lt;p&gt;&lt;code&gt;reference&lt;\\\/code&gt;: Your reference to uniquely identify the transaction. To provide multiple references for a transaction, separate them with hyphens (\\&quot;-\\&quot;). Maximum length: 80 characters.&lt;\\\/p&gt;\\n&lt;\\\/li&gt;\\n&lt;\\\/ul&gt;\\n&lt;p&gt;This request checks the balance on an SVS gift card:&lt;\\\/p&gt;\\n&lt;pre&gt;&lt;code class=\\&quot;language-json\\&quot;&gt;{\\n    \\&quot;merchantAccount\\&quot;: \\&quot;ADYEN_MERCHANT_ACCOUNT\\&quot;,\\n    \\&quot;store\\&quot;:\\&quot;YOUR_STORE_ID\\&quot;,\\n    \\&quot;paymentMethod\\&quot;: {\\n        \\&quot;type\\&quot;: \\&quot;svs\\&quot;,\\n        \\&quot;number\\&quot;: \\&quot;603628672882001915092\\&quot;,\\n        \\&quot;securityCode\\&quot;: \\&quot;5754\\&quot;\\n    },\\n    \\&quot;reference\\&quot;: \\&quot;YOUR_REFERENCE\\&quot;\\n}&lt;\\\/code&gt;&lt;\\\/pre&gt;\\n&lt;\\\/li&gt;\\n&lt;\\\/ul&gt;\\n&lt;h4 id=\\&quot;response\\&quot;&gt;Response&lt;\\\/h4&gt;\\n&lt;p&gt;You receive a response containing:&lt;\\\/p&gt;\\n&lt;ul&gt;\\n&lt;li&gt;&lt;code&gt;currentBalance&lt;\\\/code&gt;: The &lt;code&gt;currency&lt;\\\/code&gt; and total &lt;code&gt;value&lt;\\\/code&gt; in minor units of the funds stored on the card.&lt;\\\/li&gt;\\n&lt;li&gt;&lt;code&gt;pspReference&lt;\\\/code&gt;: Adyen&#039;s 16-character unique reference associated with the request.&lt;\\\/li&gt;\\n&lt;li&gt;&lt;code&gt;resultCode&lt;\\\/code&gt;: Indicates the state of the request. Refer to &lt;a href=\\&quot;\\\/pt\\\/payment-methods\\\/gift-cards\\\/stored-value-api#result-codes\\&quot;&gt;Result codes&lt;\\\/a&gt; for the values that you can receive.&lt;\\\/li&gt;\\n&lt;\\\/ul&gt;\\n&lt;p&gt;Sample response:&lt;\\\/p&gt;\\n&lt;pre&gt;&lt;code class=\\&quot;language-json\\&quot;&gt;{\\n    \\&quot;currentBalance\\&quot;: {\\n        \\&quot;currency\\&quot;: \\&quot;EUR\\&quot;,\\n        \\&quot;value\\&quot;: 5600\\n    },\\n    \\&quot;pspReference\\&quot;: \\&quot;881564657480267D\\&quot;,\\n    \\&quot;resultCode\\&quot;: \\&quot;Success\\&quot;\\n}&lt;\\\/code&gt;&lt;\\\/pre&gt;\\n&quot;,&quot;altTitle&quot;:null,&quot;oldTabId&quot;:&quot;without_token_0_1&quot;,&quot;relation&quot;:&quot;&quot;},{&quot;title&quot;:&quot;With token&quot;,&quot;content&quot;:&quot;\\n&lt;p&gt;To see the value of a gift card or other stored-value card that has been tokenized:&lt;\\\/p&gt;\\n&lt;ul&gt;\\n&lt;li&gt;\\n&lt;p&gt;Make a POST request to the &lt;a href=\\&quot;\\\/pt\\\/payment-methods\\\/gift-cards\\\/stored-value-api#sv-api-endpoints\\&quot;&gt;&lt;code&gt;checkBalance&lt;\\\/code&gt; endpoint&lt;\\\/a&gt;, specifying:&lt;\\\/p&gt;\\n&lt;ul&gt;\\n&lt;li&gt;&lt;code&gt;merchantAccount&lt;\\\/code&gt;: ID of the merchant account that you want to process the transaction with.&lt;\\\/li&gt;\\n&lt;li&gt;&lt;code&gt;store&lt;\\\/code&gt;: &lt;div data-component-wrapper=\\&quot;tag\\&quot;&gt;\\n    &lt;tag :variant=&amp;quot;success&amp;quot;&gt;\\n        Optional\\n    &lt;\\\/tag&gt;\\n&lt;\\\/div&gt;\\n For transactions flagged as in-store, the ID of the physical store that you want to process the transaction for. Maximum length: 16 characters.&lt;\\\/li&gt;\\n&lt;li&gt;&lt;code&gt;paymentMethod.type&lt;\\\/code&gt;: Name or brand of the card. Accepted values: &lt;span translate=\\&quot;no\\&quot;&gt;&lt;strong&gt;givex&lt;\\\/strong&gt;&lt;\\\/span&gt; (only for in-person payments), &lt;span translate=\\&quot;no\\&quot;&gt;&lt;strong&gt;svs&lt;\\\/strong&gt;&lt;\\\/span&gt;, &lt;span translate=\\&quot;no\\&quot;&gt;&lt;strong&gt;valuelink&lt;\\\/strong&gt;&lt;\\\/span&gt;, &lt;strong&gt;&lt;a href=\\&quot;\\\/pt\\\/payment-methods\\\/gift-cards#supported-gift-cards\\&quot;&gt;any Intersolve-supported card type&lt;\\\/a&gt;&lt;\\\/strong&gt;.&lt;\\\/li&gt;\\n&lt;li&gt;&lt;code&gt;recurringDetailReference&lt;\\\/code&gt;: The token that identifies the card. This was returned in the response when you tokenized the card.&lt;\\\/li&gt;\\n&lt;li&gt;&lt;code&gt;shopperReference&lt;\\\/code&gt;: Your unique ID for this shopper. This is the &lt;code&gt;shopperReference&lt;\\\/code&gt; that you used when you created the token.&lt;\\\/li&gt;\\n&lt;li&gt;&lt;code&gt;shopperInteraction&lt;\\\/code&gt;: Specifies the sales channel through which the shopper provided their details. Accepted values: &lt;span translate=\\&quot;no\\&quot;&gt;&lt;strong&gt;Ecommerce&lt;\\\/strong&gt;&lt;\\\/span&gt; (default for online transactions), &lt;span translate=\\&quot;no\\&quot;&gt;&lt;strong&gt;ContAuth&lt;\\\/strong&gt;&lt;\\\/span&gt; (online, using previously stored details), &lt;span translate=\\&quot;no\\&quot;&gt;&lt;strong&gt;Moto&lt;\\\/strong&gt;&lt;\\\/span&gt; (via email or telephone) or &lt;span translate=\\&quot;no\\&quot;&gt;&lt;strong&gt;POS&lt;\\\/strong&gt;&lt;\\\/span&gt; (using an in-store terminal).&lt;\\\/li&gt;\\n&lt;li&gt;&lt;code&gt;reference&lt;\\\/code&gt;: Your reference to uniquely identify the transaction. To provide multiple references for a transaction, separate them with hyphens (\\&quot;-\\&quot;). Maximum length: 80 characters.&lt;\\\/li&gt;\\n&lt;\\\/ul&gt;\\n&lt;p&gt;This request checks the balance on a tokenized Fiserv (formerly ValueLink) gift card:&lt;\\\/p&gt;\\n&lt;pre&gt;&lt;code class=\\&quot;language-json\\&quot;&gt;{\\n    \\&quot;merchantAccount\\&quot;: \\&quot;ADYEN_MERCHANT_ACCOUNT\\&quot;,\\n    \\&quot;paymentMethod\\&quot;: {\\n        \\&quot;type\\&quot;: \\&quot;valuelink\\&quot;\\n    },\\n    \\&quot;recurringDetailReference\\&quot;: \\&quot;7219687191761347\\&quot;,\\n    \\&quot;shopperReference\\&quot;: \\&quot;YOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j\\&quot;,\\n    \\&quot;shopperInteraction\\&quot;: \\&quot;Ecommerce\\&quot;,\\n    \\&quot;reference\\&quot;: \\&quot;YOUR_REFERENCE\\&quot;\\n}&lt;\\\/code&gt;&lt;\\\/pre&gt;\\n&lt;\\\/li&gt;\\n&lt;\\\/ul&gt;\\n&lt;h4 id=\\&quot;response\\&quot;&gt;Response&lt;\\\/h4&gt;\\n&lt;p&gt;You receive a response containing:&lt;\\\/p&gt;\\n&lt;ul&gt;\\n&lt;li&gt;&lt;code&gt;currentBalance&lt;\\\/code&gt;: The &lt;code&gt;currency&lt;\\\/code&gt; and total &lt;code&gt;value&lt;\\\/code&gt; in minor units of the funds stored on the card.&lt;\\\/li&gt;\\n&lt;li&gt;&lt;code&gt;pspReference&lt;\\\/code&gt;: Adyen&#039;s 16-character unique reference associated with the request.&lt;\\\/li&gt;\\n&lt;li&gt;&lt;code&gt;resultCode&lt;\\\/code&gt;: Indicates the state of the request. Refer to &lt;a href=\\&quot;\\\/pt\\\/payment-methods\\\/gift-cards\\\/stored-value-api#result-codes\\&quot;&gt;Result codes&lt;\\\/a&gt; for the values that you can receive.&lt;\\\/li&gt;\\n&lt;\\\/ul&gt;\\n&lt;p&gt;Sample response:&lt;\\\/p&gt;\\n&lt;pre&gt;&lt;code class=\\&quot;language-json\\&quot;&gt;{\\n    \\&quot;currentBalance\\&quot;: {\\n        \\&quot;currency\\&quot;: \\&quot;EUR\\&quot;,\\n        \\&quot;value\\&quot;: 5600\\n    },\\n    \\&quot;pspReference\\&quot;: \\&quot;881564657480267D\\&quot;,\\n    \\&quot;resultCode\\&quot;: \\&quot;Success\\&quot;\\n}&lt;\\\/code&gt;&lt;\\\/pre&gt;\\n&quot;,&quot;altTitle&quot;:null,&quot;oldTabId&quot;:&quot;with_token_1_2&quot;,&quot;relation&quot;:&quot;&quot;}]\"\n            :should-update-when-url-changes='false'>\n        <\/tabs>\n    <\/div>\n<\/div>\n\n<h2>Next steps<\/h2>\n<div class=\"next-steps\" id=\"next-steps\" >\n<a href=\"\/payment-methods\/gift-cards\/stored-value-api\/load\" class=\"next-steps__step\" style=\"width:29%;\" target=\"_self\"><p class=\"next-steps__body\"><div style=\"text-align: center;\"><h6 class=\"next-steps__title\">Load<\/h6><p>Add funds to a gift card.<\/p><\/div><\/p><\/a><a href=\"\/payment-methods\/gift-cards\/stored-value-api\/merge-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\">Merge balance<\/h6><p>Transfer the value from one gift card to another.<\/p><\/div><\/p><\/a><a href=\"\/payment-methods\/gift-cards\/stored-value-api\/issue\" class=\"next-steps__step\" style=\"width:29%;\" target=\"_self\"><p class=\"next-steps__body\"><div style=\"text-align: center;\"><h6 class=\"next-steps__title\">Issue<\/h6><p>Issue a new gift card.<\/p><\/div><\/p><\/a><\/div>\n\n<h2 id=\"see-also\">See also<\/h2>\n<div class=\"see-also-links output-inline\" id=\"see-also\">\n<ul><li><a href=\"\/payment-methods\/gift-cards\/stored-value-api\/change-status\"\n                        target=\"_self\"\n                        >\n                    Activate or deactivate a gift card\n                <\/a><\/li><li><a href=\"\/payment-methods\/gift-cards\/stored-value-api\/void\"\n                        target=\"_self\"\n                        >\n                    Undo a previous Stored Value API transaction from the last 24 hours\n                <\/a><\/li><li><a href=\"\/payment-methods\/gift-cards\/stored-value-api\"\n                        target=\"_self\"\n                        >\n                    Stored Value API\n                <\/a><\/li><\/ul><\/div>\n","url":"https:\/\/docs.adyen.com\/pt\/payment-methods\/gift-cards\/stored-value-api\/check-balance","articleFields":{"description":"View the value of a gift card or other stored-value card.","feedback_component":true,"page_id":"0033b5d1-e29e-454d-bd41-6d6129b01cb9","filters_component":false,"decision_tree":"[]"},"algolia":{"url":"https:\/\/docs.adyen.com\/pt\/payment-methods\/gift-cards\/stored-value-api\/check-balance","title":"Check the balance of a gift card","content":"The \/checkBalance endpoint of our Stored Value API lets you view the remaining balance on a gift card or other type of stored-value card.\nTransaction per provider and channel\n\nOnline\n\n\n\nTransaction\nGivex\nSVS\nFiserv (formerly ValueLink)\nIntersolve\n\n\n\n\nCheck balance\n\n\n\n\n\n\n\nIn-person payments\n\n\n\nTransaction\nGivex\nSVS\nFiserv (formerly ValueLink)\nIntersolve\n\n\n\n\nCheck balance\n\n\n\n\n\n\n\n\nCheck the balance\nWhen you view the balance remaining on a gift card or other stored-value card, the way to specify the card details depends on whether you tokenized a payment that the shopper made with this card.\n\n\n    \n        \n        \n    \n\n\nNext steps\n\nLoadAdd funds to a gift card.Merge balanceTransfer the value from one gift card to another.IssueIssue a new gift card.\n\nSee also\n\n\n                    Activate or deactivate a gift card\n                \n                    Undo a previous Stored Value API transaction from the last 24 hours\n                \n                    Stored Value API\n                \n","type":"page","locale":"pt","boost":16,"hierarchy":{"lvl0":"Home","lvl1":"Payment methods","lvl2":"Gift cards","lvl3":"Stored Value API for managing gift cards","lvl4":"Check the balance of a gift card"},"hierarchy_url":{"lvl0":"https:\/\/docs.adyen.com\/pt","lvl1":"https:\/\/docs.adyen.com\/pt\/payment-methods","lvl2":"https:\/\/docs.adyen.com\/pt\/payment-methods\/gift-cards","lvl3":"https:\/\/docs.adyen.com\/pt\/payment-methods\/gift-cards\/stored-value-api","lvl4":"\/pt\/payment-methods\/gift-cards\/stored-value-api\/check-balance"},"levels":5,"category":"Payment method","category_color":"green","tags":["Check","balance"]}}
