Publishable keys are a type of keys that can be public and have limited scope of usage. Client Secret provide temporary access to singular data, such as access to a single customer object for a short period of time. This authentication scheme is used by the SDK.
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"BirrPay","colors":{"primary":"#4F8EFF","light":"#6BA3FF","dark":"#2563EB"},"logo":{"light":"https://mintcdn.com/birrpay/YnpImjYt65LKI-RI/logo/light.svg?fit=max\u0026auto=format\u0026n=YnpImjYt65LKI-RI\u0026q=85\u0026s=410fca5e1e3112fa410bfe0f1bc67731","dark":"https://mintcdn.com/birrpay/541dDB4gOfow0DxB/logo/dark.svg?fit=max\u0026auto=format\u0026n=541dDB4gOfow0DxB\u0026q=85\u0026s=e38313db04f8e480c019afc36f86deed"},"favicon":"/favicon.svg","api":{"openapi":["v1/openapi_spec_v1.json","v2/openapi_spec_v2.json","rust_locker_open_api_spec.yml"]},"background":{"color":{"light":"#FAFBFC","dark":"#1d1d1d"}},"navbar":{"links":[{"href":"https://birrpay.io/contactus","label":"Contact Us"}]},"footer":{"socials":{"linkedin":"https://www.linkedin.com/company/birrpay-ethiopia"}},"integrations":{"gtm":{"tagId":"GTM-NQNN2JG5"},"mixpanel":{"projectToken":"b637c4588c180272bf586c5376e524e6"}},"contextual":{"options":["copy","claude","chatgpt","view"]},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"birrpay","hasAudioNarration":false,"actualSubdomain":"birrpay","customDomains":["docs.birrpay.io"],"gitSource":{"type":"gitlab","owner":"birrpay","repo":"hyperswitch","projectId":77700133,"deployBranch":"develop","contentDirectory":"api-reference","isPrivate":true,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6a21eaf12fb2a99bab92c3fd","collectionId":"e126846c-3fdf-4d9b-8ab0-45d072d25e19","schemaVersion":"v2"},"entitlements":{},"buildId":"6a21eaf12fb2a99bab92c3fd:success","clientVersion":"0.0.3965","searchFilterCounts":[{"language":"default","tag":"Documentation","count":183},{"language":"default","tag":"Payments Core APIs","count":53},{"language":"default","tag":"Other APIs","count":35},{"language":"default","tag":"Payments Core APIs [BETA]","count":32},{"language":"default","tag":"Account management APIs","count":28},{"language":"default","tag":"Account management APIs [BETA]","count":27},{"language":"default","tag":"Payments","count":26},{"language":"default","tag":"API Reference","count":24},{"language":"default","tag":"Routing","count":17},{"language":"default","tag":"Payment Methods","count":16}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableAskAiSearchBar":true},"hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-v7-file-tree","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"pause-universal-search-reconcile","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"per-site-search-delta","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-private-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-nav-generations","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"byok-sep-25","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-agent-model-picker","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-updated-9-15","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"isAtlas":false,"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"v2/payments/payments--check-balance-and-apply-pm-data","slug":"/v2/payments/payments--check-balance-and-apply-pm-data","pageMetadata":{"openapi":"post /v2/payments/{id}/eligibility/check-balance-and-apply-pm-data","title":"Payments - Check Balance and Apply PM Data","description":"Check the balance of the payment methods, apply the payment method data and recalculate remaining_amount and surcharge","href":"/v2/payments/payments--check-balance-and-apply-pm-data","hidden":false},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"Check the balance of the payment methods, apply the payment method data and recalculate remaining_amount and surcharge\"\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"openapi":"post /v2/payments/{id}/eligibility/check-balance-and-apply-pm-data","title":"Payments - Check Balance and Apply PM Data","description":"Check the balance of the payment methods, apply the payment method data and recalculate remaining_amount and surcharge","href":"/v2/payments/payments--check-balance-and-apply-pm-data","hidden":false}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"tags":["Payments"],"summary":"Payments - Check Balance and Apply PM Data","description":"Check the balance of the payment methods, apply the payment method data and recalculate remaining_amount and surcharge","operationId":"Apply Payment Method Data","parameters":["18e92886-f928-48c4-b700-eea72556aae8","389c7d8f-e0d3-4f96-b1d2-a5eb535e60f8"],"requestBody":"9894c69b-3b94-4ddf-893e-986cb1bfd1ff","responses":{"200":"d44b0b97-4465-4ec3-baaa-31528fd64f87"},"security":["a5e6af04-a09d-4396-91d1-61a00f44dc21"],"method":"post","type":"path","servers":["f37e9e71-e224-445e-b50d-8bb9303c2220"],"path":"/v2/payments/{id}/eligibility/check-balance-and-apply-pm-data","baseUrlOptions":["https://sandbox.birrpay.io"],"title":"Payments - Check Balance and Apply PM Data","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"18e92886-f928-48c4-b700-eea72556aae8":{"name":"id","in":"path","description":"The global payment id","required":true,"schema":{"type":"string","isRequired":true,"description":"The global payment id","uniqueKey":"","typeLabel":"string"}},"389c7d8f-e0d3-4f96-b1d2-a5eb535e60f8":{"name":"X-Profile-Id","in":"header","description":"Profile ID associated to the payment intent","required":true,"schema":{"type":"string","isRequired":true,"description":"Profile ID associated to the payment intent","uniqueKey":"","typeLabel":"string"},"example":"pro_abcdefghijklmnop"}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["payment_methods"],"properties":{"payment_methods":{"type":"array","items":{"type":"object","required":["gift_card"],"properties":{"gift_card":{"oneOf":[{"type":"object","required":["givex"],"properties":{"givex":{"type":"object","required":["number","cvc"],"properties":{"number":{"type":"string","description":"The gift card number","isRequired":true,"uniqueKey":"payment_methods.items.[INDEX].gift_card.oneOf.0.givex.number","typeLabel":"string"},"cvc":{"type":"string","description":"The card verification code.","isRequired":true,"uniqueKey":"payment_methods.items.[INDEX].gift_card.oneOf.0.givex.cvc","typeLabel":"string"}},"isRequired":true,"uniqueKey":"payment_methods.items.[INDEX].gift_card.oneOf.0.givex","typeLabel":"object"}},"isRequired":true,"uniqueKey":"payment_methods.items.[INDEX].gift_card.oneOf.0","typeLabel":"object"},{"type":"object","required":["pay_safe_card"],"properties":{"pay_safe_card":{"type":"object","isRequired":true,"uniqueKey":"payment_methods.items.[INDEX].gift_card.oneOf.1.pay_safe_card","typeLabel":"object"}},"isRequired":true,"uniqueKey":"payment_methods.items.[INDEX].gift_card.oneOf.1","typeLabel":"object"},{"type":"object","required":["bhn_card_network"],"properties":{"bhn_card_network":{"type":"object","required":["account_number","pin","cvv2","expiration_date"],"properties":{"account_number":{"type":"string","description":"The gift card or account number","isRequired":true,"uniqueKey":"payment_methods.items.[INDEX].gift_card.oneOf.2.bhn_card_network.account_number","typeLabel":"string"},"pin":{"type":"string","description":"The security PIN for gift cards requiring it","isRequired":true,"uniqueKey":"payment_methods.items.[INDEX].gift_card.oneOf.2.bhn_card_network.pin","typeLabel":"string"},"cvv2":{"type":"string","description":"The CVV2 code for Open Loop/VPLN products","isRequired":true,"uniqueKey":"payment_methods.items.[INDEX].gift_card.oneOf.2.bhn_card_network.cvv2","typeLabel":"string"},"expiration_date":{"type":"string","description":"The expiration date in MMYYYY format for Open Loop/VPLN products","isRequired":true,"uniqueKey":"payment_methods.items.[INDEX].gift_card.oneOf.2.bhn_card_network.expiration_date","typeLabel":"string"}},"isRequired":true,"uniqueKey":"payment_methods.items.[INDEX].gift_card.oneOf.2.bhn_card_network","typeLabel":"object"}},"isRequired":true,"uniqueKey":"payment_methods.items.[INDEX].gift_card.oneOf.2","typeLabel":"object"}],"isRequired":true,"uniqueKey":"payment_methods.items.[INDEX].gift_card","typeLabel":"object"}},"uniqueKey":"payment_methods.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"payment_methods","typeLabel":"object[]"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"payment_methods":[{"gift_card":{"givex":{"number":"\u003cstring>","cvc":"\u003cstring>"}}}]}}},"exampleType":"generated"}},"required":true,"exampleType":"generated"},"responses":{"d44b0b97-4465-4ec3-baaa-31528fd64f87":{"description":"Apply the Payment Method Data","content":{"application/json":{"schema":{"type":"object","required":["balances","remaining_amount","currency","requires_additional_pm_data"],"properties":{"balances":{"type":"array","items":{"type":"object","required":["payment_method_data","eligibility"],"properties":{"payment_method_data":{"type":"object","required":["gift_card"],"properties":{"gift_card":{"oneOf":[{"type":"object","required":["givex"],"properties":{"givex":{"type":"object","required":["number","cvc"],"properties":{"number":{"type":"string","description":"The gift card number","isRequired":true,"uniqueKey":"balances.items.[INDEX].payment_method_data.gift_card.oneOf.0.givex.number","typeLabel":"string"},"cvc":{"type":"string","description":"The card verification code.","isRequired":true,"uniqueKey":"balances.items.[INDEX].payment_method_data.gift_card.oneOf.0.givex.cvc","typeLabel":"string"}},"isRequired":true,"uniqueKey":"balances.items.[INDEX].payment_method_data.gift_card.oneOf.0.givex","typeLabel":"object"}},"isRequired":true,"uniqueKey":"balances.items.[INDEX].payment_method_data.gift_card.oneOf.0","typeLabel":"object"},{"type":"object","required":["pay_safe_card"],"properties":{"pay_safe_card":{"type":"object","isRequired":true,"uniqueKey":"balances.items.[INDEX].payment_method_data.gift_card.oneOf.1.pay_safe_card","typeLabel":"object"}},"isRequired":true,"uniqueKey":"balances.items.[INDEX].payment_method_data.gift_card.oneOf.1","typeLabel":"object"},{"type":"object","required":["bhn_card_network"],"properties":{"bhn_card_network":{"type":"object","required":["account_number","pin","cvv2","expiration_date"],"properties":{"account_number":{"type":"string","description":"The gift card or account number","isRequired":true,"uniqueKey":"balances.items.[INDEX].payment_method_data.gift_card.oneOf.2.bhn_card_network.account_number","typeLabel":"string"},"pin":{"type":"string","description":"The security PIN for gift cards requiring it","isRequired":true,"uniqueKey":"balances.items.[INDEX].payment_method_data.gift_card.oneOf.2.bhn_card_network.pin","typeLabel":"string"},"cvv2":{"type":"string","description":"The CVV2 code for Open Loop/VPLN products","isRequired":true,"uniqueKey":"balances.items.[INDEX].payment_method_data.gift_card.oneOf.2.bhn_card_network.cvv2","typeLabel":"string"},"expiration_date":{"type":"string","description":"The expiration date in MMYYYY format for Open Loop/VPLN products","isRequired":true,"uniqueKey":"balances.items.[INDEX].payment_method_data.gift_card.oneOf.2.bhn_card_network.expiration_date","typeLabel":"string"}},"isRequired":true,"uniqueKey":"balances.items.[INDEX].payment_method_data.gift_card.oneOf.2.bhn_card_network","typeLabel":"object"}},"isRequired":true,"uniqueKey":"balances.items.[INDEX].payment_method_data.gift_card.oneOf.2","typeLabel":"object"}],"isRequired":true,"uniqueKey":"balances.items.[INDEX].payment_method_data.gift_card","typeLabel":"object"}},"isRequired":true,"uniqueKey":"balances.items.[INDEX].payment_method_data","typeLabel":"object"},"eligibility":{"oneOf":[{"type":"object","required":["success"],"properties":{"success":{"type":"object","required":["balance","applicable_amount","currency"],"properties":{"balance":{"type":"integer","format":"int64","description":"This Unit struct represents MinorUnit in which core amount works","isRequired":true,"uniqueKey":"balances.items.[INDEX].eligibility.oneOf.0.success.balance","typeLabel":"integer\u003cint64>"},"applicable_amount":{"type":"integer","format":"int64","description":"This Unit struct represents MinorUnit in which core amount works","isRequired":true,"uniqueKey":"balances.items.[INDEX].eligibility.oneOf.0.success.applicable_amount","typeLabel":"integer\u003cint64>"},"currency":{"type":"string","description":"The three-letter ISO 4217 currency code (e.g., \"USD\", \"EUR\") for the payment amount. This field is mandatory for creating a payment.","enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BRL","BSD","BTN","BWP","BYN","BZD","CAD","CDF","CHF","CLF","CLP","CNY","COP","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLE","SLL","SOS","SRD","SSP","STD","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","UYU","UZS","VES","VND","VUV","WST","XAF","XCD","XOF","XPF","YER","ZAR","ZMW","ZWL"],"isRequired":true,"uniqueKey":"balances.items.[INDEX].eligibility.oneOf.0.success.currency","typeLabel":"enum\u003cstring>"}},"isRequired":true,"uniqueKey":"balances.items.[INDEX].eligibility.oneOf.0.success","typeLabel":"object"}},"isRequired":true,"uniqueKey":"balances.items.[INDEX].eligibility.oneOf.0","typeLabel":"object"},{"type":"object","required":["failure"],"properties":{"failure":{"type":"object","required":["error"],"properties":{"error":{"type":"string","isRequired":true,"uniqueKey":"balances.items.[INDEX].eligibility.oneOf.1.failure.error","typeLabel":"string"}},"isRequired":true,"uniqueKey":"balances.items.[INDEX].eligibility.oneOf.1.failure","typeLabel":"object"}},"isRequired":true,"uniqueKey":"balances.items.[INDEX].eligibility.oneOf.1","typeLabel":"object"}],"isRequired":true,"uniqueKey":"balances.items.[INDEX].eligibility","typeLabel":"object"}},"uniqueKey":"balances.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"balances","typeLabel":"object[]"},"remaining_amount":{"type":"integer","format":"int64","description":"This Unit struct represents MinorUnit in which core amount works","isRequired":true,"uniqueKey":"remaining_amount","typeLabel":"integer\u003cint64>"},"currency":{"type":"string","description":"The three-letter ISO 4217 currency code (e.g., \"USD\", \"EUR\") for the payment amount. This field is mandatory for creating a payment.","enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BRL","BSD","BTN","BWP","BYN","BZD","CAD","CDF","CHF","CLF","CLP","CNY","COP","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLE","SLL","SOS","SRD","SSP","STD","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","UYU","UZS","VES","VND","VUV","WST","XAF","XCD","XOF","XPF","YER","ZAR","ZMW","ZWL"],"isRequired":true,"uniqueKey":"currency","typeLabel":"enum\u003cstring>"},"requires_additional_pm_data":{"type":"boolean","description":"Whether the applied payment method balance is enough for the order amount or additional PM is required","isRequired":true,"uniqueKey":"requires_additional_pm_data","typeLabel":"boolean"},"surcharge_details":{"oneOf":[{"type":"array","items":{"type":"object","required":["payment_method_type","payment_method_subtype"],"properties":{"payment_method_type":{"type":"string","description":"Indicates the type of payment method. Eg: 'card', 'wallet', etc.","enum":["card","card_redirect","pay_later","wallet","bank_redirect","bank_transfer","crypto","bank_debit","reward","real_time_payment","upi","voucher","gift_card","open_banking","mobile_payment","network_token"],"isRequired":true,"uniqueKey":"surcharge_details.oneOf.0.items.[INDEX].payment_method_type","typeLabel":"enum\u003cstring>"},"payment_method_subtype":{"type":"string","description":"Indicates the sub type of payment method. Eg: 'google_pay' \u0026 'apple_pay' for wallets.","enum":["ach","affirm","afterpay_clearpay","alfamart","ali_pay","ali_pay_hk","alma","amazon_pay","paysera","apple_pay","atome","bacs","bancontact_card","becs","benefit","bizum","blik","bluecode","boleto","bca_bank_transfer","bni_va","breadpay","bri_va","bhn_card_network","card_redirect","cimb_va","classic","credit","crypto_currency","cashapp","dana","danamon_va","debit","duit_now","efecty","eft","eps","flexiti","fps","evoucher","giropay","givex","google_pay","go_pay","gcash","ideal","interac","indomaret","klarna","kakao_pay","local_bank_redirect","mandiri_va","knet","mb_way","mobile_pay","momo","momo_atm","multibanco","online_banking_thailand","online_banking_czech_republic","online_banking_finland","online_banking_fpx","online_banking_poland","online_banking_slovakia","oxxo","pago_efectivo","permata_bank_transfer","open_banking_uk","pay_bright","payjustnow","paypal","paze","pix","pay_safe_card","przelewy24","prompt_pay","pse","qris","red_compra","red_pagos","samsung_pay","sepa","sepa_bank_transfer","sepa_guarenteed_debit","skrill","sofort","swish","touch_n_go","trustly","twint","upi_collect","upi_intent","upi_qr","vipps","viet_qr","venmo","walley","we_chat_pay","seven_eleven","lawson","mini_stop","family_mart","seicomart","pay_easy","local_bank_transfer","mifinity","open_banking_pis","direct_carrier_billing","instant_bank_transfer","instant_bank_transfer_finland","instant_bank_transfer_poland","revolut_pay","indonesian_bank_transfer","open_banking","network_token"],"isRequired":true,"uniqueKey":"surcharge_details.oneOf.0.items.[INDEX].payment_method_subtype","typeLabel":"enum\u003cstring>"},"surcharge_details":{"oneOf":[{"type":"object","required":["surcharge","display_surcharge_amount","display_tax_on_surcharge_amount","display_total_surcharge_amount"],"properties":{"surcharge":{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["fixed"],"isRequired":true,"uniqueKey":"surcharge_details.oneOf.0.items.[INDEX].surcharge_details.oneOf.0.surcharge.oneOf.0.type","typeLabel":"enum\u003cstring>"},"value":{"type":"integer","format":"int64","description":"This Unit struct represents MinorUnit in which core amount works","isRequired":true,"uniqueKey":"surcharge_details.oneOf.0.items.[INDEX].surcharge_details.oneOf.0.surcharge.oneOf.0.value","typeLabel":"integer\u003cint64>"}},"isRequired":true,"uniqueKey":"surcharge_details.oneOf.0.items.[INDEX].surcharge_details.oneOf.0.surcharge.oneOf.0","typeLabel":"object"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["rate"],"isRequired":true,"uniqueKey":"surcharge_details.oneOf.0.items.[INDEX].surcharge_details.oneOf.0.surcharge.oneOf.1.type","typeLabel":"enum\u003cstring>"},"value":{"type":"object","required":["percentage"],"properties":{"percentage":{"type":"number","format":"float","isRequired":true,"uniqueKey":"surcharge_details.oneOf.0.items.[INDEX].surcharge_details.oneOf.0.surcharge.oneOf.1.value.percentage","typeLabel":"number\u003cfloat>"}},"isRequired":true,"uniqueKey":"surcharge_details.oneOf.0.items.[INDEX].surcharge_details.oneOf.0.surcharge.oneOf.1.value","typeLabel":"object"}},"isRequired":true,"uniqueKey":"surcharge_details.oneOf.0.items.[INDEX].surcharge_details.oneOf.0.surcharge.oneOf.1","typeLabel":"object"}],"isRequired":true,"uniqueKey":"surcharge_details.oneOf.0.items.[INDEX].surcharge_details.oneOf.0.surcharge","typeLabel":"object"},"display_surcharge_amount":{"type":"number","format":"double","description":"surcharge amount for this payment","isRequired":true,"uniqueKey":"surcharge_details.oneOf.0.items.[INDEX].surcharge_details.oneOf.0.display_surcharge_amount","typeLabel":"number\u003cdouble>"},"display_tax_on_surcharge_amount":{"type":"number","format":"double","description":"tax on surcharge amount for this payment","isRequired":true,"uniqueKey":"surcharge_details.oneOf.0.items.[INDEX].surcharge_details.oneOf.0.display_tax_on_surcharge_amount","typeLabel":"number\u003cdouble>"},"display_total_surcharge_amount":{"type":"number","format":"double","description":"sum of display_surcharge_amount and display_tax_on_surcharge_amount","isRequired":true,"uniqueKey":"surcharge_details.oneOf.0.items.[INDEX].surcharge_details.oneOf.0.display_total_surcharge_amount","typeLabel":"number\u003cdouble>"},"tax_on_surcharge":{"oneOf":[{"type":"object","required":["percentage"],"properties":{"percentage":{"type":"number","format":"float","isRequired":true,"uniqueKey":"surcharge_details.oneOf.0.items.[INDEX].surcharge_details.oneOf.0.tax_on_surcharge.oneOf.0.percentage","typeLabel":"number\u003cfloat>"}},"uniqueKey":"surcharge_details.oneOf.0.items.[INDEX].surcharge_details.oneOf.0.tax_on_surcharge.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"surcharge_details.oneOf.0.items.[INDEX].surcharge_details.oneOf.0.tax_on_surcharge.oneOf.1","typeLabel":"null"}],"uniqueKey":"surcharge_details.oneOf.0.items.[INDEX].surcharge_details.oneOf.0.tax_on_surcharge","typeLabel":"object | null"}},"uniqueKey":"surcharge_details.oneOf.0.items.[INDEX].surcharge_details.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"surcharge_details.oneOf.0.items.[INDEX].surcharge_details.oneOf.1","typeLabel":"null"}],"uniqueKey":"surcharge_details.oneOf.0.items.[INDEX].surcharge_details","typeLabel":"object | null"}},"uniqueKey":"surcharge_details.oneOf.0.items.[INDEX]","typeLabel":"object"},"uniqueKey":"surcharge_details.oneOf.0","typeLabel":"object[]"},{"type":"null","items":{"type":"object","required":["payment_method_type","payment_method_subtype"],"properties":{"payment_method_type":{"type":"string","description":"Indicates the type of payment method. Eg: 'card', 'wallet', etc.","enum":["card","card_redirect","pay_later","wallet","bank_redirect","bank_transfer","crypto","bank_debit","reward","real_time_payment","upi","voucher","gift_card","open_banking","mobile_payment","network_token"]},"payment_method_subtype":{"type":"string","description":"Indicates the sub type of payment method. Eg: 'google_pay' \u0026 'apple_pay' for wallets.","enum":["ach","affirm","afterpay_clearpay","alfamart","ali_pay","ali_pay_hk","alma","amazon_pay","paysera","apple_pay","atome","bacs","bancontact_card","becs","benefit","bizum","blik","bluecode","boleto","bca_bank_transfer","bni_va","breadpay","bri_va","bhn_card_network","card_redirect","cimb_va","classic","credit","crypto_currency","cashapp","dana","danamon_va","debit","duit_now","efecty","eft","eps","flexiti","fps","evoucher","giropay","givex","google_pay","go_pay","gcash","ideal","interac","indomaret","klarna","kakao_pay","local_bank_redirect","mandiri_va","knet","mb_way","mobile_pay","momo","momo_atm","multibanco","online_banking_thailand","online_banking_czech_republic","online_banking_finland","online_banking_fpx","online_banking_poland","online_banking_slovakia","oxxo","pago_efectivo","permata_bank_transfer","open_banking_uk","pay_bright","payjustnow","paypal","paze","pix","pay_safe_card","przelewy24","prompt_pay","pse","qris","red_compra","red_pagos","samsung_pay","sepa","sepa_bank_transfer","sepa_guarenteed_debit","skrill","sofort","swish","touch_n_go","trustly","twint","upi_collect","upi_intent","upi_qr","vipps","viet_qr","venmo","walley","we_chat_pay","seven_eleven","lawson","mini_stop","family_mart","seicomart","pay_easy","local_bank_transfer","mifinity","open_banking_pis","direct_carrier_billing","instant_bank_transfer","instant_bank_transfer_finland","instant_bank_transfer_poland","revolut_pay","indonesian_bank_transfer","open_banking","network_token"]},"surcharge_details":{"oneOf":[{"type":"object","required":["surcharge","display_surcharge_amount","display_tax_on_surcharge_amount","display_total_surcharge_amount"],"properties":{"surcharge":{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["fixed"]},"value":{"type":"integer","format":"int64","description":"This Unit struct represents MinorUnit in which core amount works"}}},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["rate"]},"value":{"type":"object","required":["percentage"],"properties":{"percentage":{"type":"number","format":"float"}}}}}]},"tax_on_surcharge":{"oneOf":[{"type":"object","required":["percentage"],"properties":{"percentage":{"type":"number","format":"float"}}},{"type":"null"}]},"display_surcharge_amount":{"type":"number","format":"double","description":"surcharge amount for this payment"},"display_tax_on_surcharge_amount":{"type":"number","format":"double","description":"tax on surcharge amount for this payment"},"display_total_surcharge_amount":{"type":"number","format":"double","description":"sum of display_surcharge_amount and display_tax_on_surcharge_amount"}}},{"type":"null"}]}}},"uniqueKey":"surcharge_details.oneOf.1","typeLabel":"null"}],"uniqueKey":"surcharge_details","typeLabel":"object[] | null"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"balances":[{"payment_method_data":{"gift_card":{"givex":{"number":"\u003cstring>","cvc":"\u003cstring>"}}},"eligibility":{"success":{"balance":123,"applicable_amount":123,"currency":"AED"}}}],"remaining_amount":123,"currency":"AED","requires_additional_pm_data":true,"surcharge_details":[{"payment_method_type":"card","payment_method_subtype":"ach","surcharge_details":{"surcharge":{"type":"fixed","value":123},"display_surcharge_amount":123,"display_tax_on_surcharge_amount":123,"display_total_surcharge_amount":123,"tax_on_surcharge":{"percentage":123}}}]}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"a5e6af04-a09d-4396-91d1-61a00f44dc21":{"publishable_key__client_secret":{"type":"apiKey","in":"header","name":"Authorization","description":"Format: `publishable-key=\u003cpublishable-key>,client-secret=\u003cclient-secret>`\n\nPublishable keys are a type of keys that can be public and have limited scope of usage. Client Secret provide temporary access to singular data, such as access to a single customer object for a short period of time. This authentication scheme is used by the SDK.","scopes":[]}}},"servers":{"f37e9e71-e224-445e-b50d-8bb9303c2220":{"url":"https://sandbox.birrpay.io","description":"Sandbox Environment"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"apiKey","in":"header","name":"Authorization","description":"Format: `publishable-key=\u003cpublishable-key>,client-secret=\u003cclient-secret>`\n\nPublishable keys are a type of keys that can be public and have limited scope of usage. Client Secret provide temporary access to singular data, such as access to a single customer object for a short period of time. This authentication scheme is used by the SDK.","scopes":[]},"schema":{"title":"Authorization","type":"string","description":"Format: `publishable-key=\u003cpublishable-key>,client-secret=\u003cclient-secret>`\n\nPublishable keys are a type of keys that can be public and have limited scope of usage. Client Secret provide temporary access to singular data, such as access to a single customer object for a short period of time. This authentication scheme is used by the SDK.","isRequired":true,"typeLabel":"string","deprecated":false},"schemeName":"publishable_key__client_secret","name":"Authorization"}],"title":"publishable_key__client_secret"}]},"originalFileLocation":"v2/openapi_spec_v2.json"},"subdomain":"birrpay","siteName":"BirrPay","title":"Payments - Check Balance and Apply PM Data - BirrPay","navMaps":{"firstHrefInVersion":{"1.0.0":{"href":"/introduction","matchLevel":3},"2.0.0 [BETA]":{"href":"/v2/payments/payments--check-balance-and-apply-pm-data","matchLevel":0}},"firstHrefInLanguage":{}},"lastModified":"2026-01-24T02:55:16.648Z","originalFileLocation":"v2/payments/payments--check-balance-and-apply-pm-data.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Check the balance of the payment methods, apply the payment method data and recalculate remaining_amount and surcharge\">\u003cmeta data-mint-head name=\"application-name\" content=\"BirrPay\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/birrpay/UMKKiD5ajm4x882S/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/birrpay/UMKKiD5ajm4x882S/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/birrpay/UMKKiD5ajm4x882S/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/birrpay/UMKKiD5ajm4x882S/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/birrpay/UMKKiD5ajm4x882S/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/birrpay/UMKKiD5ajm4x882S/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/birrpay/UMKKiD5ajm4x882S/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/birrpay/UMKKiD5ajm4x882S/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/birrpay/UMKKiD5ajm4x882S/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Payments - Check Balance and Apply PM Data - BirrPay\">\u003cmeta data-mint-head property=\"og:description\" content=\"Check the balance of the payment methods, apply the payment method data and recalculate remaining_amount and surcharge\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"BirrPay\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.birrpay.io/v2/payments/payments--check-balance-and-apply-pm-data\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://birrpay.mintlify.app/_mintlify/api/og/v2?division=Payments\u0026amp;title=Payments+-+Check+Balance+and+Apply+PM+Data\u0026amp;description=Check+the+balance+of+the+payment+methods%2C+apply+the+payment+method+data+and+recalculate+remaining_amount+and+surcharge\u0026amp;theme=838cc079bd3fa932cbeee950\u0026amp;signature=8eddaf76e6e3e92f5f286d40000e5b86efa3ae59b870680ede1cb8f93554db1e\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Payments - Check Balance and Apply PM Data - BirrPay\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Check the balance of the payment methods, apply the payment method data and recalculate remaining_amount and surcharge\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://birrpay.mintlify.app/_mintlify/api/og/v2?division=Payments\u0026amp;title=Payments+-+Check+Balance+and+Apply+PM+Data\u0026amp;description=Check+the+balance+of+the+payment+methods%2C+apply+the+payment+method+data+and+recalculate+remaining_amount+and+surcharge\u0026amp;theme=838cc079bd3fa932cbeee950\u0026amp;signature=8eddaf76e6e3e92f5f286d40000e5b86efa3ae59b870680ede1cb8f93554db1e\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/birrpay/UMKKiD5ajm4x882S/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"BirrPay\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#4F8EFF\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.birrpay.io/v2/payments/payments--check-balance-and-apply-pm-data\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/v2/payments/payments--check-balance-and-apply-pm-data.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.birrpay.io/#organization\",\"name\":\"BirrPay\",\"url\":\"https://docs.birrpay.io\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/birrpay/YnpImjYt65LKI-RI/logo/light.svg?fit=max\u0026auto=format\u0026n=YnpImjYt65LKI-RI\u0026q=85\u0026s=410fca5e1e3112fa410bfe0f1bc67731\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.birrpay.io#website\",\"name\":\"BirrPay\",\"url\":\"https://docs.birrpay.io\",\"publisher\":{\"@id\":\"https://docs.birrpay.io/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.birrpay.io/v2/payments/payments--check-balance-and-apply-pm-data#webpage\",\"url\":\"https://docs.birrpay.io/v2/payments/payments--check-balance-and-apply-pm-data\",\"name\":\"Payments - Check Balance and Apply PM Data\",\"description\":\"Check the balance of the payment methods, apply the payment method data and recalculate remaining_amount and surcharge\",\"dateModified\":\"2026-01-24T02:55:16.648Z\",\"isPartOf\":{\"@id\":\"https://docs.birrpay.io#website\"},\"breadcrumb\":{\"@id\":\"https://docs.birrpay.io/v2/payments/payments--check-balance-and-apply-pm-data#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.birrpay.io/v2/payments/payments--check-balance-and-apply-pm-data#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Payments Core APIs [BETA]\",\"item\":\"https://docs.birrpay.io/v2/payments/payments--create-intent\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Payments\",\"item\":\"https://docs.birrpay.io/v2/payments/payments--create-intent\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Payments - Check Balance and Apply PM Data\",\"item\":\"https://docs.birrpay.io/v2/payments/payments--check-balance-and-apply-pm-data\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.birrpay.io/v2/payments/payments--check-balance-and-apply-pm-data#apireference\",\"headline\":\"Payments - Check Balance and Apply PM Data\",\"name\":\"Payments - Check Balance and Apply PM Data\",\"description\":\"Check the balance of the payment methods, apply the payment method data and recalculate remaining_amount and surcharge\",\"url\":\"https://docs.birrpay.io/v2/payments/payments--check-balance-and-apply-pm-data\",\"mainEntityOfPage\":{\"@id\":\"https://docs.birrpay.io/v2/payments/payments--check-balance-and-apply-pm-data#webpage\"},\"dateModified\":\"2026-01-24T02:55:16.648Z\",\"publisher\":{\"@id\":\"https://docs.birrpay.io/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.birrpay.io#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"BirrPay\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"BirrPay","nav":{"global":null,"tabs":[{"tab":"Documentation","versions":[{"version":"1.0.0","pages":[{"title":"1.0.0","href":"/introduction"}]},{"version":"2.0.0 [BETA]","groups":[{"group":"Get Started [BETA]","pages":[{"title":"👋 Welcome to BirrPay API Reference","sidebarTitle":"Introduction","icon":"rectangle-code","iconType":"solid","href":"/introduction","hidden":false}]},{"group":"Essentials [BETA]","pages":[{"title":"Error Codes","href":"/essentials/error_codes"},{"title":"Rate Limits","href":"/essentials/rate_limit"},{"title":"Go-live Checklist","href":"/essentials/go-live"}]},{"group":"Payments Core APIs [BETA]","pages":[{"group":"Payments","pages":[{"openapi":"post /v2/payments/create-intent","title":"Payments - Create Intent","href":"/v2/payments/payments--create-intent"},{"openapi":"get /v2/payments/{id}/get-intent","title":"Payments - Get Intent","href":"/v2/payments/payments--get-intent"},{"openapi":"put /v2/payments/{id}/update-intent","title":"Payments - Update Intent","href":"/v2/payments/payments--update-intent"},{"openapi":"post /v2/payments/{payment_id}/create-external-sdk-tokens","title":"Payments - Session token","href":"/v2/payments/payments--session-token"},{"openapi":"get /v2/payments/{id}/payment-methods","title":"Payments - Payment Methods List","href":"/v2/payments/payments--payment-methods-list"},{"openapi":"post /v2/payments/{id}/confirm-intent","title":"Payments - Confirm Intent","href":"/v2/payments/payments--confirm-intent"},{"openapi":"get /v2/payments/{id}","title":"Payments - Get","href":"/v2/payments/payments--get"},{"openapi":"post /v2/payments","title":"Payments - Create and Confirm Intent","href":"/v2/payments/payments--create-and-confirm-intent"},{"openapi":"get /v2/payments/list","title":"Payments - List","description":"To list the *payments*","href":"/v2/payments/payments--list"},{"openapi":"post /v2/payments/{id}/eligibility/check-balance-and-apply-pm-data","title":"Payments - Check Balance and Apply PM Data","href":"/v2/payments/payments--check-balance-and-apply-pm-data"}]},{"group":"Payment Methods","pages":[{"openapi":"post /v2/payment-methods","title":"Payment Method - Create","description":"Creates and stores a payment method against a customer. In case of cards, this API should be used only by PCI compliant merchants.","href":"/v2/payment-methods/payment-method--create"},{"openapi":"post /v2/payment-methods/create-intent","title":"Payment Method - Create Intent","href":"/v2/payment-methods/payment-method--create-intent"},{"openapi":"post /v2/payment-methods/{id}/confirm-intent","title":"Payment Method - Confirm Intent","href":"/v2/payment-methods/payment-method--confirm-intent"},{"openapi":"patch /v2/payment-methods/{id}/update-saved-payment-method","title":"Payment Method - Update","href":"/v2/payment-methods/payment-method--update"},{"openapi":"get /v2/payment-methods/{id}","title":"Payment Method - Retrieve","href":"/v2/payment-methods/payment-method--retrieve"},{"openapi":"delete /v2/payment-methods/{id}","title":"Payment Method - Delete","href":"/v2/payment-methods/payment-method--delete"},{"openapi":"get /v2/customers/{id}/saved-payment-methods","title":"Payment Method - List Customer Saved Payment Methods","href":"/v2/payment-methods/payment-method--list-customer-saved-payment-methods"},{"title":"List saved payment methods for a customer","href":"/v2/payment-methods/list-saved-payment-methods-for-a-customer"}]},{"group":"Network Tokenization","pages":[{"title":"Check network token status","href":"/v2/payment-methods/check-network-token-status"}]},{"group":"Payment Method Session","pages":[{"openapi":"post /v2/payment-method-sessions","title":"Payment Method Session - Create","href":"/v2/payment-method-session/payment-method-session--create"},{"openapi":"get /v2/payment-method-sessions/{id}","title":"Payment Method Session - Retrieve","href":"/v2/payment-method-session/payment-method-session--retrieve"},{"openapi":"get /v2/payment-method-sessions/{id}/list-payment-methods","title":"Payment Method Session - List Payment Methods","href":"/v2/payment-method-session/payment-method-session--list-payment-methods"},{"openapi":"put /v2/payment-method-sessions/{id}/update-saved-payment-method","title":"Payment Method Session - Update a saved payment method","href":"/v2/payment-method-session/payment-method-session--update-a-saved-payment-method"},{"openapi":"post /v2/payment-method-sessions/{id}/confirm","title":"Payment Method Session - Confirm a payment method session","href":"/v2/payment-method-session/payment-method-session--confirm-a-payment-method-session"},{"openapi":"delete /v2/payment-method-sessions/{id}","title":"Payment Method Session - Delete a saved payment method","href":"/v2/payment-method-session/payment-method-session--delete-a-saved-payment-method"}]},{"group":"Customers","pages":[{"openapi":"post /v2/customers","title":"Customers - Create","href":"/v2/customers/customers--create"},{"openapi":"get /v2/customers/{id}","title":"Customers - Retrieve","href":"/v2/customers/customers--retrieve"},{"openapi":"post /v2/customers/{id}","title":"Customers - Update","href":"/v2/customers/customers--update"},{"openapi":"delete /v2/customers/{id}","title":"Customers - Delete","href":"/v2/customers/customers--delete"},{"openapi":"get /v2/customers/list","title":"Customers - List","href":"/v2/customers/customers--list"}]},{"group":"Refunds","pages":[{"openapi":"post /v2/refunds","title":"Refunds - Create","href":"/v2/refunds/refunds--create"},{"openapi":"put /v2/refunds/{id}/update_metadata","title":null,"href":"/v2/refunds/refunds--metadata-update"},{"openapi":"get /v2/refunds/{id}","title":"Refunds - Retrieve","href":"/v2/refunds/refunds--retrieve"},{"openapi":"post /v2/refunds/list","title":"Refunds - List","href":"/v2/refunds/refunds--list"}]}]},{"group":"Account management APIs [BETA]","pages":[{"group":"Organization","pages":[{"openapi":"post /v2/organizations","title":"Organization - Create","href":"/v2/organization/organization--create"},{"openapi":"get /v2/organizations/{id}","title":"Organization - Retrieve","href":"/v2/organization/organization--retrieve"},{"openapi":"put /v2/organizations/{id}","title":"Organization - Update","href":"/v2/organization/organization--update"},{"openapi":"get /v2/organizations/{id}/merchant-accounts","title":"Organization - Merchant Account - List","href":"/v2/organization/organization--merchant-account--list"}]},{"group":"Merchant Account","pages":[{"openapi":"post /v2/merchant-accounts","title":"Merchant Account - Create","href":"/v2/merchant-account/merchant-account--create"},{"openapi":"get /v2/merchant-accounts/{id}","title":"Merchant Account - Retrieve","href":"/v2/merchant-account/merchant-account--retrieve"},{"openapi":"put /v2/merchant-accounts/{id}","title":"Merchant Account - Update","href":"/v2/merchant-account/merchant-account--update"},{"openapi":"get /v2/merchant-accounts/{id}/profiles","title":"Merchant Account - Profile List","href":"/v2/merchant-account/business-profile--list"}]},{"group":"Profile","pages":[{"openapi":"post /v2/profiles","title":"Profile - Create","href":"/v2/profile/profile--create"},{"openapi":"put /v2/profiles/{id}","title":"Profile - Update","href":"/v2/profile/profile--update"},{"openapi":"patch /v2/profiles/{id}/activate-routing-algorithm","title":"Profile - Activate routing algorithm","href":"/v2/profile/profile--activate-routing-algorithm"},{"openapi":"patch /v2/profiles/{id}/fallback-routing","title":"Profile - Update Default Fallback Routing Algorithm","href":"/v2/profile/profile--update-default-fallback-routing-algorithm"},{"openapi":"patch /v2/profiles/{id}/deactivate-routing-algorithm","title":"Profile - Deactivate routing algorithm","href":"/v2/profile/profile--deactivate-routing-algorithm"},{"openapi":"get /v2/profiles/{id}","title":"Profile - Retrieve","href":"/v2/profile/profile--retrieve"},{"openapi":"get /v2/profiles/{id}/connector-accounts","title":"Profile - Connector Accounts List","href":"/v2/profile/merchant-connector--list"},{"openapi":"get /v2/profiles/{id}/routing-algorithm","title":"Profile - Retrieve Active Routing Algorithm","href":"/v2/profile/profile--retrieve-active-routing-algorithm"},{"openapi":"get /v2/profiles/{id}/fallback-routing","title":"Profile - Retrieve Default Fallback Routing Algorithm","href":"/v2/profile/profile--retrieve-default-fallback-routing-algorithm"}]},{"group":"Connector Account","pages":[{"openapi":"post /v2/connector-accounts","title":"Connector Account - Create","href":"/v2/connector-account/connector-account--create"},{"openapi":"get /v2/connector-accounts/{id}","title":"Connector Account - Retrieve","href":"/v2/connector-account/connector-account--retrieve"},{"openapi":"put /v2/connector-accounts/{id}","title":"Connector Account - Update","href":"/v2/connector-account/connector-account--update"}]},{"group":"API Key","pages":[{"openapi":"post /v2/api-keys","title":"API Key - Create","href":"/v2/api-key/api-key--create"},{"openapi":"get /v2/api-keys/{id}","title":"API Key - Retrieve","href":"/v2/api-key/api-key--retrieve"},{"openapi":"put /v2/api-keys/{id}","title":"API Key - Update","href":"/v2/api-key/api-key--update"},{"openapi":"delete /v2/api-keys/{id}","title":"API Key - Revoke","href":"/v2/api-key/api-key--revoke"},{"openapi":"get /v2/api-keys/list","title":"API Key - List","href":"/v2/api-key/api-key--list"}]},{"group":"Routing","pages":[{"openapi":"post /v2/routing-algorithms","title":"Routing - Create","href":"/v2/routing/routing--create"},{"openapi":"get /v2/routing-algorithms/{id}","title":"Routing - Retrieve","href":"/v2/routing/routing--retrieve"}]}]},{"group":"Other APIs [BETA]","pages":[{"group":"Proxy","pages":[{"openapi":"post /proxy","title":"Proxy","href":"/v2/proxy/proxy"}]},{"group":"Tokenization","pages":[{"openapi":"post /v2/tokenize","title":"Tokenization - Create","href":"/v2/tokenization/tokenization--create"}]},{"group":"Revenue Recovery","pages":[{"openapi":"get /v2/process-trackers/revenue-recovery-workflow/{revenue_recovery_id}","title":"Revenue Recovery - Retrieve","href":"/v2/revenue-recovery/revenue-recovery--retrieve"}]}]}]}]},{"tab":"Locker API Reference","pages":[{"title":"Locker API Reference","href":"/locker-api-reference/overview"}]},{"tab":"Intelligent Router API Reference","pages":[{"title":"Intelligent Router API Reference","href":"/intelligent-router-api-reference/overview"}]}]},"title":"Payments - Check Balance and Apply PM Data - BirrPay","buildId":"dpl_849ArpqvBiCczQiT1Y1stNGpbqHT","deploymentId":"dpl_849ArpqvBiCczQiT1Y1stNGpbqHT","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-Bbp7I60D.js","utils-C3RIvJha.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-DqD-vLt8.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-B31Loprg.js","snippetPresets-DKpk-b8t.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-Cj65AhOR.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-BXtn5gcC.js","shallow-RY2b03Cp.js","getApiPlaygroundDisplay-B0jeiPk3.js","CodeSnippet-CYgBjjwn.js","CodeSnippets-DOngDrYB.js","Page-n7I5XbKb.js","getPastedJson-DRQbJx-T.js","icon-CQiQCicY.js","MethodPill-BKTLdNtu.js","DuplicateIcon-B9jpAdat.js","createIcon-DCddRrXv.js","DynamicMarkdown-a8hUKrw6.js","SectionHeading-eECVV2eH.js","axios-vUo_bRtp.js","Markdown--GF7ZIpf.js","clsx-DZLdJUrt.js","lib--scc4DXi.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-2LoAhjKH.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-Zwc0ZncM.js"]}