Admin API keys allow you to perform some privileged actions such as creating a merchant account and Connector account. This is only used during development.
{"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/connector-account/connector-account--retrieve","slug":"/v2/connector-account/connector-account--retrieve","pageMetadata":{"openapi":"get /v2/connector-accounts/{id}","title":"Connector Account - Retrieve","description":"Retrieves details of a Connector account","href":"/v2/connector-account/connector-account--retrieve","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: \"Retrieves details of a Connector account\"\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":"get /v2/connector-accounts/{id}","title":"Connector Account - Retrieve","description":"Retrieves details of a Connector account","href":"/v2/connector-account/connector-account--retrieve","hidden":false}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"tags":["Merchant Connector Account"],"summary":"Connector Account - Retrieve","description":"Retrieves details of a Connector account","operationId":"Retrieve a Merchant Connector","parameters":["dea4ade9-7e82-4077-83c9-bcf721395096"],"responses":{"200":"14ce2680-7334-442c-8fac-5d1fbcfe8f9e","401":"0a88c088-a9b1-46e6-8f33-fe1975b3cb0e","404":"17ea7c41-dcc4-4dc5-9db7-767b945e639b"},"security":["bebdc7cb-eb2c-4392-be67-80cbeeaf103e"],"method":"get","type":"path","servers":["f37e9e71-e224-445e-b50d-8bb9303c2220"],"path":"/v2/connector-accounts/{id}","baseUrlOptions":["https://sandbox.birrpay.io"],"title":"Connector Account - Retrieve","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"dea4ade9-7e82-4077-83c9-bcf721395096":{"name":"id","in":"path","description":"The unique identifier for the Merchant Connector","required":true,"schema":{"type":"integer","format":"int32","isRequired":true,"description":"The unique identifier for the Merchant Connector","uniqueKey":"","typeLabel":"integer\u003cint32>"}}},"responses":{"14ce2680-7334-442c-8fac-5d1fbcfe8f9e":{"description":"Merchant Connector retrieved successfully","content":{"application/json":{"schema":{"type":"object","description":"Response of creating a new Merchant Connector for the merchant account.\"","required":["connector_type","connector_name","id","profile_id","payment_methods_enabled","status"],"properties":{"connector_type":{"type":"string","description":"Type of the Connector for the financial use case. Could range from Payments to Accounting to Banking.","enum":["payment_processor","payment_vas","fin_operations","fiz_operations","networks","banking_entities","non_banking_finance","payout_processor","payment_method_auth","authentication_processor","tax_processor","billing_processor","vault_processor"],"isRequired":true,"uniqueKey":"connector_type","typeLabel":"enum\u003cstring>"},"connector_name":{"type":"string","enum":["authipay","adyenplatform","stripe_billing_test","phonypay","fauxpay","pretendpay","stripe_test","adyen_test","checkout_test","paypal_test","aci","adyen","affirm","airwallex","amazonpay","archipel","authorizedotnet","bambora","bamboraapac","bankofamerica","barclaycard","billwerk","bitpay","bluesnap","blackhawknetwork","calida","boku","braintree","breadpay","cardinal","cashtocode","celero","chargebee","checkbook","checkout","coinbase","coingate","custombilling","cryptopay","ctp_mastercard","ctp_visa","cybersource","datatrans","deutschebank","digitalvirgo","dlocal","dwolla","ebanx","elavon","facilitapay","finix","fiserv","fiservemea","fiuu","flexiti","forte","getnet","gigadat","globalpay","globepay","gocardless","gpayments","hipay","helcim","hyperswitch_vault","inespay","iatapay","itaubank","jpmorgan","juspaythreedsserver","klarna","loonio","mifinity","mollie","moneris","multisafepay","netcetera","nexinets","nexixpay","nmi","nomupay","noon","nordea","novalnet","nuvei","opennode","paybox","payload","payme","payone","paypal","paysafe","paystack","paytm","payu","peachpayments","payjustnow","payjustnowinstore","phonepe","placetopay","powertranz","prophetpay","rapyd","razorpay","recurly","redsys","santander","shift4","silverflow","square","stax","stripe","stripebilling","taxjar","threedsecureio","tesouro","tokenex","tokenio","trustpay","trustpayments","tsys","vgs","volt","wellsfargo","wise","worldline","worldpay","worldpayvantiv","worldpayxml","worldpaymodular","signifyd","plaid","riskified","xendit","zen","zift","zsl"],"isRequired":true,"uniqueKey":"connector_name","typeLabel":"enum\u003cstring>"},"id":{"type":"string","description":"Unique ID of the merchant connector account","example":"mca_5apGeP94tMts6rg3U3kR","isRequired":true,"uniqueKey":"id","typeLabel":"string"},"profile_id":{"type":"string","description":"Identifier for the profile, if not provided default will be chosen from merchant account","maxLength":64,"isRequired":true,"uniqueKey":"profile_id","typeLabel":"string"},"payment_methods_enabled":{"type":"array","items":{"type":"object","description":"Details of all the payment methods enabled for the connector for the given merchant account","required":["payment_method_type"],"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":"payment_methods_enabled.items.[INDEX].payment_method_type","typeLabel":"enum\u003cstring>"},"payment_method_subtypes":{"oneOf":[{"type":"array","items":{"type":"object","required":["payment_method_type"],"properties":{"payment_method_type":{"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":"payment_methods_enabled.items.[INDEX].payment_method_subtypes.oneOf.0.items.[INDEX].payment_method_type","typeLabel":"enum\u003cstring>"},"payment_experience":{"oneOf":[{"type":"string","description":"To indicate the type of payment experience that the customer would go through","enum":["redirect_to_url","invoke_sdk_client","display_qr_code","one_click","link_wallet","invoke_payment_app","display_wait_screen","collect_otp"],"uniqueKey":"payment_methods_enabled.items.[INDEX].payment_method_subtypes.oneOf.0.items.[INDEX].payment_experience.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","uniqueKey":"payment_methods_enabled.items.[INDEX].payment_method_subtypes.oneOf.0.items.[INDEX].payment_experience.oneOf.1","typeLabel":"null"}],"uniqueKey":"payment_methods_enabled.items.[INDEX].payment_method_subtypes.oneOf.0.items.[INDEX].payment_experience","typeLabel":"enum\u003cstring> | null"},"card_networks":{"oneOf":[{"type":"array","items":{"type":"string","description":"Indicates the card network.","enum":["Visa","Mastercard","AmericanExpress","JCB","DinersClub","Discover","CartesBancaires","UnionPay","Interac","RuPay","Maestro","Star","Pulse","Accel","Nyce"],"uniqueKey":"payment_methods_enabled.items.[INDEX].payment_method_subtypes.oneOf.0.items.[INDEX].card_networks.oneOf.0.items.[INDEX]","typeLabel":"enum\u003cstring>"},"uniqueKey":"payment_methods_enabled.items.[INDEX].payment_method_subtypes.oneOf.0.items.[INDEX].card_networks.oneOf.0","typeLabel":"enum\u003cstring>[]"},{"type":"null","items":{"type":"string","description":"Indicates the card network.","enum":["Visa","Mastercard","AmericanExpress","JCB","DinersClub","Discover","CartesBancaires","UnionPay","Interac","RuPay","Maestro","Star","Pulse","Accel","Nyce"]},"uniqueKey":"payment_methods_enabled.items.[INDEX].payment_method_subtypes.oneOf.0.items.[INDEX].card_networks.oneOf.1","typeLabel":"null"}],"uniqueKey":"payment_methods_enabled.items.[INDEX].payment_method_subtypes.oneOf.0.items.[INDEX].card_networks","typeLabel":"enum\u003cstring>[] | null"},"accepted_currencies":{"oneOf":[{"type":"object","required":["type","list"],"properties":{"type":{"type":"string","enum":["enable_only"],"isRequired":true,"uniqueKey":"payment_methods_enabled.items.[INDEX].payment_method_subtypes.oneOf.0.items.[INDEX].accepted_currencies.oneOf.0.type","typeLabel":"enum\u003cstring>"},"list":{"type":"array","items":{"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"],"uniqueKey":"payment_methods_enabled.items.[INDEX].payment_method_subtypes.oneOf.0.items.[INDEX].accepted_currencies.oneOf.0.list.items.[INDEX]","typeLabel":"enum\u003cstring>"},"isRequired":true,"uniqueKey":"payment_methods_enabled.items.[INDEX].payment_method_subtypes.oneOf.0.items.[INDEX].accepted_currencies.oneOf.0.list","typeLabel":"enum\u003cstring>[]"}},"uniqueKey":"payment_methods_enabled.items.[INDEX].payment_method_subtypes.oneOf.0.items.[INDEX].accepted_currencies.oneOf.0","typeLabel":"object"},{"type":"object","required":["type","list"],"properties":{"type":{"type":"string","enum":["disable_only"],"isRequired":true,"uniqueKey":"payment_methods_enabled.items.[INDEX].payment_method_subtypes.oneOf.0.items.[INDEX].accepted_currencies.oneOf.1.type","typeLabel":"enum\u003cstring>"},"list":{"type":"array","items":{"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"],"uniqueKey":"payment_methods_enabled.items.[INDEX].payment_method_subtypes.oneOf.0.items.[INDEX].accepted_currencies.oneOf.1.list.items.[INDEX]","typeLabel":"enum\u003cstring>"},"isRequired":true,"uniqueKey":"payment_methods_enabled.items.[INDEX].payment_method_subtypes.oneOf.0.items.[INDEX].accepted_currencies.oneOf.1.list","typeLabel":"enum\u003cstring>[]"}},"uniqueKey":"payment_methods_enabled.items.[INDEX].payment_method_subtypes.oneOf.0.items.[INDEX].accepted_currencies.oneOf.1","typeLabel":"object"},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["all_accepted"],"isRequired":true,"uniqueKey":"payment_methods_enabled.items.[INDEX].payment_method_subtypes.oneOf.0.items.[INDEX].accepted_currencies.oneOf.2.type","typeLabel":"enum\u003cstring>"}},"uniqueKey":"payment_methods_enabled.items.[INDEX].payment_method_subtypes.oneOf.0.items.[INDEX].accepted_currencies.oneOf.2","typeLabel":"object"},{"type":"null","uniqueKey":"payment_methods_enabled.items.[INDEX].payment_method_subtypes.oneOf.0.items.[INDEX].accepted_currencies.oneOf.3","typeLabel":"null"}],"uniqueKey":"payment_methods_enabled.items.[INDEX].payment_method_subtypes.oneOf.0.items.[INDEX].accepted_currencies","typeLabel":"object · object · object · null"},"accepted_countries":{"oneOf":[{"type":"object","description":"Object to filter the customer countries for which the payment method is displayed","required":["type","list"],"properties":{"type":{"type":"string","enum":["enable_only"],"isRequired":true,"uniqueKey":"payment_methods_enabled.items.[INDEX].payment_method_subtypes.oneOf.0.items.[INDEX].accepted_countries.oneOf.0.type","typeLabel":"enum\u003cstring>"},"list":{"type":"array","items":{"type":"string","enum":["AF","AX","AL","DZ","AS","AD","AO","AI","AQ","AG","AR","AM","AW","AU","AT","AZ","BS","BH","BD","BB","BY","BE","BZ","BJ","BM","BT","BO","BQ","BA","BW","BV","BR","IO","BN","BG","BF","BI","KH","CM","CA","CV","KY","CF","TD","CL","CN","CX","CC","CO","KM","CG","CD","CK","CR","CI","HR","CU","CW","CY","CZ","DK","DJ","DM","DO","EC","EG","SV","GQ","ER","EE","ET","FK","FO","FJ","FI","FR","GF","PF","TF","GA","GM","GE","DE","GH","GI","GR","GL","GD","GP","GU","GT","GG","GN","GW","GY","HT","HM","VA","HN","HK","HU","IS","IN","ID","IR","IQ","IE","IM","IL","IT","JM","JP","JE","JO","KZ","KE","KI","KP","KR","KW","KG","LA","LV","LB","LS","LR","LY","LI","LT","LU","MO","MK","MG","MW","MY","MV","ML","MT","MH","MQ","MR","MU","YT","MX","FM","MD","MC","MN","ME","MS","MA","MZ","MM","NA","NR","NP","NL","NC","NZ","NI","NE","NG","NU","NF","MP","NO","OM","PK","PW","PS","PA","PG","PY","PE","PH","PN","PL","PT","PR","QA","RE","RO","RU","RW","BL","SH","KN","LC","MF","PM","VC","WS","SM","ST","SA","SN","RS","SC","SL","SG","SX","SK","SI","SB","SO","ZA","GS","SS","ES","LK","SD","SR","SJ","SZ","SE","CH","SY","TW","TJ","TZ","TH","TL","TG","TK","TO","TT","TN","TR","TM","TC","TV","UG","UA","AE","GB","UM","UY","UZ","VU","VE","VN","VG","VI","WF","EH","YE","ZM","ZW","US"],"uniqueKey":"payment_methods_enabled.items.[INDEX].payment_method_subtypes.oneOf.0.items.[INDEX].accepted_countries.oneOf.0.list.items.[INDEX]","typeLabel":"enum\u003cstring>"},"isRequired":true,"uniqueKey":"payment_methods_enabled.items.[INDEX].payment_method_subtypes.oneOf.0.items.[INDEX].accepted_countries.oneOf.0.list","typeLabel":"enum\u003cstring>[]"}},"uniqueKey":"payment_methods_enabled.items.[INDEX].payment_method_subtypes.oneOf.0.items.[INDEX].accepted_countries.oneOf.0","typeLabel":"object"},{"type":"object","description":"Object to filter the customer countries for which the payment method is displayed","required":["type","list"],"properties":{"type":{"type":"string","enum":["disable_only"],"isRequired":true,"uniqueKey":"payment_methods_enabled.items.[INDEX].payment_method_subtypes.oneOf.0.items.[INDEX].accepted_countries.oneOf.1.type","typeLabel":"enum\u003cstring>"},"list":{"type":"array","items":{"type":"string","enum":["AF","AX","AL","DZ","AS","AD","AO","AI","AQ","AG","AR","AM","AW","AU","AT","AZ","BS","BH","BD","BB","BY","BE","BZ","BJ","BM","BT","BO","BQ","BA","BW","BV","BR","IO","BN","BG","BF","BI","KH","CM","CA","CV","KY","CF","TD","CL","CN","CX","CC","CO","KM","CG","CD","CK","CR","CI","HR","CU","CW","CY","CZ","DK","DJ","DM","DO","EC","EG","SV","GQ","ER","EE","ET","FK","FO","FJ","FI","FR","GF","PF","TF","GA","GM","GE","DE","GH","GI","GR","GL","GD","GP","GU","GT","GG","GN","GW","GY","HT","HM","VA","HN","HK","HU","IS","IN","ID","IR","IQ","IE","IM","IL","IT","JM","JP","JE","JO","KZ","KE","KI","KP","KR","KW","KG","LA","LV","LB","LS","LR","LY","LI","LT","LU","MO","MK","MG","MW","MY","MV","ML","MT","MH","MQ","MR","MU","YT","MX","FM","MD","MC","MN","ME","MS","MA","MZ","MM","NA","NR","NP","NL","NC","NZ","NI","NE","NG","NU","NF","MP","NO","OM","PK","PW","PS","PA","PG","PY","PE","PH","PN","PL","PT","PR","QA","RE","RO","RU","RW","BL","SH","KN","LC","MF","PM","VC","WS","SM","ST","SA","SN","RS","SC","SL","SG","SX","SK","SI","SB","SO","ZA","GS","SS","ES","LK","SD","SR","SJ","SZ","SE","CH","SY","TW","TJ","TZ","TH","TL","TG","TK","TO","TT","TN","TR","TM","TC","TV","UG","UA","AE","GB","UM","UY","UZ","VU","VE","VN","VG","VI","WF","EH","YE","ZM","ZW","US"],"uniqueKey":"payment_methods_enabled.items.[INDEX].payment_method_subtypes.oneOf.0.items.[INDEX].accepted_countries.oneOf.1.list.items.[INDEX]","typeLabel":"enum\u003cstring>"},"isRequired":true,"uniqueKey":"payment_methods_enabled.items.[INDEX].payment_method_subtypes.oneOf.0.items.[INDEX].accepted_countries.oneOf.1.list","typeLabel":"enum\u003cstring>[]"}},"uniqueKey":"payment_methods_enabled.items.[INDEX].payment_method_subtypes.oneOf.0.items.[INDEX].accepted_countries.oneOf.1","typeLabel":"object"},{"type":"object","description":"Object to filter the customer countries for which the payment method is displayed","required":["type"],"properties":{"type":{"type":"string","enum":["all_accepted"],"isRequired":true,"uniqueKey":"payment_methods_enabled.items.[INDEX].payment_method_subtypes.oneOf.0.items.[INDEX].accepted_countries.oneOf.2.type","typeLabel":"enum\u003cstring>"}},"uniqueKey":"payment_methods_enabled.items.[INDEX].payment_method_subtypes.oneOf.0.items.[INDEX].accepted_countries.oneOf.2","typeLabel":"object"},{"type":"null","uniqueKey":"payment_methods_enabled.items.[INDEX].payment_method_subtypes.oneOf.0.items.[INDEX].accepted_countries.oneOf.3","typeLabel":"null"}],"uniqueKey":"payment_methods_enabled.items.[INDEX].payment_method_subtypes.oneOf.0.items.[INDEX].accepted_countries","typeLabel":"object · object · object · null"},"minimum_amount":{"oneOf":[{"type":"integer","description":"This Unit struct represents MinorUnit in which core amount works","format":"int64","uniqueKey":"payment_methods_enabled.items.[INDEX].payment_method_subtypes.oneOf.0.items.[INDEX].minimum_amount.oneOf.0","typeLabel":"integer\u003cint64>"},{"type":"null","uniqueKey":"payment_methods_enabled.items.[INDEX].payment_method_subtypes.oneOf.0.items.[INDEX].minimum_amount.oneOf.1","typeLabel":"null"}],"uniqueKey":"payment_methods_enabled.items.[INDEX].payment_method_subtypes.oneOf.0.items.[INDEX].minimum_amount","typeLabel":"integer\u003cint64> | null"},"maximum_amount":{"oneOf":[{"type":"integer","description":"This Unit struct represents MinorUnit in which core amount works","format":"int64","uniqueKey":"payment_methods_enabled.items.[INDEX].payment_method_subtypes.oneOf.0.items.[INDEX].maximum_amount.oneOf.0","typeLabel":"integer\u003cint64>"},{"type":"null","uniqueKey":"payment_methods_enabled.items.[INDEX].payment_method_subtypes.oneOf.0.items.[INDEX].maximum_amount.oneOf.1","typeLabel":"null"}],"uniqueKey":"payment_methods_enabled.items.[INDEX].payment_method_subtypes.oneOf.0.items.[INDEX].maximum_amount","typeLabel":"integer\u003cint64> | null"},"recurring_enabled":{"oneOf":[{"type":"boolean","description":"Indicates whether the payment method supports recurring payments. Optional.","example":false,"uniqueKey":"payment_methods_enabled.items.[INDEX].payment_method_subtypes.oneOf.0.items.[INDEX].recurring_enabled.oneOf.0","typeLabel":"boolean"},{"type":"null","description":"Indicates whether the payment method supports recurring payments. Optional.","example":false,"uniqueKey":"payment_methods_enabled.items.[INDEX].payment_method_subtypes.oneOf.0.items.[INDEX].recurring_enabled.oneOf.1","typeLabel":"null"}],"uniqueKey":"payment_methods_enabled.items.[INDEX].payment_method_subtypes.oneOf.0.items.[INDEX].recurring_enabled","typeLabel":"boolean | null"},"installment_payment_enabled":{"oneOf":[{"type":"boolean","description":"Indicates whether the payment method is eligible for installment payments (e.g., EMI, BNPL). Optional.","example":true,"uniqueKey":"payment_methods_enabled.items.[INDEX].payment_method_subtypes.oneOf.0.items.[INDEX].installment_payment_enabled.oneOf.0","typeLabel":"boolean"},{"type":"null","description":"Indicates whether the payment method is eligible for installment payments (e.g., EMI, BNPL). Optional.","example":true,"uniqueKey":"payment_methods_enabled.items.[INDEX].payment_method_subtypes.oneOf.0.items.[INDEX].installment_payment_enabled.oneOf.1","typeLabel":"null"}],"uniqueKey":"payment_methods_enabled.items.[INDEX].payment_method_subtypes.oneOf.0.items.[INDEX].installment_payment_enabled","typeLabel":"boolean | null"}},"uniqueKey":"payment_methods_enabled.items.[INDEX].payment_method_subtypes.oneOf.0.items.[INDEX]","typeLabel":"object"},"description":"Payment method configuration, this includes all the filters associated with the payment method","uniqueKey":"payment_methods_enabled.items.[INDEX].payment_method_subtypes.oneOf.0","typeLabel":"object[]"},{"type":"null","items":{"type":"object","required":["payment_method_type"],"properties":{"payment_method_type":{"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"]},"payment_experience":{"oneOf":[{"type":"string","description":"To indicate the type of payment experience that the customer would go through","enum":["redirect_to_url","invoke_sdk_client","display_qr_code","one_click","link_wallet","invoke_payment_app","display_wait_screen","collect_otp"]},{"type":"null"}]},"card_networks":{"oneOf":[{"type":"array","items":{"type":"string","description":"Indicates the card network.","enum":["Visa","Mastercard","AmericanExpress","JCB","DinersClub","Discover","CartesBancaires","UnionPay","Interac","RuPay","Maestro","Star","Pulse","Accel","Nyce"]}},{"type":"null","items":{"type":"string","description":"Indicates the card network.","enum":["Visa","Mastercard","AmericanExpress","JCB","DinersClub","Discover","CartesBancaires","UnionPay","Interac","RuPay","Maestro","Star","Pulse","Accel","Nyce"]}}]},"accepted_currencies":{"oneOf":[{"type":"object","required":["type","list"],"properties":{"type":{"type":"string","enum":["enable_only"]},"list":{"type":"array","items":{"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"]}}}},{"type":"object","required":["type","list"],"properties":{"type":{"type":"string","enum":["disable_only"]},"list":{"type":"array","items":{"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"]}}}},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["all_accepted"]}}},{"type":"null"}]},"accepted_countries":{"oneOf":[{"type":"object","description":"Object to filter the customer countries for which the payment method is displayed","required":["type","list"],"properties":{"type":{"type":"string","enum":["enable_only"]},"list":{"type":"array","items":{"type":"string","enum":["AF","AX","AL","DZ","AS","AD","AO","AI","AQ","AG","AR","AM","AW","AU","AT","AZ","BS","BH","BD","BB","BY","BE","BZ","BJ","BM","BT","BO","BQ","BA","BW","BV","BR","IO","BN","BG","BF","BI","KH","CM","CA","CV","KY","CF","TD","CL","CN","CX","CC","CO","KM","CG","CD","CK","CR","CI","HR","CU","CW","CY","CZ","DK","DJ","DM","DO","EC","EG","SV","GQ","ER","EE","ET","FK","FO","FJ","FI","FR","GF","PF","TF","GA","GM","GE","DE","GH","GI","GR","GL","GD","GP","GU","GT","GG","GN","GW","GY","HT","HM","VA","HN","HK","HU","IS","IN","ID","IR","IQ","IE","IM","IL","IT","JM","JP","JE","JO","KZ","KE","KI","KP","KR","KW","KG","LA","LV","LB","LS","LR","LY","LI","LT","LU","MO","MK","MG","MW","MY","MV","ML","MT","MH","MQ","MR","MU","YT","MX","FM","MD","MC","MN","ME","MS","MA","MZ","MM","NA","NR","NP","NL","NC","NZ","NI","NE","NG","NU","NF","MP","NO","OM","PK","PW","PS","PA","PG","PY","PE","PH","PN","PL","PT","PR","QA","RE","RO","RU","RW","BL","SH","KN","LC","MF","PM","VC","WS","SM","ST","SA","SN","RS","SC","SL","SG","SX","SK","SI","SB","SO","ZA","GS","SS","ES","LK","SD","SR","SJ","SZ","SE","CH","SY","TW","TJ","TZ","TH","TL","TG","TK","TO","TT","TN","TR","TM","TC","TV","UG","UA","AE","GB","UM","UY","UZ","VU","VE","VN","VG","VI","WF","EH","YE","ZM","ZW","US"]}}}},{"type":"object","description":"Object to filter the customer countries for which the payment method is displayed","required":["type","list"],"properties":{"type":{"type":"string","enum":["disable_only"]},"list":{"type":"array","items":{"type":"string","enum":["AF","AX","AL","DZ","AS","AD","AO","AI","AQ","AG","AR","AM","AW","AU","AT","AZ","BS","BH","BD","BB","BY","BE","BZ","BJ","BM","BT","BO","BQ","BA","BW","BV","BR","IO","BN","BG","BF","BI","KH","CM","CA","CV","KY","CF","TD","CL","CN","CX","CC","CO","KM","CG","CD","CK","CR","CI","HR","CU","CW","CY","CZ","DK","DJ","DM","DO","EC","EG","SV","GQ","ER","EE","ET","FK","FO","FJ","FI","FR","GF","PF","TF","GA","GM","GE","DE","GH","GI","GR","GL","GD","GP","GU","GT","GG","GN","GW","GY","HT","HM","VA","HN","HK","HU","IS","IN","ID","IR","IQ","IE","IM","IL","IT","JM","JP","JE","JO","KZ","KE","KI","KP","KR","KW","KG","LA","LV","LB","LS","LR","LY","LI","LT","LU","MO","MK","MG","MW","MY","MV","ML","MT","MH","MQ","MR","MU","YT","MX","FM","MD","MC","MN","ME","MS","MA","MZ","MM","NA","NR","NP","NL","NC","NZ","NI","NE","NG","NU","NF","MP","NO","OM","PK","PW","PS","PA","PG","PY","PE","PH","PN","PL","PT","PR","QA","RE","RO","RU","RW","BL","SH","KN","LC","MF","PM","VC","WS","SM","ST","SA","SN","RS","SC","SL","SG","SX","SK","SI","SB","SO","ZA","GS","SS","ES","LK","SD","SR","SJ","SZ","SE","CH","SY","TW","TJ","TZ","TH","TL","TG","TK","TO","TT","TN","TR","TM","TC","TV","UG","UA","AE","GB","UM","UY","UZ","VU","VE","VN","VG","VI","WF","EH","YE","ZM","ZW","US"]}}}},{"type":"object","description":"Object to filter the customer countries for which the payment method is displayed","required":["type"],"properties":{"type":{"type":"string","enum":["all_accepted"]}}},{"type":"null"}]},"minimum_amount":{"oneOf":[{"type":"integer","description":"This Unit struct represents MinorUnit in which core amount works","format":"int64"},{"type":"null"}]},"maximum_amount":{"oneOf":[{"type":"integer","description":"This Unit struct represents MinorUnit in which core amount works","format":"int64"},{"type":"null"}]},"recurring_enabled":{"oneOf":[{"type":"boolean","description":"Indicates whether the payment method supports recurring payments. Optional.","example":false},{"type":"null","description":"Indicates whether the payment method supports recurring payments. Optional.","example":false}]},"installment_payment_enabled":{"oneOf":[{"type":"boolean","description":"Indicates whether the payment method is eligible for installment payments (e.g., EMI, BNPL). Optional.","example":true},{"type":"null","description":"Indicates whether the payment method is eligible for installment payments (e.g., EMI, BNPL). Optional.","example":true}]}}},"description":"Payment method configuration, this includes all the filters associated with the payment method","uniqueKey":"payment_methods_enabled.items.[INDEX].payment_method_subtypes.oneOf.1","typeLabel":"null"}],"uniqueKey":"payment_methods_enabled.items.[INDEX].payment_method_subtypes","typeLabel":"object[] | null"}},"additionalProperties":false,"uniqueKey":"payment_methods_enabled.items.[INDEX]","typeLabel":"object"},"description":"An object containing the details about the payment methods that need to be enabled under this merchant connector account","isRequired":true,"uniqueKey":"payment_methods_enabled","typeLabel":"object[]"},"status":{"type":"string","enum":["inactive","active"],"isRequired":true,"uniqueKey":"status","typeLabel":"enum\u003cstring>"},"connector_label":{"oneOf":[{"type":"string","description":"A unique label to identify the connector account created under a profile","example":"stripe_US_travel","uniqueKey":"connector_label.oneOf.0","typeLabel":"string"},{"type":"null","description":"A unique label to identify the connector account created under a profile","example":"stripe_US_travel","uniqueKey":"connector_label.oneOf.1","typeLabel":"null"}],"uniqueKey":"connector_label","typeLabel":"string | null"},"connector_account_details":{"oneOf":[{"type":"object","properties":{"connector_account_details":{"oneOf":[{"type":"object","description":"Account details of the Connector. You can specify up to 50 keys, with key names up to 40 characters long and values up to 500 characters long. Useful for storing additional, structured information on an object.","uniqueKey":"connector_account_details.oneOf.0.connector_account_details.oneOf.0","typeLabel":"object"},{"type":"null","description":"Account details of the Connector. You can specify up to 50 keys, with key names up to 40 characters long and values up to 500 characters long. Useful for storing additional, structured information on an object.","uniqueKey":"connector_account_details.oneOf.0.connector_account_details.oneOf.1","typeLabel":"null"}],"uniqueKey":"connector_account_details.oneOf.0.connector_account_details","typeLabel":"object | null"},"metadata":{"oneOf":[{"type":"object","description":"Metadata is useful for storing additional, unstructured information on an object.","uniqueKey":"connector_account_details.oneOf.0.metadata.oneOf.0","typeLabel":"object"},{"type":"null","description":"Metadata is useful for storing additional, unstructured information on an object.","uniqueKey":"connector_account_details.oneOf.0.metadata.oneOf.1","typeLabel":"null"}],"uniqueKey":"connector_account_details.oneOf.0.metadata","typeLabel":"object | null"}},"uniqueKey":"connector_account_details.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"connector_account_details.oneOf.1","typeLabel":"null"}],"uniqueKey":"connector_account_details","typeLabel":"object | null"},"connector_webhook_details":{"oneOf":[{"type":"object","required":["merchant_secret","additional_secret"],"properties":{"merchant_secret":{"type":"string","example":"12345678900987654321","isRequired":true,"uniqueKey":"connector_webhook_details.oneOf.0.merchant_secret","typeLabel":"string"},"additional_secret":{"type":"string","example":"12345678900987654321","isRequired":true,"uniqueKey":"connector_webhook_details.oneOf.0.additional_secret","typeLabel":"string"}},"additionalProperties":false,"uniqueKey":"connector_webhook_details.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"connector_webhook_details.oneOf.1","typeLabel":"null"}],"uniqueKey":"connector_webhook_details","typeLabel":"object | null"},"metadata":{"oneOf":[{"type":"object","description":"Metadata is useful for storing additional, unstructured information on an object.","uniqueKey":"metadata.oneOf.0","typeLabel":"object"},{"type":"null","description":"Metadata is useful for storing additional, unstructured information on an object.","uniqueKey":"metadata.oneOf.1","typeLabel":"null"}],"uniqueKey":"metadata","typeLabel":"object | null"},"disabled":{"oneOf":[{"type":"boolean","description":"A boolean value to indicate if the connector is disabled. By default, its value is false.","default":false,"example":false,"uniqueKey":"disabled.oneOf.0","typeLabel":"boolean"},{"type":"null","description":"A boolean value to indicate if the connector is disabled. By default, its value is false.","default":false,"example":false,"uniqueKey":"disabled.oneOf.1","typeLabel":"null"}],"uniqueKey":"disabled","typeLabel":"boolean | null"},"frm_configs":{"oneOf":[{"type":"array","items":{"type":"object","description":"Details of FrmConfigs are mentioned here... it should be passed in payment connector create api call, and stored in merchant_connector_table","required":["gateway","payment_methods"],"properties":{"gateway":{"type":"string","description":"Type of the Connector for the financial use case. Could range from Payments to Accounting to Banking.","enum":["payment_processor","payment_vas","fin_operations","fiz_operations","networks","banking_entities","non_banking_finance","payout_processor","payment_method_auth","authentication_processor","tax_processor","billing_processor","vault_processor"],"isRequired":true,"uniqueKey":"frm_configs.oneOf.0.items.[INDEX].gateway","typeLabel":"enum\u003cstring>"},"payment_methods":{"type":"array","items":{"type":"object","description":"Details of FrmPaymentMethod are mentioned here... it should be passed in payment connector create api call, and stored in merchant_connector_table","required":["payment_method"],"properties":{"payment_method":{"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":"frm_configs.oneOf.0.items.[INDEX].payment_methods.items.[INDEX].payment_method","typeLabel":"enum\u003cstring>"},"payment_method_types":{"oneOf":[{"type":"array","items":{"type":"object","description":"Details of FrmPaymentMethodType are mentioned here... it should be passed in payment connector create api call, and stored in merchant_connector_table","required":["payment_method_type","card_networks","flow","action"],"properties":{"payment_method_type":{"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":"frm_configs.oneOf.0.items.[INDEX].payment_methods.items.[INDEX].payment_method_types.oneOf.0.items.[INDEX].payment_method_type","typeLabel":"enum\u003cstring>"},"card_networks":{"type":"string","description":"Indicates the card network.","enum":["Visa","Mastercard","AmericanExpress","JCB","DinersClub","Discover","CartesBancaires","UnionPay","Interac","RuPay","Maestro","Star","Pulse","Accel","Nyce"],"isRequired":true,"uniqueKey":"frm_configs.oneOf.0.items.[INDEX].payment_methods.items.[INDEX].payment_method_types.oneOf.0.items.[INDEX].card_networks","typeLabel":"enum\u003cstring>"},"flow":{"type":"string","enum":["pre","post"],"isRequired":true,"uniqueKey":"frm_configs.oneOf.0.items.[INDEX].payment_methods.items.[INDEX].payment_method_types.oneOf.0.items.[INDEX].flow","typeLabel":"enum\u003cstring>"},"action":{"type":"string","enum":["cancel_txn","auto_refund","manual_review"],"isRequired":true,"uniqueKey":"frm_configs.oneOf.0.items.[INDEX].payment_methods.items.[INDEX].payment_method_types.oneOf.0.items.[INDEX].action","typeLabel":"enum\u003cstring>"}},"additionalProperties":false,"uniqueKey":"frm_configs.oneOf.0.items.[INDEX].payment_methods.items.[INDEX].payment_method_types.oneOf.0.items.[INDEX]","typeLabel":"object"},"description":"payment method types(credit, debit) that can be used in the payment. This field is deprecated. It has not been removed to provide backward compatibility.","uniqueKey":"frm_configs.oneOf.0.items.[INDEX].payment_methods.items.[INDEX].payment_method_types.oneOf.0","typeLabel":"object[]"},{"type":"null","items":{"type":"object","description":"Details of FrmPaymentMethodType are mentioned here... it should be passed in payment connector create api call, and stored in merchant_connector_table","required":["payment_method_type","card_networks","flow","action"],"properties":{"payment_method_type":{"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"]},"card_networks":{"type":"string","description":"Indicates the card network.","enum":["Visa","Mastercard","AmericanExpress","JCB","DinersClub","Discover","CartesBancaires","UnionPay","Interac","RuPay","Maestro","Star","Pulse","Accel","Nyce"]},"flow":{"type":"string","enum":["pre","post"]},"action":{"type":"string","enum":["cancel_txn","auto_refund","manual_review"]}},"additionalProperties":false},"description":"payment method types(credit, debit) that can be used in the payment. This field is deprecated. It has not been removed to provide backward compatibility.","uniqueKey":"frm_configs.oneOf.0.items.[INDEX].payment_methods.items.[INDEX].payment_method_types.oneOf.1","typeLabel":"null"}],"uniqueKey":"frm_configs.oneOf.0.items.[INDEX].payment_methods.items.[INDEX].payment_method_types","typeLabel":"object[] | null"},"flow":{"oneOf":[{"type":"string","enum":["pre","post"],"uniqueKey":"frm_configs.oneOf.0.items.[INDEX].payment_methods.items.[INDEX].flow.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","uniqueKey":"frm_configs.oneOf.0.items.[INDEX].payment_methods.items.[INDEX].flow.oneOf.1","typeLabel":"null"}],"uniqueKey":"frm_configs.oneOf.0.items.[INDEX].payment_methods.items.[INDEX].flow","typeLabel":"enum\u003cstring> | null"}},"additionalProperties":false,"uniqueKey":"frm_configs.oneOf.0.items.[INDEX].payment_methods.items.[INDEX]","typeLabel":"object"},"description":"payment methods that can be used in the payment","isRequired":true,"uniqueKey":"frm_configs.oneOf.0.items.[INDEX].payment_methods","typeLabel":"object[]"}},"additionalProperties":false,"uniqueKey":"frm_configs.oneOf.0.items.[INDEX]","typeLabel":"object"},"description":"Contains the frm configs for the merchant connector","example":"\n[{\"gateway\":\"stripe\",\"payment_methods\":[{\"payment_method\":\"card\",\"payment_method_types\":[{\"payment_method_type\":\"credit\",\"card_networks\":[\"Visa\"],\"flow\":\"pre\",\"action\":\"cancel_txn\"},{\"payment_method_type\":\"debit\",\"card_networks\":[\"Visa\"],\"flow\":\"pre\"}]}]}]\n","uniqueKey":"frm_configs.oneOf.0","typeLabel":"object[]"},{"type":"null","items":{"type":"object","description":"Details of FrmConfigs are mentioned here... it should be passed in payment connector create api call, and stored in merchant_connector_table","required":["gateway","payment_methods"],"properties":{"gateway":{"type":"string","description":"Type of the Connector for the financial use case. Could range from Payments to Accounting to Banking.","enum":["payment_processor","payment_vas","fin_operations","fiz_operations","networks","banking_entities","non_banking_finance","payout_processor","payment_method_auth","authentication_processor","tax_processor","billing_processor","vault_processor"]},"payment_methods":{"type":"array","items":{"type":"object","description":"Details of FrmPaymentMethod are mentioned here... it should be passed in payment connector create api call, and stored in merchant_connector_table","required":["payment_method"],"properties":{"payment_method":{"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_types":{"oneOf":[{"type":"array","items":{"type":"object","description":"Details of FrmPaymentMethodType are mentioned here... it should be passed in payment connector create api call, and stored in merchant_connector_table","required":["payment_method_type","card_networks","flow","action"],"properties":{"payment_method_type":{"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"]},"card_networks":{"type":"string","description":"Indicates the card network.","enum":["Visa","Mastercard","AmericanExpress","JCB","DinersClub","Discover","CartesBancaires","UnionPay","Interac","RuPay","Maestro","Star","Pulse","Accel","Nyce"]},"flow":{"type":"string","enum":["pre","post"]},"action":{"type":"string","enum":["cancel_txn","auto_refund","manual_review"]}},"additionalProperties":false},"description":"payment method types(credit, debit) that can be used in the payment. This field is deprecated. It has not been removed to provide backward compatibility."},{"type":"null","items":{"type":"object","description":"Details of FrmPaymentMethodType are mentioned here... it should be passed in payment connector create api call, and stored in merchant_connector_table","required":["payment_method_type","card_networks","flow","action"],"properties":{"payment_method_type":{"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"]},"card_networks":{"type":"string","description":"Indicates the card network.","enum":["Visa","Mastercard","AmericanExpress","JCB","DinersClub","Discover","CartesBancaires","UnionPay","Interac","RuPay","Maestro","Star","Pulse","Accel","Nyce"]},"flow":{"type":"string","enum":["pre","post"]},"action":{"type":"string","enum":["cancel_txn","auto_refund","manual_review"]}},"additionalProperties":false},"description":"payment method types(credit, debit) that can be used in the payment. This field is deprecated. It has not been removed to provide backward compatibility."}]},"flow":{"oneOf":[{"type":"string","enum":["pre","post"]},{"type":"null"}]}},"additionalProperties":false},"description":"payment methods that can be used in the payment"}},"additionalProperties":false},"description":"Contains the frm configs for the merchant connector","example":"\n[{\"gateway\":\"stripe\",\"payment_methods\":[{\"payment_method\":\"card\",\"payment_method_types\":[{\"payment_method_type\":\"credit\",\"card_networks\":[\"Visa\"],\"flow\":\"pre\",\"action\":\"cancel_txn\"},{\"payment_method_type\":\"debit\",\"card_networks\":[\"Visa\"],\"flow\":\"pre\"}]}]}]\n","uniqueKey":"frm_configs.oneOf.1","typeLabel":"null"}],"uniqueKey":"frm_configs","typeLabel":"object[] | null"},"applepay_verified_domains":{"oneOf":[{"type":"array","items":{"type":"string","uniqueKey":"applepay_verified_domains.oneOf.0.items.[INDEX]","typeLabel":"string"},"description":"identifier for the verified domains of a particular connector account","uniqueKey":"applepay_verified_domains.oneOf.0","typeLabel":"string[]"},{"type":"null","items":{"type":"string"},"description":"identifier for the verified domains of a particular connector account","uniqueKey":"applepay_verified_domains.oneOf.1","typeLabel":"null"}],"uniqueKey":"applepay_verified_domains","typeLabel":"string[] | null"},"pm_auth_config":{"oneOf":[{"type":"object","description":"pm_auth_config will relate MCA records to their respective chosen auth services, based on payment_method and pmt","uniqueKey":"pm_auth_config.oneOf.0","typeLabel":"object"},{"type":"null","description":"pm_auth_config will relate MCA records to their respective chosen auth services, based on payment_method and pmt","uniqueKey":"pm_auth_config.oneOf.1","typeLabel":"null"}],"uniqueKey":"pm_auth_config","typeLabel":"object | null"},"additional_merchant_data":{"oneOf":[{"type":"object","required":["open_banking_recipient_data"],"properties":{"open_banking_recipient_data":{"oneOf":[{"type":"object","required":["connector_recipient_id"],"properties":{"connector_recipient_id":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"additional_merchant_data.oneOf.0.open_banking_recipient_data.oneOf.0.connector_recipient_id.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"additional_merchant_data.oneOf.0.open_banking_recipient_data.oneOf.0.connector_recipient_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"additional_merchant_data.oneOf.0.open_banking_recipient_data.oneOf.0.connector_recipient_id","typeLabel":"string | null"}},"isRequired":true,"uniqueKey":"additional_merchant_data.oneOf.0.open_banking_recipient_data.oneOf.0","typeLabel":"object"},{"type":"object","required":["wallet_id"],"properties":{"wallet_id":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"additional_merchant_data.oneOf.0.open_banking_recipient_data.oneOf.1.wallet_id.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"additional_merchant_data.oneOf.0.open_banking_recipient_data.oneOf.1.wallet_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"additional_merchant_data.oneOf.0.open_banking_recipient_data.oneOf.1.wallet_id","typeLabel":"string | null"}},"isRequired":true,"uniqueKey":"additional_merchant_data.oneOf.0.open_banking_recipient_data.oneOf.1","typeLabel":"object"},{"type":"object","required":["account_data"],"properties":{"account_data":{"oneOf":[{"type":"object","required":["iban"],"properties":{"iban":{"type":"object","description":"IBAN-based account for international transfers","required":["iban","name"],"properties":{"iban":{"type":"string","description":"International Bank Account Number (up to 34 characters)","isRequired":true,"uniqueKey":"additional_merchant_data.oneOf.0.open_banking_recipient_data.oneOf.2.account_data.oneOf.0.iban.iban","typeLabel":"string"},"name":{"type":"string","description":"Account holder name","isRequired":true,"uniqueKey":"additional_merchant_data.oneOf.0.open_banking_recipient_data.oneOf.2.account_data.oneOf.0.iban.name","typeLabel":"string"},"connector_recipient_id":{"oneOf":[{"type":"string","uniqueKey":"additional_merchant_data.oneOf.0.open_banking_recipient_data.oneOf.2.account_data.oneOf.0.iban.connector_recipient_id.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"additional_merchant_data.oneOf.0.open_banking_recipient_data.oneOf.2.account_data.oneOf.0.iban.connector_recipient_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"additional_merchant_data.oneOf.0.open_banking_recipient_data.oneOf.2.account_data.oneOf.0.iban.connector_recipient_id","typeLabel":"string | null"}},"isRequired":true,"uniqueKey":"additional_merchant_data.oneOf.0.open_banking_recipient_data.oneOf.2.account_data.oneOf.0.iban","typeLabel":"object"}},"isRequired":true,"uniqueKey":"additional_merchant_data.oneOf.0.open_banking_recipient_data.oneOf.2.account_data.oneOf.0","typeLabel":"object"},{"type":"object","required":["bacs"],"properties":{"bacs":{"type":"object","description":"UK BACS payment system","required":["account_number","sort_code","name"],"properties":{"account_number":{"type":"string","description":"8-digit UK account number","isRequired":true,"uniqueKey":"additional_merchant_data.oneOf.0.open_banking_recipient_data.oneOf.2.account_data.oneOf.1.bacs.account_number","typeLabel":"string"},"sort_code":{"type":"string","description":"6-digit UK sort code","example":"123456","isRequired":true,"uniqueKey":"additional_merchant_data.oneOf.0.open_banking_recipient_data.oneOf.2.account_data.oneOf.1.bacs.sort_code","typeLabel":"string"},"name":{"type":"string","description":"Account holder name","isRequired":true,"uniqueKey":"additional_merchant_data.oneOf.0.open_banking_recipient_data.oneOf.2.account_data.oneOf.1.bacs.name","typeLabel":"string"},"connector_recipient_id":{"oneOf":[{"type":"string","uniqueKey":"additional_merchant_data.oneOf.0.open_banking_recipient_data.oneOf.2.account_data.oneOf.1.bacs.connector_recipient_id.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"additional_merchant_data.oneOf.0.open_banking_recipient_data.oneOf.2.account_data.oneOf.1.bacs.connector_recipient_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"additional_merchant_data.oneOf.0.open_banking_recipient_data.oneOf.2.account_data.oneOf.1.bacs.connector_recipient_id","typeLabel":"string | null"}},"isRequired":true,"uniqueKey":"additional_merchant_data.oneOf.0.open_banking_recipient_data.oneOf.2.account_data.oneOf.1.bacs","typeLabel":"object"}},"isRequired":true,"uniqueKey":"additional_merchant_data.oneOf.0.open_banking_recipient_data.oneOf.2.account_data.oneOf.1","typeLabel":"object"},{"type":"object","required":["faster_payments"],"properties":{"faster_payments":{"type":"object","description":"UK Faster Payments (instant transfers)","required":["account_number","sort_code","name"],"properties":{"account_number":{"type":"string","description":"8-digit UK account number","isRequired":true,"uniqueKey":"additional_merchant_data.oneOf.0.open_banking_recipient_data.oneOf.2.account_data.oneOf.2.faster_payments.account_number","typeLabel":"string"},"sort_code":{"type":"string","description":"6-digit UK sort code","isRequired":true,"uniqueKey":"additional_merchant_data.oneOf.0.open_banking_recipient_data.oneOf.2.account_data.oneOf.2.faster_payments.sort_code","typeLabel":"string"},"name":{"type":"string","description":"Account holder name","isRequired":true,"uniqueKey":"additional_merchant_data.oneOf.0.open_banking_recipient_data.oneOf.2.account_data.oneOf.2.faster_payments.name","typeLabel":"string"},"connector_recipient_id":{"oneOf":[{"type":"string","uniqueKey":"additional_merchant_data.oneOf.0.open_banking_recipient_data.oneOf.2.account_data.oneOf.2.faster_payments.connector_recipient_id.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"additional_merchant_data.oneOf.0.open_banking_recipient_data.oneOf.2.account_data.oneOf.2.faster_payments.connector_recipient_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"additional_merchant_data.oneOf.0.open_banking_recipient_data.oneOf.2.account_data.oneOf.2.faster_payments.connector_recipient_id","typeLabel":"string | null"}},"isRequired":true,"uniqueKey":"additional_merchant_data.oneOf.0.open_banking_recipient_data.oneOf.2.account_data.oneOf.2.faster_payments","typeLabel":"object"}},"isRequired":true,"uniqueKey":"additional_merchant_data.oneOf.0.open_banking_recipient_data.oneOf.2.account_data.oneOf.2","typeLabel":"object"},{"type":"object","required":["sepa"],"properties":{"sepa":{"type":"object","description":"SEPA payments (Euro zone)","required":["iban","name"],"properties":{"iban":{"type":"string","description":"IBAN for SEPA transfers","example":"FR1420041010050500013M02606","isRequired":true,"uniqueKey":"additional_merchant_data.oneOf.0.open_banking_recipient_data.oneOf.2.account_data.oneOf.3.sepa.iban","typeLabel":"string"},"name":{"type":"string","description":"Account holder name","isRequired":true,"uniqueKey":"additional_merchant_data.oneOf.0.open_banking_recipient_data.oneOf.2.account_data.oneOf.3.sepa.name","typeLabel":"string"},"connector_recipient_id":{"oneOf":[{"type":"string","uniqueKey":"additional_merchant_data.oneOf.0.open_banking_recipient_data.oneOf.2.account_data.oneOf.3.sepa.connector_recipient_id.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"additional_merchant_data.oneOf.0.open_banking_recipient_data.oneOf.2.account_data.oneOf.3.sepa.connector_recipient_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"additional_merchant_data.oneOf.0.open_banking_recipient_data.oneOf.2.account_data.oneOf.3.sepa.connector_recipient_id","typeLabel":"string | null"}},"isRequired":true,"uniqueKey":"additional_merchant_data.oneOf.0.open_banking_recipient_data.oneOf.2.account_data.oneOf.3.sepa","typeLabel":"object"}},"isRequired":true,"uniqueKey":"additional_merchant_data.oneOf.0.open_banking_recipient_data.oneOf.2.account_data.oneOf.3","typeLabel":"object"},{"type":"object","required":["sepa_instant"],"properties":{"sepa_instant":{"type":"object","description":"SEPA Instant payments (10-second transfers)","required":["iban","name"],"properties":{"iban":{"type":"string","description":"IBAN for instant SEPA transfers","example":"DE89370400440532013000","isRequired":true,"uniqueKey":"additional_merchant_data.oneOf.0.open_banking_recipient_data.oneOf.2.account_data.oneOf.4.sepa_instant.iban","typeLabel":"string"},"name":{"type":"string","description":"Account holder name","isRequired":true,"uniqueKey":"additional_merchant_data.oneOf.0.open_banking_recipient_data.oneOf.2.account_data.oneOf.4.sepa_instant.name","typeLabel":"string"},"connector_recipient_id":{"oneOf":[{"type":"string","uniqueKey":"additional_merchant_data.oneOf.0.open_banking_recipient_data.oneOf.2.account_data.oneOf.4.sepa_instant.connector_recipient_id.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"additional_merchant_data.oneOf.0.open_banking_recipient_data.oneOf.2.account_data.oneOf.4.sepa_instant.connector_recipient_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"additional_merchant_data.oneOf.0.open_banking_recipient_data.oneOf.2.account_data.oneOf.4.sepa_instant.connector_recipient_id","typeLabel":"string | null"}},"isRequired":true,"uniqueKey":"additional_merchant_data.oneOf.0.open_banking_recipient_data.oneOf.2.account_data.oneOf.4.sepa_instant","typeLabel":"object"}},"isRequired":true,"uniqueKey":"additional_merchant_data.oneOf.0.open_banking_recipient_data.oneOf.2.account_data.oneOf.4","typeLabel":"object"},{"type":"object","required":["elixir"],"properties":{"elixir":{"type":"object","description":"Polish Elixir payment system","required":["account_number","iban","name"],"properties":{"account_number":{"type":"string","description":"Polish account number (26 digits)","example":"12345678901234567890123456","isRequired":true,"uniqueKey":"additional_merchant_data.oneOf.0.open_banking_recipient_data.oneOf.2.account_data.oneOf.5.elixir.account_number","typeLabel":"string"},"iban":{"type":"string","description":"Polish IBAN (28 chars)","example":"PL27114020040000300201355387","isRequired":true,"uniqueKey":"additional_merchant_data.oneOf.0.open_banking_recipient_data.oneOf.2.account_data.oneOf.5.elixir.iban","typeLabel":"string"},"name":{"type":"string","description":"Account holder name","isRequired":true,"uniqueKey":"additional_merchant_data.oneOf.0.open_banking_recipient_data.oneOf.2.account_data.oneOf.5.elixir.name","typeLabel":"string"},"connector_recipient_id":{"oneOf":[{"type":"string","uniqueKey":"additional_merchant_data.oneOf.0.open_banking_recipient_data.oneOf.2.account_data.oneOf.5.elixir.connector_recipient_id.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"additional_merchant_data.oneOf.0.open_banking_recipient_data.oneOf.2.account_data.oneOf.5.elixir.connector_recipient_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"additional_merchant_data.oneOf.0.open_banking_recipient_data.oneOf.2.account_data.oneOf.5.elixir.connector_recipient_id","typeLabel":"string | null"}},"isRequired":true,"uniqueKey":"additional_merchant_data.oneOf.0.open_banking_recipient_data.oneOf.2.account_data.oneOf.5.elixir","typeLabel":"object"}},"isRequired":true,"uniqueKey":"additional_merchant_data.oneOf.0.open_banking_recipient_data.oneOf.2.account_data.oneOf.5","typeLabel":"object"},{"type":"object","required":["bankgiro"],"properties":{"bankgiro":{"type":"object","description":"Swedish Bankgiro system","required":["number","name"],"properties":{"number":{"type":"string","description":"Bankgiro number (7-8 digits)","example":"5402-9656","isRequired":true,"uniqueKey":"additional_merchant_data.oneOf.0.open_banking_recipient_data.oneOf.2.account_data.oneOf.6.bankgiro.number","typeLabel":"string"},"name":{"type":"string","description":"Account holder name","example":"Erik Andersson","isRequired":true,"uniqueKey":"additional_merchant_data.oneOf.0.open_banking_recipient_data.oneOf.2.account_data.oneOf.6.bankgiro.name","typeLabel":"string"},"connector_recipient_id":{"oneOf":[{"type":"string","uniqueKey":"additional_merchant_data.oneOf.0.open_banking_recipient_data.oneOf.2.account_data.oneOf.6.bankgiro.connector_recipient_id.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"additional_merchant_data.oneOf.0.open_banking_recipient_data.oneOf.2.account_data.oneOf.6.bankgiro.connector_recipient_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"additional_merchant_data.oneOf.0.open_banking_recipient_data.oneOf.2.account_data.oneOf.6.bankgiro.connector_recipient_id","typeLabel":"string | null"}},"isRequired":true,"uniqueKey":"additional_merchant_data.oneOf.0.open_banking_recipient_data.oneOf.2.account_data.oneOf.6.bankgiro","typeLabel":"object"}},"isRequired":true,"uniqueKey":"additional_merchant_data.oneOf.0.open_banking_recipient_data.oneOf.2.account_data.oneOf.6","typeLabel":"object"},{"type":"object","required":["plusgiro"],"properties":{"plusgiro":{"type":"object","description":"Swedish Plusgiro system","required":["number","name"],"properties":{"number":{"type":"string","description":"Plusgiro number (2-8 digits)","example":"4789-2","isRequired":true,"uniqueKey":"additional_merchant_data.oneOf.0.open_banking_recipient_data.oneOf.2.account_data.oneOf.7.plusgiro.number","typeLabel":"string"},"name":{"type":"string","description":"Account holder name","example":"Anna Larsson","isRequired":true,"uniqueKey":"additional_merchant_data.oneOf.0.open_banking_recipient_data.oneOf.2.account_data.oneOf.7.plusgiro.name","typeLabel":"string"},"connector_recipient_id":{"oneOf":[{"type":"string","uniqueKey":"additional_merchant_data.oneOf.0.open_banking_recipient_data.oneOf.2.account_data.oneOf.7.plusgiro.connector_recipient_id.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"additional_merchant_data.oneOf.0.open_banking_recipient_data.oneOf.2.account_data.oneOf.7.plusgiro.connector_recipient_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"additional_merchant_data.oneOf.0.open_banking_recipient_data.oneOf.2.account_data.oneOf.7.plusgiro.connector_recipient_id","typeLabel":"string | null"}},"isRequired":true,"uniqueKey":"additional_merchant_data.oneOf.0.open_banking_recipient_data.oneOf.2.account_data.oneOf.7.plusgiro","typeLabel":"object"}},"isRequired":true,"uniqueKey":"additional_merchant_data.oneOf.0.open_banking_recipient_data.oneOf.2.account_data.oneOf.7","typeLabel":"object"}],"isRequired":true,"uniqueKey":"additional_merchant_data.oneOf.0.open_banking_recipient_data.oneOf.2.account_data","typeLabel":"object"}},"isRequired":true,"uniqueKey":"additional_merchant_data.oneOf.0.open_banking_recipient_data.oneOf.2","typeLabel":"object"}],"isRequired":true,"uniqueKey":"additional_merchant_data.oneOf.0.open_banking_recipient_data","typeLabel":"object"}},"uniqueKey":"additional_merchant_data.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"additional_merchant_data.oneOf.1","typeLabel":"null"}],"uniqueKey":"additional_merchant_data","typeLabel":"object | null"},"connector_wallets_details":{"oneOf":[{"type":"object","properties":{"apple_pay_combined":{"oneOf":[{"type":"object","description":"This field contains the Apple Pay certificates and credentials for iOS and Web Apple Pay flow","uniqueKey":"connector_wallets_details.oneOf.0.apple_pay_combined.oneOf.0","typeLabel":"object"},{"type":"null","description":"This field contains the Apple Pay certificates and credentials for iOS and Web Apple Pay flow","uniqueKey":"connector_wallets_details.oneOf.0.apple_pay_combined.oneOf.1","typeLabel":"null"}],"uniqueKey":"connector_wallets_details.oneOf.0.apple_pay_combined","typeLabel":"object | null"},"apple_pay":{"oneOf":[{"type":"object","description":"This field is for our legacy Apple Pay flow that contains the Apple Pay certificates and credentials for only iOS Apple Pay flow","uniqueKey":"connector_wallets_details.oneOf.0.apple_pay.oneOf.0","typeLabel":"object"},{"type":"null","description":"This field is for our legacy Apple Pay flow that contains the Apple Pay certificates and credentials for only iOS Apple Pay flow","uniqueKey":"connector_wallets_details.oneOf.0.apple_pay.oneOf.1","typeLabel":"null"}],"uniqueKey":"connector_wallets_details.oneOf.0.apple_pay","typeLabel":"object | null"},"amazon_pay":{"oneOf":[{"type":"object","description":"This field contains the Amazon Pay certificates and credentials","uniqueKey":"connector_wallets_details.oneOf.0.amazon_pay.oneOf.0","typeLabel":"object"},{"type":"null","description":"This field contains the Amazon Pay certificates and credentials","uniqueKey":"connector_wallets_details.oneOf.0.amazon_pay.oneOf.1","typeLabel":"null"}],"uniqueKey":"connector_wallets_details.oneOf.0.amazon_pay","typeLabel":"object | null"},"samsung_pay":{"oneOf":[{"type":"object","description":"This field contains the Samsung Pay certificates and credentials","uniqueKey":"connector_wallets_details.oneOf.0.samsung_pay.oneOf.0","typeLabel":"object"},{"type":"null","description":"This field contains the Samsung Pay certificates and credentials","uniqueKey":"connector_wallets_details.oneOf.0.samsung_pay.oneOf.1","typeLabel":"null"}],"uniqueKey":"connector_wallets_details.oneOf.0.samsung_pay","typeLabel":"object | null"},"paze":{"oneOf":[{"type":"object","description":"This field contains the Paze certificates and credentials","uniqueKey":"connector_wallets_details.oneOf.0.paze.oneOf.0","typeLabel":"object"},{"type":"null","description":"This field contains the Paze certificates and credentials","uniqueKey":"connector_wallets_details.oneOf.0.paze.oneOf.1","typeLabel":"null"}],"uniqueKey":"connector_wallets_details.oneOf.0.paze","typeLabel":"object | null"},"google_pay":{"oneOf":[{"type":"object","description":"This field contains the Google Pay certificates and credentials","uniqueKey":"connector_wallets_details.oneOf.0.google_pay.oneOf.0","typeLabel":"object"},{"type":"null","description":"This field contains the Google Pay certificates and credentials","uniqueKey":"connector_wallets_details.oneOf.0.google_pay.oneOf.1","typeLabel":"null"}],"uniqueKey":"connector_wallets_details.oneOf.0.google_pay","typeLabel":"object | null"}},"additionalProperties":false,"uniqueKey":"connector_wallets_details.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"connector_wallets_details.oneOf.1","typeLabel":"null"}],"uniqueKey":"connector_wallets_details","typeLabel":"object | null"},"feature_metadata":{"oneOf":[{"type":"object","description":"Feature metadata for merchant connector account","properties":{"revenue_recovery":{"oneOf":[{"type":"object","description":"Revenue recovery metadata for merchant connector account","required":["max_retry_count","billing_connector_retry_threshold","billing_account_reference"],"properties":{"max_retry_count":{"type":"integer","format":"int32","description":"The maximum number of retries allowed for an invoice. This limit is set by the merchant for each `billing connector`. Once this limit is reached, no further retries will be attempted.","example":"15","minimum":0,"isRequired":true,"uniqueKey":"feature_metadata.oneOf.0.revenue_recovery.oneOf.0.max_retry_count","typeLabel":"integer\u003cint32>"},"billing_connector_retry_threshold":{"type":"integer","format":"int32","description":"Maximum number of `billing connector` retries before revenue recovery can start executing retries.","example":"10","minimum":0,"isRequired":true,"uniqueKey":"feature_metadata.oneOf.0.revenue_recovery.oneOf.0.billing_connector_retry_threshold","typeLabel":"integer\u003cint32>"},"billing_account_reference":{"type":"integer","format":"int32","description":"Billing account reference id is payment gateway id at billing connector end.\nMerchants need to provide a mapping between these merchant connector account and the corresponding account reference IDs for each `billing connector`.","example":"{ \"mca_vDSg5z6AxnisHq5dbJ6g\": \"stripe_123\", \"mca_vDSg5z6AumisHqh4x5m1\": \"adyen_123\" }","minimum":0,"isRequired":true,"uniqueKey":"feature_metadata.oneOf.0.revenue_recovery.oneOf.0.billing_account_reference","typeLabel":"integer\u003cint32>"}},"uniqueKey":"feature_metadata.oneOf.0.revenue_recovery.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"feature_metadata.oneOf.0.revenue_recovery.oneOf.1","typeLabel":"null"}],"uniqueKey":"feature_metadata.oneOf.0.revenue_recovery","typeLabel":"object | null"}},"uniqueKey":"feature_metadata.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"feature_metadata.oneOf.1","typeLabel":"null"}],"uniqueKey":"feature_metadata","typeLabel":"object | null"}},"additionalProperties":false,"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"connector_type":"payment_processor","connector_name":"authipay","id":"mca_5apGeP94tMts6rg3U3kR","profile_id":"\u003cstring>","payment_methods_enabled":[{"payment_method_type":"card","payment_method_subtypes":[{"payment_method_type":"ach","payment_experience":"redirect_to_url","card_networks":["Visa"],"accepted_currencies":{"type":"enable_only","list":["AED"]},"accepted_countries":{"type":"enable_only","list":["AF"]},"minimum_amount":123,"maximum_amount":123,"recurring_enabled":false,"installment_payment_enabled":true}]}],"status":"inactive","connector_label":"stripe_US_travel","connector_account_details":{"connector_account_details":{},"metadata":{}},"connector_webhook_details":{"merchant_secret":"12345678900987654321","additional_secret":"12345678900987654321"},"metadata":{},"disabled":false,"frm_configs":"\n[{\"gateway\":\"stripe\",\"payment_methods\":[{\"payment_method\":\"card\",\"payment_method_types\":[{\"payment_method_type\":\"credit\",\"card_networks\":[\"Visa\"],\"flow\":\"pre\",\"action\":\"cancel_txn\"},{\"payment_method_type\":\"debit\",\"card_networks\":[\"Visa\"],\"flow\":\"pre\"}]}]}]\n","applepay_verified_domains":["\u003cstring>"],"pm_auth_config":{},"additional_merchant_data":{"open_banking_recipient_data":{"connector_recipient_id":"\u003cstring>"}},"connector_wallets_details":{"apple_pay_combined":{},"apple_pay":{},"amazon_pay":{},"samsung_pay":{},"paze":{},"google_pay":{}},"feature_metadata":{"revenue_recovery":{"max_retry_count":"15","billing_connector_retry_threshold":"10","billing_account_reference":"{ \"mca_vDSg5z6AxnisHq5dbJ6g\": \"stripe_123\", \"mca_vDSg5z6AumisHqh4x5m1\": \"adyen_123\" }"}}}}},"exampleType":"generated"}},"exampleType":"generated"},"0a88c088-a9b1-46e6-8f33-fe1975b3cb0e":{"description":"Unauthorized request","content":{"_mintlify/placeholder":{"schema":{"type":"object","description":""}}}},"17ea7c41-dcc4-4dc5-9db7-767b945e639b":{"description":"Merchant Connector does not exist in records","content":{"_mintlify/placeholder":{"schema":{"type":"object","description":""}}}}},"security":{"bebdc7cb-eb2c-4392-be67-80cbeeaf103e":{"admin_api_key":{"type":"apiKey","in":"header","name":"Authorization","description":"Format: `admin-api-key=\u003cadmin-api-key>`\n\nAdmin API keys allow you to perform some privileged actions such as creating a merchant account and Connector account. This is only used during development.","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: `admin-api-key=\u003cadmin-api-key>`\n\nAdmin API keys allow you to perform some privileged actions such as creating a merchant account and Connector account. This is only used during development.","scopes":[]},"schema":{"title":"Authorization","type":"string","description":"Format: `admin-api-key=\u003cadmin-api-key>`\n\nAdmin API keys allow you to perform some privileged actions such as creating a merchant account and Connector account. This is only used during development.","isRequired":true,"typeLabel":"string","deprecated":false},"schemeName":"admin_api_key","name":"Authorization"}],"title":"admin_api_key"}]},"originalFileLocation":"v2/openapi_spec_v2.json"},"subdomain":"birrpay","siteName":"BirrPay","title":"Connector Account - Retrieve - BirrPay","navMaps":{"firstHrefInVersion":{"1.0.0":{"href":"/introduction","matchLevel":3},"2.0.0 [BETA]":{"href":"/v2/connector-account/connector-account--retrieve","matchLevel":0}},"firstHrefInLanguage":{}},"lastModified":"2026-01-24T02:55:16.536Z","originalFileLocation":"v2/connector-account/connector-account--retrieve.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=\"Retrieves details of a Connector account\">\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=\"Connector Account - Retrieve - BirrPay\">\u003cmeta data-mint-head property=\"og:description\" content=\"Retrieves details of a Connector account\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"BirrPay\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.birrpay.io/v2/connector-account/connector-account--retrieve\">\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=Connector+Account\u0026amp;title=Connector+Account+-+Retrieve\u0026amp;description=Retrieves+details+of+a+Connector+account\u0026amp;theme=838cc079bd3fa932cbeee950\u0026amp;signature=56cd6afb16e18160017b32dbe5e6d633f484b30446debaa4eb66cf08aaeb15dc\">\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=\"Connector Account - Retrieve - BirrPay\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Retrieves details of a Connector account\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://birrpay.mintlify.app/_mintlify/api/og/v2?division=Connector+Account\u0026amp;title=Connector+Account+-+Retrieve\u0026amp;description=Retrieves+details+of+a+Connector+account\u0026amp;theme=838cc079bd3fa932cbeee950\u0026amp;signature=56cd6afb16e18160017b32dbe5e6d633f484b30446debaa4eb66cf08aaeb15dc\">\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/connector-account/connector-account--retrieve\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/v2/connector-account/connector-account--retrieve.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/connector-account/connector-account--retrieve#webpage\",\"url\":\"https://docs.birrpay.io/v2/connector-account/connector-account--retrieve\",\"name\":\"Connector Account - Retrieve\",\"description\":\"Retrieves details of a Connector account\",\"dateModified\":\"2026-01-24T02:55:16.536Z\",\"isPartOf\":{\"@id\":\"https://docs.birrpay.io#website\"},\"breadcrumb\":{\"@id\":\"https://docs.birrpay.io/v2/connector-account/connector-account--retrieve#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.birrpay.io/v2/connector-account/connector-account--retrieve#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Account management APIs [BETA]\",\"item\":\"https://docs.birrpay.io/v2/organization/organization--create\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Connector Account\",\"item\":\"https://docs.birrpay.io/v2/connector-account/connector-account--create\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Connector Account - Retrieve\",\"item\":\"https://docs.birrpay.io/v2/connector-account/connector-account--retrieve\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.birrpay.io/v2/connector-account/connector-account--retrieve#apireference\",\"headline\":\"Connector Account - Retrieve\",\"name\":\"Connector Account - Retrieve\",\"description\":\"Retrieves details of a Connector account\",\"url\":\"https://docs.birrpay.io/v2/connector-account/connector-account--retrieve\",\"mainEntityOfPage\":{\"@id\":\"https://docs.birrpay.io/v2/connector-account/connector-account--retrieve#webpage\"},\"dateModified\":\"2026-01-24T02:55:16.536Z\",\"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","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","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","description":"Creates a new Connector Account for the merchant account. The connector could be a payment processor/facilitator/acquirer or a provider of specialized services like Fraud/Accounting etc.","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","description":"To update an existing Connector account. Helpful in enabling/disabling different payment methods and other settings for the connector","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":"Connector Account - Retrieve - 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"]}