{
"data": {
"message": [
"O campo email \"email\" informado é inválido",
"O documento informado é inválido",
"O campo data de nascimento \"birthdate\" deve estar no formato yyyy-mm-dd",
"address.O campo rua \"street\" é obrigatório",
"address.O campo rua \"street\" deve ser um texto válido",
"address.O campo número \"streetNumber\" é obrigatório",
"address.O campo número \"streetNumber\" deve ser um número válido",
"address.O campo bairro \"neighborhood\" é obrigatório",
"address.O campo bairro \"neighborhood\" deve ser um texto válido",
"address.O campo cidade \"city\" é obrigatório",
"address.O campo cidade \"city\" deve ser um texto válido",
"address.O campo estado \"state\" é obrigatório",
"address.O campo estado \"state\" deve ser um texto válido",
"address.O campo CEP \"zipcode\" é obrigatório",
"address.O campo CEP \"zipcode\" deve ser um número válido"
],
"error": "Bad Request",
"statusCode": 400
}
}
Clientes
Adicionar cliente
Cria um novo cliente no sistema. Nenhum campo é obrigatório, exceto os campos do endereço quando informado.
{
"data": {
"message": [
"O campo email \"email\" informado é inválido",
"O documento informado é inválido",
"O campo data de nascimento \"birthdate\" deve estar no formato yyyy-mm-dd",
"address.O campo rua \"street\" é obrigatório",
"address.O campo rua \"street\" deve ser um texto válido",
"address.O campo número \"streetNumber\" é obrigatório",
"address.O campo número \"streetNumber\" deve ser um número válido",
"address.O campo bairro \"neighborhood\" é obrigatório",
"address.O campo bairro \"neighborhood\" deve ser um texto válido",
"address.O campo cidade \"city\" é obrigatório",
"address.O campo cidade \"city\" deve ser um texto válido",
"address.O campo estado \"state\" é obrigatório",
"address.O campo estado \"state\" deve ser um texto válido",
"address.O campo CEP \"zipcode\" é obrigatório",
"address.O campo CEP \"zipcode\" deve ser um número válido"
],
"error": "Bad Request",
"statusCode": 400
}
}
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Super Pagamentos","colors":{"primary":"#0641FC","light":"#0975e0","dark":"#3866f5"},"logo":{"light":"https://mintcdn.com/superpagamentos/dK50feAMCgWuqW1L/logo/dark.svg?fit=max\u0026auto=format\u0026n=dK50feAMCgWuqW1L\u0026q=85\u0026s=1054724d4fec9dfed2816711dcb2d83e","dark":"https://mintcdn.com/superpagamentos/dK50feAMCgWuqW1L/logo/light.svg?fit=max\u0026auto=format\u0026n=dK50feAMCgWuqW1L\u0026q=85\u0026s=d0b18e464819bf76993be8bbb3d23be6"},"favicon":"https://mintcdn.com/superpagamentos/dK50feAMCgWuqW1L/favicon.svg?fit=max\u0026auto=format\u0026n=dK50feAMCgWuqW1L\u0026q=85\u0026s=5221c5a3b05b9db3d22e3f1b4b2e70e1","navbar":{"links":[{"href":"https://wa.me/+5527999971368","label":"Suporte"}],"primary":{"type":"button","label":"Plataforma","href":"https://dashboard.superpagamentos.com"}},"footer":{"socials":{"instagram":"https://www.instagram.com/superpagamentos","linkedin":"https://www.linkedin.com/company/super-pagamentos"}},"styling":{"latex":false},"navigation":{"global":{"anchors":[{"anchor":"WhatsApp de Suporte","icon":"whatsapp","href":"https://wa.me/+5527933001841"},{"anchor":"Canal do Youtube","icon":"youtube","href":"https://www.youtube.com/@superpagamentos"},{"anchor":"Nosso Instagram","icon":"instagram","href":"https://www.instagram.com/superpagamentos"}]},"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"superpagamentos","hasAudioNarration":false,"actualSubdomain":"superpagamentos","customDomains":["docs.superpagamentos.com"],"gitSource":{"type":"github","owner":"superpagamentos","repo":"docs","deployBranch":"main","contentDirectory":"","isPrivate":false,"mountPath":"","label":""},"entitlements":{},"buildId":"6ae927d55f606b95dff1afac:success","clientVersion":"0.0.4111","searchFilterCounts":[{"language":"default","tag":"Referências da API","count":36},{"language":"default","tag":"Guia de implementação","count":10},{"language":"default","tag":"Assinaturas de Recorrência","count":9},{"language":"default","tag":"Transações","count":8},{"language":"default","tag":"Introdução e Aspectos Gerais","count":6},{"language":"default","tag":"Clientes","count":5},{"language":"default","tag":"Subcontas","count":5},{"language":"default","tag":"Contas Bancárias","count":4},{"language":"default","tag":"Saldo e Transferências","count":4},{"language":"default","tag":"Tokenização de Cartões","count":3}]},"assistantConfig":{},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-rbac-roles","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}],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api-reference/endpoint/customers/create","slug":"/api-reference/endpoint/customers/create","pageMetadata":{"title":"Adicionar cliente","openapi":"POST /customers","description":"Cria um novo cliente no sistema. Nenhum campo é obrigatório, exceto os campos do endereço quando informado.","href":"/api-reference/endpoint/customers/create"},"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: \"Cria um novo cliente no sistema. Nenhum campo é obrigatório, exceto os campos do endereço quando informado.\"\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":{"title":"Adicionar cliente","openapi":"POST /customers","description":"Cria um novo cliente no sistema. Nenhum campo é obrigatório, exceto os campos do endereço quando informado.","href":"/api-reference/endpoint/customers/create"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"description":"Cria um novo cliente no sistema. Nenhum campo é obrigatório, exceto os campos do endereço quando informado.","security":["1c65d066-d05c-465e-964d-d60d01df5626"],"requestBody":"d8005cd8-9a95-4b8f-8287-27276bc3c541","responses":{"200":"4f02239c-659c-44df-92ff-21ec3c878235","400":"29f0fcbe-fb74-4244-bd96-418b4c07aa92"},"method":"post","type":"path","servers":["8d0bc952-015d-46c8-9666-b5b3b7a67207","b674dacc-dedf-41a9-a763-9ce11fc4a6a9"],"path":"/customers","baseUrlOptions":["https://sandbox-api.superpagamentos.com","https://api.superpagamentos.com"],"title":"","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["firstName","lastName","email","document"],"properties":{"firstName":{"type":"string","description":"Nome do cliente","example":"João","isRequired":true,"uniqueKey":"firstName","typeLabel":"string"},"lastName":{"type":"string","description":"Sobrenome do cliente","example":"Silva","isRequired":true,"uniqueKey":"lastName","typeLabel":"string"},"email":{"type":"string","description":"Email do cliente","example":"email@email.com","isRequired":true,"uniqueKey":"email","typeLabel":"string"},"document":{"type":"string","description":"CPF ou CNPJ do cliente","example":"00000000000","isRequired":true,"uniqueKey":"document","typeLabel":"string"},"phoneNumber":{"type":"string","description":"Número de telefone do cliente","example":"00000000000","uniqueKey":"phoneNumber","typeLabel":"string"},"birthdate":{"type":"string","format":"date","description":"Data de nascimento do cliente no formato yyyy-mm-dd","example":"1994-10-04","uniqueKey":"birthdate","typeLabel":"string\u003cdate>"},"address":{"type":"object","description":"Endereço do cliente","properties":{"zipcode":{"description":"CEP do endereço","type":"integer","example":87654321,"isRequired":true,"uniqueKey":"address.zipcode","typeLabel":"integer"},"street":{"description":"Nome da rua","type":"string","example":"Rua B","isRequired":true,"uniqueKey":"address.street","typeLabel":"string"},"streetNumber":{"description":"Número do endereço","type":"integer","example":200,"isRequired":true,"uniqueKey":"address.streetNumber","typeLabel":"integer"},"neighborhood":{"description":"Bairro do endereço","type":"string","example":"Jardins","isRequired":true,"uniqueKey":"address.neighborhood","typeLabel":"string"},"city":{"description":"Cidade do endereço","type":"string","example":"São Paulo","isRequired":true,"uniqueKey":"address.city","typeLabel":"string"},"state":{"description":"Estado do endereço","type":"string","example":"SP","isRequired":true,"uniqueKey":"address.state","typeLabel":"string"},"complement":{"type":"string","description":"Complemento do endereço (opcional)","example":"Casa 10","uniqueKey":"address.complement","typeLabel":"string"},"reference":{"type":"string","description":"Ponto de referência do endereço (opcional)","example":"Ao lado da padaria","uniqueKey":"address.reference","typeLabel":"string"}},"required":["zipcode","street","streetNumber","neighborhood","city","state"],"uniqueKey":"address","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"firstName":"João","lastName":"Silva","email":"email@email.com","document":"00000000000","phoneNumber":"00000000000","birthdate":"1994-10-04"}}},"exampleType":"generated"}},"exampleType":"generated"},"responses":{"4f02239c-659c-44df-92ff-21ec3c878235":{"description":"Cliente criado com sucesso","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"id":{"type":"string","format":"uuid","example":"8a2edf48-704b-4c23-8278-a902e88a5f93","uniqueKey":"data.id","typeLabel":"string\u003cuuid>"},"firstName":{"type":"string","example":"João","uniqueKey":"data.firstName","typeLabel":"string"},"lastName":{"type":"string","example":"Silva","uniqueKey":"data.lastName","typeLabel":"string"},"email":{"type":"string","example":"email@email.com","uniqueKey":"data.email","typeLabel":"string"},"phoneNumber":{"type":"string","example":"00000000000","uniqueKey":"data.phoneNumber","typeLabel":"string"},"document":{"type":"string","example":"00000000000","uniqueKey":"data.document","typeLabel":"string"},"birthdate":{"type":"string","format":"date","example":"1994-10-04","uniqueKey":"data.birthdate","typeLabel":"string\u003cdate>"},"address":{"type":"object","properties":{"statusId":{"type":"string","example":"APPROVED","uniqueKey":"data.address.statusId","typeLabel":"string"},"zipcode":{"type":"integer","example":87654321,"uniqueKey":"data.address.zipcode","typeLabel":"integer"},"street":{"type":"string","example":"Rua B","uniqueKey":"data.address.street","typeLabel":"string"},"streetNumber":{"type":"integer","example":200,"uniqueKey":"data.address.streetNumber","typeLabel":"integer"},"complement":{"type":"string","example":"Casa 10","uniqueKey":"data.address.complement","typeLabel":"string"},"reference":{"type":"string","example":"Ao lado da padaria","uniqueKey":"data.address.reference","typeLabel":"string"},"neighborhood":{"type":"string","example":"Jardins","uniqueKey":"data.address.neighborhood","typeLabel":"string"},"city":{"type":"string","example":"São Paulo","uniqueKey":"data.address.city","typeLabel":"string"},"state":{"type":"string","example":"SP","uniqueKey":"data.address.state","typeLabel":"string"}},"uniqueKey":"data.address","typeLabel":"object"},"statusId":{"type":"string","example":"APPROVED","uniqueKey":"data.statusId","typeLabel":"string"},"createdAt":{"type":"string","format":"date-time","example":"2025-06-01T16:14:10.535Z","uniqueKey":"data.createdAt","typeLabel":"string\u003cdate-time>"}},"uniqueKey":"data","typeLabel":"object"},"message":{"type":"string","example":"Cliente criado com sucesso","uniqueKey":"message","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"data":{"id":"8a2edf48-704b-4c23-8278-a902e88a5f93","firstName":"João","lastName":"Silva","email":"email@email.com","phoneNumber":"00000000000","document":"00000000000","birthdate":"1994-10-04","address":{"statusId":"APPROVED","zipcode":87654321,"street":"Rua B","streetNumber":200,"complement":"Casa 10","reference":"Ao lado da padaria","neighborhood":"Jardins","city":"São Paulo","state":"SP"},"statusId":"APPROVED","createdAt":"2025-06-01T16:14:10.535Z"},"message":"Cliente criado com sucesso"}}},"exampleType":"generated"}},"exampleType":"generated"},"29f0fcbe-fb74-4244-bd96-418b4c07aa92":{"description":"Erro na requisição","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"data":{"type":"object","properties":{"message":{"type":"array","items":{"type":"string","uniqueKey":"oneOf.0.data.message.items.[INDEX]","typeLabel":"string"},"example":["O campo email \"email\" informado é inválido","O documento informado é inválido","O campo data de nascimento \"birthdate\" deve estar no formato yyyy-mm-dd","address.O campo rua \"street\" é obrigatório","address.O campo rua \"street\" deve ser um texto válido","address.O campo número \"streetNumber\" é obrigatório","address.O campo número \"streetNumber\" deve ser um número válido","address.O campo bairro \"neighborhood\" é obrigatório","address.O campo bairro \"neighborhood\" deve ser um texto válido","address.O campo cidade \"city\" é obrigatório","address.O campo cidade \"city\" deve ser um texto válido","address.O campo estado \"state\" é obrigatório","address.O campo estado \"state\" deve ser um texto válido","address.O campo CEP \"zipcode\" é obrigatório","address.O campo CEP \"zipcode\" deve ser um número válido"],"uniqueKey":"oneOf.0.data.message","typeLabel":"string[]"},"error":{"type":"string","example":"Bad Request","uniqueKey":"oneOf.0.data.error","typeLabel":"string"},"statusCode":{"type":"integer","example":400,"uniqueKey":"oneOf.0.data.statusCode","typeLabel":"integer"}},"uniqueKey":"oneOf.0.data","typeLabel":"object"}},"uniqueKey":"oneOf.0","typeLabel":"object"},{"type":"object","properties":{"data":{"type":"object","properties":{"message":{"type":"string","example":"Erro ao criar cliente","uniqueKey":"oneOf.1.data.message","typeLabel":"string"},"returnCode":{"type":"integer","example":-7403,"uniqueKey":"oneOf.1.data.returnCode","typeLabel":"integer"}},"uniqueKey":"oneOf.1.data","typeLabel":"object"}},"uniqueKey":"oneOf.1","typeLabel":"object"}],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"data":{"message":["O campo email \"email\" informado é inválido","O documento informado é inválido","O campo data de nascimento \"birthdate\" deve estar no formato yyyy-mm-dd","address.O campo rua \"street\" é obrigatório","address.O campo rua \"street\" deve ser um texto válido","address.O campo número \"streetNumber\" é obrigatório","address.O campo número \"streetNumber\" deve ser um número válido","address.O campo bairro \"neighborhood\" é obrigatório","address.O campo bairro \"neighborhood\" deve ser um texto válido","address.O campo cidade \"city\" é obrigatório","address.O campo cidade \"city\" deve ser um texto válido","address.O campo estado \"state\" é obrigatório","address.O campo estado \"state\" deve ser um texto válido","address.O campo CEP \"zipcode\" é obrigatório","address.O campo CEP \"zipcode\" deve ser um número válido"],"error":"Bad Request","statusCode":400}}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"1c65d066-d05c-465e-964d-d60d01df5626":{"bearerAuth":{"type":"http","scheme":"bearer","description":"Token JWT gerado na rota de autenticação (/auth). Deve ser enviado no formato: Bearer \u003ctoken>","scopes":[]}}},"servers":{"8d0bc952-015d-46c8-9666-b5b3b7a67207":{"url":"https://sandbox-api.superpagamentos.com","description":"Ambiente de desenvolvimento"},"b674dacc-dedf-41a9-a763-9ce11fc4a6a9":{"url":"https://api.superpagamentos.com","description":"Ambiente de produção"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","description":"Token JWT gerado na rota de autenticação (/auth). Deve ser enviado no formato: Bearer \u003ctoken>","scopes":[]},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"Token JWT gerado na rota de autenticação (/auth). Deve ser enviado no formato: Bearer \u003ctoken>","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"bearerAuth","name":"Authorization"}],"title":"bearerAuth"}]},"originalFileLocation":"api-reference/openapi.json"},"subdomain":"superpagamentos","siteName":"Super Pagamentos","title":"Adicionar cliente - Super Pagamentos","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-01-07T08:00:34.279Z","originalFileLocation":"api-reference/endpoint/customers/create.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=\"Cria um novo cliente no sistema. Nenhum campo é obrigatório, exceto os campos do endereço quando informado.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Super Pagamentos\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/superpagamentos/ZZ0vrV_-lzRJLcdi/_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/superpagamentos/ZZ0vrV_-lzRJLcdi/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/superpagamentos/ZZ0vrV_-lzRJLcdi/_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/superpagamentos/ZZ0vrV_-lzRJLcdi/_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/superpagamentos/ZZ0vrV_-lzRJLcdi/_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/superpagamentos/ZZ0vrV_-lzRJLcdi/_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/superpagamentos/ZZ0vrV_-lzRJLcdi/_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/superpagamentos/ZZ0vrV_-lzRJLcdi/_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/superpagamentos/ZZ0vrV_-lzRJLcdi/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Adicionar cliente - Super Pagamentos\">\u003cmeta data-mint-head property=\"og:description\" content=\"Cria um novo cliente no sistema. Nenhum campo é obrigatório, exceto os campos do endereço quando informado.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Super Pagamentos\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.superpagamentos.com/api-reference/endpoint/customers/create\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://superpagamentos.mintlify.site/_mintlify/api/og/v2?division=Clientes\u0026amp;title=Adicionar+cliente\u0026amp;description=Cria+um+novo+cliente+no+sistema.+Nenhum+campo+%C3%A9+obrigat%C3%B3rio%2C+exceto+os+campos+do+endere%C3%A7o+quando+informado.\u0026amp;theme=3efb47b930ba8d686819f4a9\u0026amp;signature=45104318735b4f3afe5a66e60d3b6d9f6e8861b161ed16d0fde4de3661b0e9e2\">\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=\"Adicionar cliente - Super Pagamentos\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Cria um novo cliente no sistema. Nenhum campo é obrigatório, exceto os campos do endereço quando informado.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://superpagamentos.mintlify.site/_mintlify/api/og/v2?division=Clientes\u0026amp;title=Adicionar+cliente\u0026amp;description=Cria+um+novo+cliente+no+sistema.+Nenhum+campo+%C3%A9+obrigat%C3%B3rio%2C+exceto+os+campos+do+endere%C3%A7o+quando+informado.\u0026amp;theme=3efb47b930ba8d686819f4a9\u0026amp;signature=45104318735b4f3afe5a66e60d3b6d9f6e8861b161ed16d0fde4de3661b0e9e2\">\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/superpagamentos/ZZ0vrV_-lzRJLcdi/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Super Pagamentos\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#0641FC\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.superpagamentos.com/api-reference/endpoint/customers/create\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/endpoint/customers/create.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.superpagamentos.com/#organization\",\"name\":\"Super Pagamentos\",\"url\":\"https://docs.superpagamentos.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/superpagamentos/dK50feAMCgWuqW1L/logo/dark.svg?fit=max\u0026auto=format\u0026n=dK50feAMCgWuqW1L\u0026q=85\u0026s=1054724d4fec9dfed2816711dcb2d83e\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.superpagamentos.com#website\",\"name\":\"Super Pagamentos\",\"url\":\"https://docs.superpagamentos.com\",\"publisher\":{\"@id\":\"https://docs.superpagamentos.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.superpagamentos.com/api-reference/endpoint/customers/create#webpage\",\"url\":\"https://docs.superpagamentos.com/api-reference/endpoint/customers/create\",\"name\":\"Adicionar cliente\",\"description\":\"Cria um novo cliente no sistema. Nenhum campo é obrigatório, exceto os campos do endereço quando informado.\",\"dateModified\":\"2026-01-07T08:00:34.279Z\",\"isPartOf\":{\"@id\":\"https://docs.superpagamentos.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.superpagamentos.com/api-reference/endpoint/customers/create#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.superpagamentos.com/api-reference/endpoint/customers/create#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Super Pagamentos\",\"item\":\"https://docs.superpagamentos.com\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Adicionar cliente\",\"item\":\"https://docs.superpagamentos.com/api-reference/endpoint/customers/create\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.superpagamentos.com/api-reference/endpoint/customers/create#apireference\",\"headline\":\"Adicionar cliente\",\"name\":\"Adicionar cliente\",\"description\":\"Cria um novo cliente no sistema. Nenhum campo é obrigatório, exceto os campos do endereço quando informado.\",\"url\":\"https://docs.superpagamentos.com/api-reference/endpoint/customers/create\",\"mainEntityOfPage\":{\"@id\":\"https://docs.superpagamentos.com/api-reference/endpoint/customers/create#webpage\"},\"dateModified\":\"2026-01-07T08:00:34.279Z\",\"publisher\":{\"@id\":\"https://docs.superpagamentos.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.superpagamentos.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Super Pagamentos\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"Super Pagamentos\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/api-reference/endpoint/customers/create.md","siteName":"Super Pagamentos","nav":{"global":{"anchors":[{"anchor":"WhatsApp de Suporte","icon":"whatsapp","href":"https://wa.me/+5527933001841"},{"anchor":"Canal do Youtube","icon":"youtube","href":"https://www.youtube.com/@superpagamentos"},{"anchor":"Nosso Instagram","icon":"instagram","href":"https://www.instagram.com/superpagamentos"}]},"tabs":[{"tab":"Guia de implementação","pages":[{"title":"Guia de implementação","href":"/introduction"}]},{"tab":"Referências da API","groups":[{"group":"Documentação da API","pages":[{"title":"Introdução","href":"/api-reference/introduction"}]},{"group":"Autenticação","pages":[{"title":"Autenticar conta","openapi":"POST /auth","href":"/api-reference/endpoint/authentication/auth"}]},{"group":"Subcontas","pages":[{"title":"Adicionar subconta PF","openapi":"POST /subaccounts/pf","href":"/api-reference/endpoint/subaccounts/createpf"},{"title":"Adicionar subconta PJ","openapi":"POST /subaccounts/pj","href":"/api-reference/endpoint/subaccounts/createpj"},{"title":"Listar subcontas","openapi":"GET /subaccounts","href":"/api-reference/endpoint/subaccounts/listall"},{"title":"Detalhar subconta","openapi":"GET /subaccounts/{subaccountId}","href":"/api-reference/endpoint/subaccounts/findone"},{"title":"Remover subconta","openapi":"DELETE /subaccounts/{subaccountId}","href":"/api-reference/endpoint/subaccounts/delete"}]},{"group":"Contas Bancárias","pages":[{"title":"Adicionar conta bancária","openapi":"POST /bank_accounts","href":"/api-reference/endpoint/bank_accounts/create"},{"title":"Listar contas bancárias","openapi":"GET /bank_accounts","href":"/api-reference/endpoint/bank_accounts/list"},{"title":"Detalhar conta bancária","openapi":"GET /bank_accounts/{bankAccountId}","href":"/api-reference/endpoint/bank_accounts/get"},{"title":"Remover conta bancária","openapi":"DELETE /bank_accounts/{bankAccountId}","description":"Remove uma conta bancária específica que pertence à empresa cadastrada. Esta operação é irreversível e deve ser utilizada com cautela.\n\n**Operação em subconta:**\nPara deletar uma conta bancária específica de uma subconta, inclua o header `x-subaccount-id` com o ID da subconta. Quando este header é fornecido, a operação será realizada no contexto da subconta especificada, em vez da conta principal autenticada.","href":"/api-reference/endpoint/bank_accounts/delete"}]},{"group":"Clientes","pages":[{"title":"Adicionar cliente","openapi":"POST /customers","href":"/api-reference/endpoint/customers/create"},{"title":"Listar clientes","openapi":"GET /customers","description":"Lista todos os clientes cadastrados. A resposta inclui informações detalhadas de cada cliente, como dados pessoais, contato e endereço. Os resultados são paginados para melhor performance.","href":"/api-reference/endpoint/customers/list"},{"title":"Detalhar cliente","openapi":"GET /customers/{customerId}","href":"/api-reference/endpoint/customers/get"},{"title":"Atualizar cliente","openapi":"PUT /customers/{customerId}","href":"/api-reference/endpoint/customers/update"},{"title":"Remover cliente","openapi":"DELETE /customers/{customerId}","href":"/api-reference/endpoint/customers/delete"}]},{"group":"Tokenização de Cartões","pages":[{"title":"Tokenizar cartão de crédito","openapi":"POST /cards/tokenize","href":"/api-reference/endpoint/cards/tokenize"},{"title":"Recuperar dados do cartão tokenizado","openapi":"GET /cards/{tokenizedCardId}","href":"/api-reference/endpoint/cards/get"},{"title":"Remover token","openapi":"DELETE /cards/{tokenizedCardId}","href":"/api-reference/endpoint/cards/delete"}]},{"group":"Transações","pages":[{"title":"Gerar transação","openapi":"POST /payments","href":"/api-reference/endpoint/transactions/generatepayment"},{"title":"Listar transações","openapi":"GET /payments","href":"/api-reference/endpoint/transactions/list"},{"title":"Detalhar transação","openapi":"GET /payments/{paymentId}","href":"/api-reference/endpoint/transactions/get"},{"title":"Estornar transação","openapi":"POST /payments/refund","href":"/api-reference/endpoint/transactions/refund"}]},{"group":"Assinaturas de Recorrência","pages":[{"title":"Adicionar assinatura","openapi":"POST /subscriptions","href":"/api-reference/endpoint/subscriptions/create"},{"title":"Listar assinaturas","openapi":"GET /subscriptions","href":"/api-reference/endpoint/subscriptions/list"},{"title":"Detalhar assinatura","openapi":"GET /subscriptions/{subscriptionId}","href":"/api-reference/endpoint/subscriptions/get"},{"title":"Atualizar assinatura","openapi":"PUT /subscriptions/{subscriptionId}","href":"/api-reference/endpoint/subscriptions/update"},{"title":"Adicionar split na assinatura","openapi":"POST /subscriptions/add_split","href":"/api-reference/endpoint/subscriptions/addsplit"},{"title":"Remover split da assinatura","openapi":"DELETE /subscriptions/{subscriptionId}/remove_split/{splitId}","href":"/api-reference/endpoint/subscriptions/removesplit"},{"title":"Suspender assinatura","openapi":"POST /subscriptions/{subscriptionId}/suspend","href":"/api-reference/endpoint/subscriptions/suspend"},{"title":"Reativar assinatura","openapi":"POST /subscriptions/{subscriptionId}/reactivate","href":"/api-reference/endpoint/subscriptions/reactivate"},{"title":"Cancelar assinatura","openapi":"DELETE /subscriptions/{subscriptionId}","href":"/api-reference/endpoint/subscriptions/cancel"}]},{"group":"Saldo e Transferências","pages":[{"title":"Listar saques","openapi":"GET /withdrawals","href":"/api-reference/endpoint/withdrawals/list"},{"title":"Consultar saldos","openapi":"GET /withdrawals/balance","href":"/api-reference/endpoint/withdrawals/balance"},{"title":"Detalha saque","openapi":"GET /withdrawals/{withdrawalId}","href":"/api-reference/endpoint/withdrawals/get"},{"title":"Solicitar saque","openapi":"POST /withdrawals/withdraw","href":"/api-reference/endpoint/withdrawals/withdraw"}]}]}]},"basePath":"","title":"Adicionar cliente - Super Pagamentos","buildId":"dpl_DqYu5MPb49gWBBbUGgpHQUmCHY3P","deploymentId":"dpl_DqYu5MPb49gWBBbUGgpHQUmCHY3P","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-CybtLBIt.js","utils-BMLj2fvV.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-B6In562Y.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-Dr8Mfhp9.js","snippetPresets-2rmQvMVl.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","conditional-requirements-CFM0id0Q.js","ApiExamples-WMqJYdZj.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-CJ-MlPHu.js","shallow-dY3TMRCk.js","getApiPlaygroundDisplay-v-1B2bKm.js","CodeSnippet-BDhiTB7U.js","CodeSnippets-D9hnzQcS.js","Page-C4GwDT3_.js","getPastedJson-Th2V45jI.js","icon-BQXch1W9.js","MethodPill-BCqUneP3.js","DuplicateIcon-Q_-bhurZ.js","createIcon-DUjLHRqp.js","DynamicMarkdown-B-f2cqXQ.js","SectionHeading-Da5NsV4v.js","axios-vUo_bRtp.js","Markdown-D13FWkIM.js","clsx-D3Isdib3.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-C-XZBk9h.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink--qIqmmVG.js"]}