Use the API key created under your merchant account from the HyperSwitch dashboard. API key is used to authenticate API requests from your merchant server only. Don't expose this key on a website or embed it in a mobile application.
You can specify up to 50 keys, with key names up to 40 characters long and values up to 500
characters long. Metadata is useful for storing additional, structured information on an
object.
{"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":"v1/customers/customers--retrieve","slug":"/v1/customers/customers--retrieve","pageMetadata":{"openapi":"get /customers/{customer_id}","title":"Customers - Retrieve","description":"Retrieves a customer's details.","href":"/v1/customers/customers--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 a customer’s details.\"\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 /customers/{customer_id}","title":"Customers - Retrieve","description":"Retrieves a customer's details.","href":"/v1/customers/customers--retrieve","hidden":false}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"tags":["Customers"],"summary":"Customers - Retrieve","description":"Retrieves a customer's details.","operationId":"Retrieve a Customer","parameters":["7121c5da-5ca2-47f7-b5b0-936d3bb372d8"],"responses":{"200":"b93a35ff-622c-440e-8de7-932f5d8a894a","404":"479f06a5-68c9-4027-a795-3c19ea924dab"},"security":["e4941921-496d-4913-83e6-9e9ffd45bf56","c9532448-9474-4dfb-9b02-fac69c749897"],"method":"get","type":"path","servers":["792875b0-3b61-48a0-ab23-731c1218999a"],"path":"/customers/{customer_id}","baseUrlOptions":["https://sandbox.birrpay.io"],"title":"Customers - Retrieve","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"7121c5da-5ca2-47f7-b5b0-936d3bb372d8":{"name":"customer_id","in":"path","description":"The unique identifier for the Customer","required":true,"schema":{"type":"string","isRequired":true,"description":"The unique identifier for the Customer","uniqueKey":"","typeLabel":"string"}}},"responses":{"b93a35ff-622c-440e-8de7-932f5d8a894a":{"description":"Customer Retrieved","content":{"application/json":{"schema":{"type":"object","required":["customer_id","created_at"],"properties":{"customer_id":{"type":"string","description":"The identifier for the customer object","example":"cus_y3oqhf46pyzuxjbcn2giaqnb44","maxLength":64,"minLength":1,"isRequired":true,"uniqueKey":"customer_id","typeLabel":"string"},"created_at":{"type":"string","format":"date-time","description":"A timestamp (ISO 8601 code) that determines when the customer was created","example":"2023-01-18T11:04:09.922Z","isRequired":true,"uniqueKey":"created_at","typeLabel":"string\u003cdate-time>"},"name":{"oneOf":[{"type":"string","description":"The customer's name","example":"Jon Test","maxLength":255,"uniqueKey":"name.oneOf.0","typeLabel":"string"},{"type":"null","description":"The customer's name","example":"Jon Test","maxLength":255,"uniqueKey":"name.oneOf.1","typeLabel":"null"}],"uniqueKey":"name","typeLabel":"string | null"},"email":{"oneOf":[{"type":"string","description":"The customer's email address","example":"[email protected]","maxLength":255,"uniqueKey":"email.oneOf.0","typeLabel":"string"},{"type":"null","description":"The customer's email address","example":"[email protected]","maxLength":255,"uniqueKey":"email.oneOf.1","typeLabel":"null"}],"uniqueKey":"email","typeLabel":"string | null"},"phone":{"oneOf":[{"type":"string","description":"The customer's phone number","example":"9123456789","maxLength":255,"uniqueKey":"phone.oneOf.0","typeLabel":"string"},{"type":"null","description":"The customer's phone number","example":"9123456789","maxLength":255,"uniqueKey":"phone.oneOf.1","typeLabel":"null"}],"uniqueKey":"phone","typeLabel":"string | null"},"phone_country_code":{"oneOf":[{"type":"string","description":"The country code for the customer phone number","example":"+65","maxLength":255,"uniqueKey":"phone_country_code.oneOf.0","typeLabel":"string"},{"type":"null","description":"The country code for the customer phone number","example":"+65","maxLength":255,"uniqueKey":"phone_country_code.oneOf.1","typeLabel":"null"}],"uniqueKey":"phone_country_code","typeLabel":"string | null"},"description":{"oneOf":[{"type":"string","description":"An arbitrary string that you can attach to a customer object.","example":"First Customer","maxLength":255,"uniqueKey":"description.oneOf.0","typeLabel":"string"},{"type":"null","description":"An arbitrary string that you can attach to a customer object.","example":"First Customer","maxLength":255,"uniqueKey":"description.oneOf.1","typeLabel":"null"}],"uniqueKey":"description","typeLabel":"string | null"},"address":{"oneOf":[{"type":"object","description":"Address details","properties":{"city":{"oneOf":[{"type":"string","description":"The city, district, suburb, town, or village of the address.","example":"New York","maxLength":50,"uniqueKey":"address.oneOf.0.city.oneOf.0","typeLabel":"string"},{"type":"null","description":"The city, district, suburb, town, or village of the address.","example":"New York","maxLength":50,"uniqueKey":"address.oneOf.0.city.oneOf.1","typeLabel":"null"}],"uniqueKey":"address.oneOf.0.city","typeLabel":"string | null"},"country":{"oneOf":[{"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":"address.oneOf.0.country.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","uniqueKey":"address.oneOf.0.country.oneOf.1","typeLabel":"null"}],"uniqueKey":"address.oneOf.0.country","typeLabel":"enum\u003cstring> | null"},"line1":{"oneOf":[{"type":"string","description":"The first line of the street address or P.O. Box.","example":"123, King Street","maxLength":200,"uniqueKey":"address.oneOf.0.line1.oneOf.0","typeLabel":"string"},{"type":"null","description":"The first line of the street address or P.O. Box.","example":"123, King Street","maxLength":200,"uniqueKey":"address.oneOf.0.line1.oneOf.1","typeLabel":"null"}],"uniqueKey":"address.oneOf.0.line1","typeLabel":"string | null"},"line2":{"oneOf":[{"type":"string","description":"The second line of the street address or P.O. Box (e.g., apartment, suite, unit, or building).","example":"Powelson Avenue","maxLength":50,"uniqueKey":"address.oneOf.0.line2.oneOf.0","typeLabel":"string"},{"type":"null","description":"The second line of the street address or P.O. Box (e.g., apartment, suite, unit, or building).","example":"Powelson Avenue","maxLength":50,"uniqueKey":"address.oneOf.0.line2.oneOf.1","typeLabel":"null"}],"uniqueKey":"address.oneOf.0.line2","typeLabel":"string | null"},"line3":{"oneOf":[{"type":"string","description":"The third line of the street address, if applicable.","example":"Bridgewater","maxLength":50,"uniqueKey":"address.oneOf.0.line3.oneOf.0","typeLabel":"string"},{"type":"null","description":"The third line of the street address, if applicable.","example":"Bridgewater","maxLength":50,"uniqueKey":"address.oneOf.0.line3.oneOf.1","typeLabel":"null"}],"uniqueKey":"address.oneOf.0.line3","typeLabel":"string | null"},"zip":{"oneOf":[{"type":"string","description":"The zip/postal code for the address","example":"08807","maxLength":50,"uniqueKey":"address.oneOf.0.zip.oneOf.0","typeLabel":"string"},{"type":"null","description":"The zip/postal code for the address","example":"08807","maxLength":50,"uniqueKey":"address.oneOf.0.zip.oneOf.1","typeLabel":"null"}],"uniqueKey":"address.oneOf.0.zip","typeLabel":"string | null"},"state":{"oneOf":[{"type":"string","description":"The address state","example":"New York","uniqueKey":"address.oneOf.0.state.oneOf.0","typeLabel":"string"},{"type":"null","description":"The address state","example":"New York","uniqueKey":"address.oneOf.0.state.oneOf.1","typeLabel":"null"}],"uniqueKey":"address.oneOf.0.state","typeLabel":"string | null"},"first_name":{"oneOf":[{"type":"string","description":"The first name for the address","example":"John","maxLength":255,"uniqueKey":"address.oneOf.0.first_name.oneOf.0","typeLabel":"string"},{"type":"null","description":"The first name for the address","example":"John","maxLength":255,"uniqueKey":"address.oneOf.0.first_name.oneOf.1","typeLabel":"null"}],"uniqueKey":"address.oneOf.0.first_name","typeLabel":"string | null"},"last_name":{"oneOf":[{"type":"string","description":"The last name for the address","example":"Doe","maxLength":255,"uniqueKey":"address.oneOf.0.last_name.oneOf.0","typeLabel":"string"},{"type":"null","description":"The last name for the address","example":"Doe","maxLength":255,"uniqueKey":"address.oneOf.0.last_name.oneOf.1","typeLabel":"null"}],"uniqueKey":"address.oneOf.0.last_name","typeLabel":"string | null"},"origin_zip":{"oneOf":[{"type":"string","description":"The zip/postal code of the origin","example":"08807","maxLength":50,"uniqueKey":"address.oneOf.0.origin_zip.oneOf.0","typeLabel":"string"},{"type":"null","description":"The zip/postal code of the origin","example":"08807","maxLength":50,"uniqueKey":"address.oneOf.0.origin_zip.oneOf.1","typeLabel":"null"}],"uniqueKey":"address.oneOf.0.origin_zip","typeLabel":"string | null"}},"uniqueKey":"address.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"address.oneOf.1","typeLabel":"null"}],"uniqueKey":"address","typeLabel":"object | null"},"metadata":{"oneOf":[{"type":"object","description":"You can specify up to 50 keys, with key names up to 40 characters long and values up to 500\ncharacters long. Metadata is useful for storing additional, structured information on an\nobject.","uniqueKey":"metadata.oneOf.0","typeLabel":"object"},{"type":"null","description":"You can specify up to 50 keys, with key names up to 40 characters long and values up to 500\ncharacters long. Metadata is useful for storing additional, structured information on an\nobject.","uniqueKey":"metadata.oneOf.1","typeLabel":"null"}],"uniqueKey":"metadata","typeLabel":"object | null"},"default_payment_method_id":{"oneOf":[{"type":"string","description":"The identifier for the default payment method.","example":"pm_djh2837dwduh890123","maxLength":64,"uniqueKey":"default_payment_method_id.oneOf.0","typeLabel":"string"},{"type":"null","description":"The identifier for the default payment method.","example":"pm_djh2837dwduh890123","maxLength":64,"uniqueKey":"default_payment_method_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"default_payment_method_id","typeLabel":"string | null"},"tax_registration_id":{"oneOf":[{"type":"string","description":"The customer's tax registration number.","example":"123456789","maxLength":255,"uniqueKey":"tax_registration_id.oneOf.0","typeLabel":"string"},{"type":"null","description":"The customer's tax registration number.","example":"123456789","maxLength":255,"uniqueKey":"tax_registration_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"tax_registration_id","typeLabel":"string | null"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"customer_id":"cus_y3oqhf46pyzuxjbcn2giaqnb44","created_at":"2023-01-18T11:04:09.922Z","name":"Jon Test","email":"[email protected]","phone":"9123456789","phone_country_code":"+65","description":"First Customer","address":{"city":"New York","country":"AF","line1":"123, King Street","line2":"Powelson Avenue","line3":"Bridgewater","zip":"08807","state":"New York","first_name":"John","last_name":"Doe","origin_zip":"08807"},"metadata":{},"default_payment_method_id":"pm_djh2837dwduh890123","tax_registration_id":"123456789"}}},"exampleType":"generated"}},"exampleType":"generated"},"479f06a5-68c9-4027-a795-3c19ea924dab":{"description":"Customer was not found","content":{"_mintlify/placeholder":{"schema":{"type":"object","description":""}}}}},"security":{"e4941921-496d-4913-83e6-9e9ffd45bf56":{"api_key":{"type":"apiKey","in":"header","name":"api-key","description":"Use the API key created under your merchant account from the HyperSwitch dashboard. API key is used to authenticate API requests from your merchant server only. Don't expose this key on a website or embed it in a mobile application.","scopes":[]}},"c9532448-9474-4dfb-9b02-fac69c749897":{"ephemeral_key":{"type":"apiKey","in":"header","name":"api-key","description":"Ephemeral keys provide temporary access to singular data, such as access to a single customer object for a short period of time.","scopes":[]}}},"servers":{"792875b0-3b61-48a0-ab23-731c1218999a":{"url":"https://sandbox.birrpay.io","description":"Sandbox Environment"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"apiKey","in":"header","name":"api-key","description":"Use the API key created under your merchant account from the HyperSwitch dashboard. API key is used to authenticate API requests from your merchant server only. Don't expose this key on a website or embed it in a mobile application.","scopes":[]},"schema":{"title":"api-key","type":"string","description":"Use the API key created under your merchant account from the HyperSwitch dashboard. API key is used to authenticate API requests from your merchant server only. Don't expose this key on a website or embed it in a mobile application.","isRequired":true,"typeLabel":"string","deprecated":false},"schemeName":"api_key","name":"api-key"}],"title":"api_key"},{"schemes":[{"scheme":{"type":"apiKey","in":"header","name":"api-key","description":"Ephemeral keys provide temporary access to singular data, such as access to a single customer object for a short period of time.","scopes":[]},"schema":{"title":"api-key","type":"string","description":"Ephemeral keys provide temporary access to singular data, such as access to a single customer object for a short period of time.","isRequired":true,"typeLabel":"string","deprecated":false},"schemeName":"ephemeral_key","name":"api-key"}],"title":"ephemeral_key"}]},"originalFileLocation":"v1/openapi_spec_v1.json"},"subdomain":"birrpay","siteName":"BirrPay","title":"Customers - Retrieve - BirrPay","navMaps":{"firstHrefInVersion":{"1.0.0":{"href":"/v1/customers/customers--retrieve","matchLevel":0},"2.0.0 [BETA]":{"href":"/v2/customers/customers--retrieve","matchLevel":1}},"firstHrefInLanguage":{}},"lastModified":"2026-01-24T02:55:16.013Z","originalFileLocation":"v1/customers/customers--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 a customer\u0026#x27;s details.\">\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=\"Customers - Retrieve - BirrPay\">\u003cmeta data-mint-head property=\"og:description\" content=\"Retrieves a customer\u0026#x27;s details.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"BirrPay\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.birrpay.io/v1/customers/customers--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=Customers\u0026amp;title=Customers+-+Retrieve\u0026amp;description=Retrieves+a+customer%27s+details.\u0026amp;theme=838cc079bd3fa932cbeee950\u0026amp;signature=0e1e334aa54fa7b228a124aee5634ddff8390c379de8b3574970df9077ee84c1\">\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=\"Customers - Retrieve - BirrPay\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Retrieves a customer\u0026#x27;s details.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://birrpay.mintlify.app/_mintlify/api/og/v2?division=Customers\u0026amp;title=Customers+-+Retrieve\u0026amp;description=Retrieves+a+customer%27s+details.\u0026amp;theme=838cc079bd3fa932cbeee950\u0026amp;signature=0e1e334aa54fa7b228a124aee5634ddff8390c379de8b3574970df9077ee84c1\">\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/v1/customers/customers--retrieve\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/v1/customers/customers--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/v1/customers/customers--retrieve#webpage\",\"url\":\"https://docs.birrpay.io/v1/customers/customers--retrieve\",\"name\":\"Customers - Retrieve\",\"description\":\"Retrieves a customer's details.\",\"dateModified\":\"2026-01-24T02:55:16.013Z\",\"isPartOf\":{\"@id\":\"https://docs.birrpay.io#website\"},\"breadcrumb\":{\"@id\":\"https://docs.birrpay.io/v1/customers/customers--retrieve#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.birrpay.io/v1/customers/customers--retrieve#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Payments Core APIs\",\"item\":\"https://docs.birrpay.io/v1/payments/setup--instructions\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Customers\",\"item\":\"https://docs.birrpay.io/v1/customers/customers--create\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Customers - Retrieve\",\"item\":\"https://docs.birrpay.io/v1/customers/customers--retrieve\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.birrpay.io/v1/customers/customers--retrieve#apireference\",\"headline\":\"Customers - Retrieve\",\"name\":\"Customers - Retrieve\",\"description\":\"Retrieves a customer's details.\",\"url\":\"https://docs.birrpay.io/v1/customers/customers--retrieve\",\"mainEntityOfPage\":{\"@id\":\"https://docs.birrpay.io/v1/customers/customers--retrieve#webpage\"},\"dateModified\":\"2026-01-24T02:55:16.013Z\",\"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","groups":[{"group":"Get Started","pages":[{"title":"👋 Welcome to BirrPay API Reference","sidebarTitle":"Introduction","icon":"rectangle-code","iconType":"solid","href":"/introduction","hidden":false}]},{"group":"Essentials","pages":[{"title":"Authentication Types","href":"/essentials/authentication"},{"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","pages":[{"sidebarTitle":"Setup Instructions","icon":"flag","iconType":"solid","title":null,"href":"/v1/payments/setup--instructions"},{"sidebarTitle":"Payment Flows","icon":"arrows-retweet","iconType":"solid","title":null,"href":"/v1/payments/payment--flows"},{"group":"Payments","pages":[{"openapi":"post /payments","title":"Payments - Create","href":"/v1/payments/payments--create"},{"openapi":"post /payments/{payment_id}","title":"Payments - Update","href":"/v1/payments/payments--update"},{"openapi":"post /payments/{payment_id}/confirm","title":"Payments - Confirm","href":"/v1/payments/payments--confirm"},{"openapi":"get /payments/{payment_id}","title":"Payments - Retrieve","href":"/v1/payments/payments--retrieve"},{"openapi":"post /payments/{payment_id}/cancel","title":"Payments - Cancel","href":"/v1/payments/payments--cancel"},{"openapi":"post /payments/{payment_id}/cancel_post_capture","title":"Payments - Cancel Post Capture","href":"/v1/payments/payments--cancel-post-capture"},{"openapi":"post /payments/{payment_id}/capture","title":"Payments - Capture","href":"/v1/payments/payments--capture"},{"openapi":"post /payments/{payment_id}/incremental_authorization","title":"Payments - Incremental Authorization","href":"/v1/payments/payments--incremental-authorization"},{"openapi":"post /payments/{payment_id}/extend_authorization","title":"Payments - Extended Authorization","href":"/v1/payments/payments--extend-authorization"},{"openapi":"post /payments/session_tokens","title":"Payments - Session token","href":"/v1/payments/payments--session-token"},{"openapi":"get /payment_link/{payment_link_id}","title":"Payments Link - Retrieve","href":"/v1/payments/payments-link--retrieve"},{"openapi":"get /payments/list","title":"Payments - List","href":"/v1/payments/payments--list"},{"openapi":"post /payments/{payment_id}/3ds/authentication","title":"Payments - External 3DS Authentication","href":"/v1/payments/payments--external-3ds-authentication"},{"openapi":"post /{payment_id}/complete_authorize","title":null,"href":"/v1/payments/payments--complete-authorize"},{"openapi":"post /payments/{payment_id}/update_metadata","title":"Payments - Update Metadata","href":"/v1/payments/payments--update-metadata"},{"openapi":"post /payments/{payment_id}/eligibility","title":"Payments - Submit Eligibility Data","href":"/v1/payments/payments--submit-eligibility-data"}]},{"group":"Payment Methods","pages":[{"openapi":"post /payment_methods","title":"PaymentMethods - Create","href":"/v1/payment-methods/paymentmethods--create"},{"openapi":"get /payment_methods/{method_id}","title":"Payment Method - Retrieve","href":"/v1/payment-methods/payment-method--retrieve"},{"openapi":"post /payment_methods/{method_id}/update","title":"Payment Method - Update","href":"/v1/payment-methods/payment-method--update"},{"openapi":"delete /payment_methods/{method_id}","title":"Payment Method - Delete","href":"/v1/payment-methods/payment-method--delete"},{"openapi":"post /{customer_id}/payment_methods/{payment_method_id}/default","title":"Payment Method - Set Default Payment Method for Customer","href":"/v1/payment-methods/payment-method--set-default-payment-method-for-customer"},{"openapi":"get /account/payment_methods","title":"List payment methods for a Merchant","href":"/v1/payment-methods/list-payment-methods-for-a-merchant"},{"openapi":"get /customers/payment_methods","title":"List customer saved payment methods for a Payment","href":"/v1/payment-methods/list-customer-saved-payment-methods-for-a-payment"},{"openapi":"get /customers/{customer_id}/payment_methods","title":"List payment methods for a Customer","href":"/v1/payment-methods/list-payment-methods-for-a-customer"},{"openapi":"post /{customer_id}/payment_methods/{payment_method_id}/default","title":"Payment Method - Set Default Payment Method for Customer","href":"/v1/customer-set-default-payment-method/customers--set-default-payment-method"}]},{"group":"Customers","pages":[{"openapi":"post /customers","title":"Customers - Create","description":"Creates a customer object and stores the customer details to be reused for future payments.\nIncase the customer already exists in the system, this API will respond with the customer details.","href":"/v1/customers/customers--create"},{"openapi":"get /customers/{customer_id}","title":"Customers - Retrieve","href":"/v1/customers/customers--retrieve"},{"openapi":"post /customers/{customer_id}","title":"Customers - Update","description":"Updates the customer's details in a customer object.","href":"/v1/customers/customers--update"},{"openapi":"delete /customers/{customer_id}","title":"Customers - Delete","href":"/v1/customers/customers--delete"},{"openapi":"get /customers/list","title":"Customers - List","href":"/v1/customers/customers--list"}]},{"group":"Mandates","pages":[{"openapi":"post /mandates/revoke/{mandate_id}","title":"Mandates - Revoke Mandate","href":"/v1/mandates/mandates--revoke-mandate"},{"openapi":"get /mandates/{mandate_id}","title":"Mandates - Retrieve Mandate","href":"/v1/mandates/mandates--retrieve-mandate"},{"openapi":"post /customers/{customer_id}/mandates","title":null,"href":"/v1/mandates/mandates--customer-mandates-list"}]},{"group":"Refunds","pages":[{"openapi":"post /refunds","title":"Refunds - Create","href":"/v1/refunds/refunds--create"},{"openapi":"post /refunds/{refund_id}","title":"Refunds - Update","href":"/v1/refunds/refunds--update"},{"openapi":"get /refunds/{refund_id}","title":"Refunds - Retrieve","href":"/v1/refunds/refunds--retrieve"},{"openapi":"post /refunds/list","title":"Refunds - List","href":"/v1/refunds/refunds--list"}]},{"group":"Disputes","pages":[{"openapi":"get /disputes/{dispute_id}","title":"Disputes - Retrieve Dispute","href":"/v1/disputes/disputes--retrieve"},{"openapi":"get /disputes/list","title":"Disputes - List Disputes","href":"/v1/disputes/disputes--list"}]},{"group":"Authentication","pages":[{"openapi":"post /authentication","title":"Authentication - Create","href":"/v1/authentication/authentication--create"},{"openapi":"post /authentication/{authentication_id}/eligibility-check","title":"Authentication - POST Eligibility Check","href":"/v1/authentication/authentication--post-eligibility-check"},{"openapi":"get /authentication/{authentication_id}/eligibility-check","title":"Authentication - GET Eligibility Check","href":"/v1/authentication/authentication--get-eligibility-check"}]},{"group":"Payouts","pages":[{"openapi":"post /payouts/create","title":"Payouts - Create","href":"/v1/payouts/payouts--create"},{"openapi":"post /payouts/{payout_id}","title":"Payouts - Update","href":"/v1/payouts/payouts--update"},{"openapi":"post /payouts/{payout_id}/cancel","title":"Payouts - Cancel","href":"/v1/payouts/payouts--cancel"},{"openapi":"post /payouts/{payout_id}/fulfill","title":"Payouts - Fulfill","href":"/v1/payouts/payouts--fulfill"},{"openapi":"post /payouts/{payout_id}/confirm","title":"Payouts - Confirm","href":"/v1/payouts/payouts--confirm"},{"openapi":"get /payouts/{payout_id}","title":"Payouts - Retrieve","href":"/v1/payouts/payouts--retrieve"},{"openapi":"get /payouts/list","title":"Payouts - List","href":"/v1/payouts/payouts--list"},{"openapi":"post /payouts/filter","title":"Payouts - List available filters","href":"/v1/payouts/payouts--list-filters"},{"openapi":"post /payouts/list","title":"Payouts - List using filters","href":"/v1/payouts/payouts--filter"}]}]},{"group":"Account management APIs","pages":[{"group":"Organization","pages":[{"openapi":"post /organization","title":"Organization - Create","href":"/v1/organization/organization--create"},{"openapi":"get /organization/{id}","title":"Organization - Retrieve","href":"/v1/organization/organization--retrieve"},{"openapi":"put /organization/{id}","title":"Organization - Update","href":"/v1/organization/organization--update"}]},{"group":"Merchant Account","pages":[{"openapi":"post /accounts","title":"Merchant Account - Create","href":"/v1/merchant-account/merchant-account--create"},{"openapi":"get /accounts/{account_id}","title":"Merchant Account - Retrieve","href":"/v1/merchant-account/merchant-account--retrieve"},{"openapi":"post /accounts/{account_id}","title":"Merchant Account - Update","href":"/v1/merchant-account/merchant-account--update"},{"openapi":"delete /accounts/{account_id}","title":"Merchant Account - Delete","href":"/v1/merchant-account/merchant-account--delete"},{"openapi":"post /accounts/{account_id}/kv","title":"Merchant Account - KV Status","href":"/v1/merchant-account/merchant-account--kv-status"}]},{"group":"Business Profile","pages":[{"openapi":"post /account/{account_id}/business_profile","title":"Profile - Create","href":"/v1/business-profile/business-profile--create"},{"openapi":"post /account/{account_id}/business_profile/{profile_id}","title":"Profile - Update","href":"/v1/business-profile/business-profile--update"},{"openapi":"get /account/{account_id}/business_profile/{profile_id}","title":"Profile - Retrieve","href":"/v1/business-profile/business-profile--retrieve"},{"openapi":"delete /account/{account_id}/business_profile/{profile_id}","title":"Profile - Delete","href":"/v1/business-profile/business-profile--delete"},{"openapi":"get /account/{account_id}/business_profile","title":"Profile - List","href":"/v1/business-profile/business-profile--list"}]},{"group":"Platform Account","pages":[{"openapi":"post /user/create_platform","title":"Platform - Create","href":"/v1/platform/platform--create"}]},{"group":"API Key","pages":[{"openapi":"post /api_keys/{merchant_id}","title":"API Key - Create","href":"/v1/api-key/api-key--create"},{"openapi":"get /api_keys/{merchant_id}/{key_id}","title":"API Key - Retrieve","href":"/v1/api-key/api-key--retrieve"},{"openapi":"post /api_keys/{merchant_id}/{key_id}","title":"API Key - Update","href":"/v1/api-key/api-key--update"},{"openapi":"delete /api_keys/{merchant_id}/{key_id}","title":"API Key - Revoke","href":"/v1/api-key/api-key--revoke"},{"openapi":"get /api_keys/{merchant_id}/list","title":"API Key - List","href":"/v1/api-key/api-key--list"}]},{"group":"Merchant Connector Account","pages":[{"openapi":"post /account/{account_id}/connectors","title":"Merchant Connector - Create","href":"/v1/merchant-connector-account/merchant-connector--create"},{"openapi":"get /account/{account_id}/connectors/{merchant_connector_id}","title":"Merchant Connector - Retrieve","href":"/v1/merchant-connector-account/merchant-connector--retrieve"},{"openapi":"post /account/{account_id}/connectors/{merchant_connector_id}","title":"Merchant Connector - Update","href":"/v1/merchant-connector-account/merchant-connector--update"},{"openapi":"delete /account/{account_id}/connectors/{merchant_connector_id}","title":"Merchant Connector - Delete","href":"/v1/merchant-connector-account/merchant-connector--delete"},{"openapi":"get /account/{account_id}/connectors","title":"Merchant Connector - List","href":"/v1/merchant-connector-account/merchant-connector--list"}]},{"group":"GSM (Global Status Mapping)","pages":[{"openapi":"post /gsm","title":"Gsm - Create","href":"/v1/gsm/gsm--create"},{"openapi":"post /gsm/get","title":"Gsm - Get","href":"/v1/gsm/gsm--get"},{"openapi":"post /gsm/update","title":"Gsm - Update","href":"/v1/gsm/gsm--update"},{"openapi":"post /gsm/delete","title":"Gsm - Delete","href":"/v1/gsm/gsm--delete"}]}]},{"group":"Other APIs","pages":[{"group":"Event","pages":[{"openapi":"post /events/{merchant_id}","title":"Events - List","href":"/v1/event/events--list"},{"openapi":"get /events/{merchant_id}/{event_id}/attempts","title":"Events - Delivery Attempt List","href":"/v1/event/events--delivery-attempt-list"},{"openapi":"post /events/{merchant_id}/{event_id}/retry","title":"Events - Manual Retry","href":"/v1/event/events--manual-retry"}]},{"group":"Poll","pages":[{"openapi":"get /poll/status/{poll_id}","title":"Poll - Retrieve Poll Status","href":"/v1/poll/poll--retrieve-poll-status"}]},{"group":"Blocklist","pages":[{"openapi":"get /blocklist","title":null,"href":"/v1/blocklist/get-blocklist"},{"openapi":"post /blocklist","title":null,"href":"/v1/blocklist/post-blocklist"},{"openapi":"delete /blocklist","title":null,"href":"/v1/blocklist/delete-blocklist"},{"openapi":"post /blocklist/toggle","title":null,"href":"/v1/blocklist/post-blocklisttoggle"}]},{"group":"Routing","pages":[{"openapi":"get /routing","title":"Routing - List","href":"/v1/routing/routing--list"},{"openapi":"post /routing","title":"Routing - Create","href":"/v1/routing/routing--create"},{"openapi":"post /account/{account_id}/business_profile/{profile_id}/dynamic_routing/success_based/create","title":"Routing - Auth Rate Based","href":"/v1/routing/routing--success-based"},{"openapi":"post /account/{account_id}/business_profile/{profile_id}/dynamic_routing/elimination/create","title":"Routing - Elimination","href":"/v1/routing/routing--elimination"},{"openapi":"get /routing/active","title":"Routing - Retrieve Config","href":"/v1/routing/routing--retrieve-config"},{"openapi":"post /routing/deactivate","title":"Routing - Deactivate","href":"/v1/routing/routing--deactivate"},{"openapi":"get /routing/default","title":"Routing - Retrieve Default Config","href":"/v1/routing/routing--retrieve-default-config"},{"openapi":"post /routing/default","title":"Routing - Update Default Config","href":"/v1/routing/routing--update-default-config"},{"openapi":"get /routing/default/profile","title":"Routing - Retrieve Default For Profile","href":"/v1/routing/routing--retrieve-default-for-profile"},{"openapi":"post /routing/default/profile/{profile_id}","title":"Routing - Update Default For Profile","href":"/v1/routing/routing--update-default-for-profile"},{"openapi":"get /routing/{routing_algorithm_id}","title":"Routing - Retrieve","href":"/v1/routing/routing--retrieve"},{"openapi":"post /routing/{routing_algorithm_id}/activate","title":"Routing - Activate config","href":"/v1/routing/routing--activate-config"},{"openapi":"post /routing/evaluate","title":"Routing - Evaluate","href":"/v1/routing/routing--evaluate"},{"openapi":"post /routing/feedback","title":"Routing - Feedback","href":"/v1/routing/routing--feedback"},{"openapi":"post /routing/rule/evaluate","title":"Routing - Rule Evaluate","href":"/v1/routing/routing--rule-evaluate"}]},{"group":"Relay","pages":[{"openapi":"post /relay","title":"Relay - Create","href":"/v1/relay/relay"},{"openapi":"get /relay/{relay_id}","title":"Relay - Retrieve","href":"/v1/relay/relay--retrieve"}]},{"group":"Schemas","pages":[{"title":null,"href":"/v1/schemas/outgoing--webhook"}]},{"group":"Subscriptions","pages":[{"openapi":"post /subscriptions/create","title":"Subscription - Create","href":"/v1/subscriptions/create"},{"openapi":"post /subscriptions/{subscription_id}/confirm","title":"Subscription - Confirm","href":"/v1/subscriptions/confirm"},{"openapi":"post /subscriptions","title":"Subscription - Create and Confirm","href":"/v1/subscriptions/create-and-confirm"},{"openapi":"put /subscriptions/{subscription_id}/update","title":"Subscription - Update","href":"/v1/subscriptions/update"},{"openapi":"get /subscriptions/{subscription_id}","title":"Subscription - Retrieve","href":"/v1/subscriptions/get"},{"title":"Get plans","href":"/v1/subscriptions/get-plans"},{"openapi":"get /subscriptions/estimate","title":"Subscription - Get Estimate","href":"/v1/subscriptions/estimate"},{"openapi":"post /subscriptions/{subscription_id}/pause","title":"Subscription - Pause Subscription","href":"/v1/subscriptions/pause"},{"openapi":"post /subscriptions/{subscription_id}/resume","title":"Subscription - Resume Subscription","href":"/v1/subscriptions/resume"},{"openapi":"post /subscriptions/{subscription_id}/cancel","title":"Subscription - Cancel Subscription","href":"/v1/subscriptions/cancel"}]}]}]},{"version":"2.0.0 [BETA]","pages":[{"title":"2.0.0 [BETA]","href":"/v2/customers/customers--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":"Customers - 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"]}