Use the API key created under your merchant account from the Vaultera Switch 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":"Vaultera Switch","colors":{"primary":"#6366f1","light":"#8b5cf6","dark":"#4f46e5"},"logo":{"light":"https://mintcdn.com/vaultera/x20IvR9u7_NHQlSC/logo/light.svg?fit=max\u0026auto=format\u0026n=x20IvR9u7_NHQlSC\u0026q=85\u0026s=af6567a50681ce778aa2ac6aa0f9b400","dark":"https://mintcdn.com/vaultera/x20IvR9u7_NHQlSC/logo/dark.svg?fit=max\u0026auto=format\u0026n=x20IvR9u7_NHQlSC\u0026q=85\u0026s=98047fc8a944a43c19a4c45d6c5e3750","href":"https://vaultera.co"},"favicon":"/favicon.png","api":{"openapi":["openapi_spec.json"],"playground":{"display":"simple"},"mdx":{"auth":{"method":"bearer"},"server":"https://api.test.switch.vaultera.co"}},"background":{"color":{"light":"#ffffff","dark":"#0f172a"}},"navbar":{"links":[{"href":"mailto:switch@vaultera.co","label":"Support"}],"primary":{"type":"button","label":"Dashboard","href":"https://app.test.switch.vaultera.co"}},"footer":{"socials":{"linkedin":"https://www.linkedin.com/company/vaultera"}},"search":{"prompt":"Search VaulteraSwitch documentation..."},"icons":{"library":"lucide"},"styling":{"codeblocks":"system","latex":false},"integrations":{"mixpanel":{"projectToken":"ff278b6dfe03b3da255c0778f9a38b6c"}},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"vaultera","hasAudioNarration":false,"actualSubdomain":"vaultera","customDomains":["docs.switch.vaultera.co"],"gitSource":{"type":"github","owner":"vaultera-co","repo":"switch","deployBranch":"main","contentDirectory":"api-reference","isPrivate":true,"mountPath":"","label":""},"entitlements":{},"buildId":"6ae9288ff5d453616651e0a7:success","clientVersion":"0.0.4088","searchFilterCounts":[{"language":"default","tag":"Explore","count":44},{"language":"default","tag":"Explore Vaultera","count":36},{"language":"default","tag":"API Reference","count":25},{"language":"default","tag":"Core APIs","count":24},{"language":"default","tag":"Payment Orchestration","count":17},{"language":"default","tag":"Accept Payments","count":12},{"language":"default","tag":"Payment Operations","count":11},{"language":"default","tag":"Payments","count":8},{"language":"default","tag":"Integrating checkout","count":8},{"language":"default","tag":"Customers","count":5}]},"assistantConfig":{},"basePath":"","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":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","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":"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":"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":"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":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","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":"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":"workos-sso-scim","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},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"comment-mode","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[{"filePath":"public/css/custom.css","content":""}],"page":{"pagePath":"api-reference/customers/customers--retrieve","slug":"/api-reference/customers/customers--retrieve","pageMetadata":{"openapi":"openapi_spec get /customers/{customer_id}","title":"Customers - Retrieve","description":"Retrieves a customer's details.","href":"/api-reference/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":{"codeStyling":"system","config":{},"pageMetadata":{"openapi":"openapi_spec get /customers/{customer_id}","title":"Customers - Retrieve","description":"Retrieves a customer's details.","href":"/api-reference/customers/customers--retrieve","hidden":false}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":["/_mintlify/custom/vaultera/6ce913ae5d413d1a/public/js/custom.js"],"openApiReferenceData":{"operation":{"tags":["Customers"],"summary":"Customers - Retrieve","description":"Retrieves a customer's details.","operationId":"Retrieve a Customer","parameters":["b7de5c2d-dfbd-4d70-8e43-14ac8eed2c51"],"responses":{"200":"02779f1c-e4fa-4500-aa43-e5548793aaa5","404":"c0a59908-166b-4d7f-8f67-58a7cd47ec29"},"security":["42896fe9-76f0-4ba7-a6ac-710bb1731b49","1d49cc80-ec04-4a10-98de-42ea75e58e1a"],"method":"get","type":"path","servers":["69f132bc-3288-4c4d-92ba-af3bde544d3f","fd146f12-f272-409a-99b5-23aa5f7a2d09"],"path":"/customers/{customer_id}","baseUrlOptions":["https://api.test.switch.vaultera.co","https://api.switch.vaultera.co"],"title":"Customers - Retrieve","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"b7de5c2d-dfbd-4d70-8e43-14ac8eed2c51":{"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":{"02779f1c-e4fa-4500-aa43-e5548793aaa5":{"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":"JonTest@test.com","maxLength":255,"uniqueKey":"email.oneOf.0","typeLabel":"string"},{"type":"null","description":"The customer's email address","example":"JonTest@test.com","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 address city","example":"New York","maxLength":50,"uniqueKey":"address.oneOf.0.city.oneOf.0","typeLabel":"string"},{"type":"null","description":"The address city","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 address","example":"123, King Street","maxLength":200,"uniqueKey":"address.oneOf.0.line1.oneOf.0","typeLabel":"string"},{"type":"null","description":"The first line of the address","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 address","example":"Powelson Avenue","maxLength":50,"uniqueKey":"address.oneOf.0.line2.oneOf.0","typeLabel":"string"},{"type":"null","description":"The second line of the address","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 address","example":"Bridgewater","maxLength":50,"uniqueKey":"address.oneOf.0.line3.oneOf.0","typeLabel":"string"},{"type":"null","description":"The third line of the address","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"}},"additionalProperties":false,"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"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"customer_id":"cus_y3oqhf46pyzuxjbcn2giaqnb44","created_at":"2023-01-18T11:04:09.922Z","name":"Jon Test","email":"JonTest@test.com","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"},"metadata":{},"default_payment_method_id":"pm_djh2837dwduh890123"}}},"exampleType":"generated"}},"exampleType":"generated"},"c0a59908-166b-4d7f-8f67-58a7cd47ec29":{"description":"Customer was not found","content":{"_mintlify/placeholder":{"schema":{"type":"object","description":""}}}}},"security":{"42896fe9-76f0-4ba7-a6ac-710bb1731b49":{"api_key":{"type":"apiKey","in":"header","name":"api-key","description":"Use the API key created under your merchant account from the Vaultera Switch 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":[]}},"1d49cc80-ec04-4a10-98de-42ea75e58e1a":{"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":{"69f132bc-3288-4c4d-92ba-af3bde544d3f":{"url":"https://api.test.switch.vaultera.co","description":"Sandbox Environment"},"fd146f12-f272-409a-99b5-23aa5f7a2d09":{"url":"https://api.switch.vaultera.co","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 Vaultera Switch 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 Vaultera Switch 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":"openapi_spec.json"},"subdomain":"vaultera","siteName":"Vaultera Switch","title":"Customers - Retrieve - Vaultera Switch","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2025-09-19T16:36:20.497Z","originalFileLocation":"api-reference/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=\"Vaultera Switch\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/vaultera/SRYQpWbsc5VOCVDE/_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/vaultera/SRYQpWbsc5VOCVDE/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/vaultera/SRYQpWbsc5VOCVDE/_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/vaultera/SRYQpWbsc5VOCVDE/_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/vaultera/SRYQpWbsc5VOCVDE/_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/vaultera/SRYQpWbsc5VOCVDE/_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/vaultera/SRYQpWbsc5VOCVDE/_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/vaultera/SRYQpWbsc5VOCVDE/_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/vaultera/SRYQpWbsc5VOCVDE/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Customers - Retrieve - Vaultera Switch\">\u003cmeta data-mint-head property=\"og:description\" content=\"Retrieves a customer\u0026#x27;s details.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Vaultera Switch\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.switch.vaultera.co/api-reference/customers/customers--retrieve\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://vaultera.mintlify.site/_mintlify/api/og/v2?division=Customers\u0026amp;title=Customers+-+Retrieve\u0026amp;description=Retrieves+a+customer%27s+details.\u0026amp;theme=2af10246053aec8105db19fe\u0026amp;signature=520a73ea58e52bcac43ae6e070547fdf488363c88dfc9e07e4f3b09da9c0c151\">\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 - Vaultera Switch\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Retrieves a customer\u0026#x27;s details.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://vaultera.mintlify.site/_mintlify/api/og/v2?division=Customers\u0026amp;title=Customers+-+Retrieve\u0026amp;description=Retrieves+a+customer%27s+details.\u0026amp;theme=2af10246053aec8105db19fe\u0026amp;signature=520a73ea58e52bcac43ae6e070547fdf488363c88dfc9e07e4f3b09da9c0c151\">\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/vaultera/SRYQpWbsc5VOCVDE/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Vaultera Switch\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#6366f1\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.switch.vaultera.co/api-reference/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=\"/api-reference/customers/customers--retrieve.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.switch.vaultera.co/#organization\",\"name\":\"Vaultera Switch\",\"url\":\"https://docs.switch.vaultera.co\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/vaultera/x20IvR9u7_NHQlSC/logo/light.svg?fit=max\u0026auto=format\u0026n=x20IvR9u7_NHQlSC\u0026q=85\u0026s=af6567a50681ce778aa2ac6aa0f9b400\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.switch.vaultera.co#website\",\"name\":\"Vaultera Switch\",\"url\":\"https://docs.switch.vaultera.co\",\"publisher\":{\"@id\":\"https://docs.switch.vaultera.co/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.switch.vaultera.co/api-reference/customers/customers--retrieve#webpage\",\"url\":\"https://docs.switch.vaultera.co/api-reference/customers/customers--retrieve\",\"name\":\"Customers - Retrieve\",\"description\":\"Retrieves a customer's details.\",\"dateModified\":\"2025-09-19T16:36:20.497Z\",\"isPartOf\":{\"@id\":\"https://docs.switch.vaultera.co#website\"},\"breadcrumb\":{\"@id\":\"https://docs.switch.vaultera.co/api-reference/customers/customers--retrieve#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.switch.vaultera.co/api-reference/customers/customers--retrieve#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Core APIs\",\"item\":\"https://docs.switch.vaultera.co/api-reference/payments/Introduction--to--payments\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Customers\",\"item\":\"https://docs.switch.vaultera.co/api-reference/customers/customers--create\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Customers - Retrieve\",\"item\":\"https://docs.switch.vaultera.co/api-reference/customers/customers--retrieve\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.switch.vaultera.co/api-reference/customers/customers--retrieve#apireference\",\"headline\":\"Customers - Retrieve\",\"name\":\"Customers - Retrieve\",\"description\":\"Retrieves a customer's details.\",\"url\":\"https://docs.switch.vaultera.co/api-reference/customers/customers--retrieve\",\"mainEntityOfPage\":{\"@id\":\"https://docs.switch.vaultera.co/api-reference/customers/customers--retrieve#webpage\"},\"dateModified\":\"2025-09-19T16:36:20.497Z\",\"publisher\":{\"@id\":\"https://docs.switch.vaultera.co/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.switch.vaultera.co#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Vaultera Switch\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Vaultera Switch","nav":{"global":null,"tabs":[{"tab":"Welcome","icon":"home","pages":[{"title":"Welcome","href":"/introduction"}]},{"tab":"Explore","icon":"book","pages":[{"title":"Explore","href":"/start/exploration-guide"}]},{"tab":"API Reference","icon":"code","groups":[{"group":"Overview","pages":[{"title":"API Reference Overview","href":"/overview","hidden":false}]},{"group":"Core APIs","pages":[{"group":"Payments","icon":"credit-card","pages":[{"sidebarTitle":"Getting Started with Payments","icon":"circle-play","iconType":"solid","title":null,"href":"/api-reference/payments/Introduction--to--payments","hidden":false},{"openapi":"openapi_spec post /payments","title":"Payments - Create","href":"/api-reference/payments/payments--create","hidden":false},{"openapi":"openapi_spec post /payments/{payment_id}","title":"Payments - Update","href":"/api-reference/payments/payments--update","hidden":false},{"openapi":"openapi_spec post /payments/{payment_id}/confirm","title":"Payments - Confirm","href":"/api-reference/payments/payments--confirm","hidden":false},{"openapi":"openapi_spec get /payments/{payment_id}","title":"Payments - Retrieve","href":"/api-reference/payments/payments--retrieve","hidden":false},{"openapi":"openapi_spec post /payments/{payment_id}/cancel","title":"Payments - Cancel","href":"/api-reference/payments/payments--cancel","hidden":false},{"openapi":"openapi_spec post /payments/{payment_id}/capture","title":"Payments - Capture","href":"/api-reference/payments/payments--capture","hidden":false},{"openapi":"post /payments/{payment_id}/incremental_authorization","title":"Payments - Incremental Authorization","href":"/api-reference/payments/payments--incremental-authorization","hidden":false}]},{"group":"Payment Methods","icon":"wallet","pages":[{"openapi":"openapi_spec post /payment_methods","title":"PaymentMethods - Create","href":"/api-reference/payment-methods/paymentmethods--create","hidden":false},{"openapi":"openapi_spec get /payment_methods/{method_id}","title":"Payment Method - Retrieve","href":"/api-reference/payment-methods/payment-method--retrieve","hidden":false},{"openapi":"openapi_spec post /payment_methods/{method_id}/update","title":"Payment Method - Update","href":"/api-reference/payment-methods/payment-method--update","hidden":false},{"openapi":"openapi_spec delete /payment_methods/{method_id}","title":"Payment Method - Delete","href":"/api-reference/payment-methods/payment-method--delete","hidden":false},{"openapi":"get /{customer_id}/payment_methods/{payment_method_id}/default","title":"Payment Method - Set Default Payment Method for Customer","href":"/api-reference/payment-methods/payment-method--set-default-payment-method-for-customer","hidden":false}]},{"group":"Customers","icon":"users","pages":[{"openapi":"openapi_spec 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":"/api-reference/customers/customers--create","hidden":false},{"openapi":"openapi_spec get /customers/{customer_id}","title":"Customers - Retrieve","href":"/api-reference/customers/customers--retrieve","hidden":false},{"openapi":"openapi_spec post /customers/{customer_id}","title":"Customers - Update","description":"Updates the customer's details in a customer object.","href":"/api-reference/customers/customers--update","hidden":false},{"openapi":"openapi_spec delete /customers/{customer_id}","title":"Customers - Delete","href":"/api-reference/customers/customers--delete","hidden":false},{"openapi":"openapi_spec get /customers/list","title":"Customers - List","href":"/api-reference/customers/customers--list","hidden":false}]},{"group":"Refunds","icon":"undo","pages":[{"openapi":"openapi_spec post /refunds","title":"Refunds - Create","href":"/api-reference/refunds/refunds--create","hidden":false},{"openapi":"openapi_spec post /refunds/{refund_id}","title":"Refunds - Update","href":"/api-reference/refunds/refunds--update","hidden":false},{"openapi":"openapi_spec get /refunds/{refund_id}","title":"Refunds - Retrieve","href":"/api-reference/refunds/refunds--retrieve","hidden":false},{"openapi":"openapi_spec post /refunds/list","title":"Refunds - List","href":"/api-reference/refunds/refunds--list","hidden":false}]},{"group":"Disputes","icon":"triangle-alert","pages":[{"openapi":"openapi_spec get /disputes/{dispute_id}","title":"Disputes - Retrieve Dispute","href":"/api-reference/disputes/disputes--retrieve","hidden":false},{"openapi":"openapi_spec get /disputes/list","title":"Disputes - List Disputes","href":"/api-reference/disputes/disputes--list","hidden":false}]}]}]},{"tab":"Support Matrix","icon":"table-2","pages":[{"title":"Support Matrix","href":"/support-matrix"}]}]},"basePath":"","title":"Customers - Retrieve - Vaultera Switch","buildId":"dpl_DTau1J5HqS9UTgVSDwGksstFWtPa","deploymentId":"dpl_DTau1J5HqS9UTgVSDwGksstFWtPa","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-5FCzAcfS.js","utils-SLtAG4EZ.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-2DZi8ZMu.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-D7J3nkzE.js","snippetPresets-D0Alv0AH.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","conditional-requirements-CFM0id0Q.js","ApiExamples-BI4qNJ2c.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-BD3uyr8j.js","shallow-D8iEBr5z.js","getApiPlaygroundDisplay-CgNP4lzR.js","CodeSnippet-CX-QHuMs.js","CodeSnippets-VlXE-ZUf.js","Page-D9ithiIZ.js","getPastedJson-DYNQkZ1M.js","icon-CzacdwOi.js","MethodPill-2JVqoYKi.js","DuplicateIcon-_xVXs-U8.js","createIcon-BRHrweLo.js","DynamicMarkdown-mQG_iQiE.js","SectionHeading-DMpJzv8f.js","axios-vUo_bRtp.js","Markdown-5FGIym-8.js","clsx-D-TRO5q5.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-CdrJecqK.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-CHlcWBLM.js"]}