--- updatedAt: 2026-04-06T17:33:45.000Z agentTools: projectIndex: https://docs.pagar.me/v4/llms.txt --- # Criando um customer Através dessa rota você pode salvar os dados de um cliente no nosso banco de dados. > ❗️ Atenção: Essa versão de API será descontinuada > > Essa versão da API Pagar.me já não é mais atualizada e, em breve, deixará de funcionar. Para que sua loja possa vender sem problemas, você precisa realizar sua integração usando a versão mais recente da nossa API, a V5. > > No canto superior esquerdo da tela é indicado qual versão da documentação você está vendo. Clique na seta onde indica a versão e altere para a V5 para acessar a documentação. > > Se você já é cliente, precisa realizar obrigatoriamente a migração para a versão V5. > > Em caso de dúvidas, basta entrar em contato com o nosso time de atendimento através do e-mail, enviando a sua dúvida para e por telefone, ligando para 4004-1330. Se você já é cliente pode também entrar em contato através do chat dentro da sua Dashboard. > 📘 > > A entidade `customer` pode ser passada como parâmetro em diversos outros endpoints. Nessas chamadas os customers também são criados. > 🚧 Limite de 25 documentos por objeto > > Para garantir a integridade do funcionamento dos nossos serviços, o número máximo de documentos que um mesmo consumidor pode ter é 25. # OpenAPI definition ```json { "openapi": "3.1.0", "info": { "title": "api-settings", "version": "4" }, "servers": [ { "url": "https://api.pagar.me/1" } ], "components": { "securitySchemes": { "sec0": { "x-default": "", "type": "apiKey", "name": "api_key", "in": "query" } } }, "security": [ { "sec0": [] } ], "paths": { "/customers": { "post": { "summary": "Criando um customer", "description": "Através dessa rota você pode salvar os dados de um cliente no nosso banco de dados.", "operationId": "criando-um-cliente", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "name", "email", "external_id", "type", "country", "phone_numbers", "documents" ], "properties": { "name": { "type": "string", "description": "Nome ou razão social do comprador" }, "email": { "type": "string", "description": "E-mail do comprador" }, "external_id": { "type": "string", "description": "Identificador do cliente na loja" }, "type": { "type": "string", "description": "Tipo de documento. Deve ser `individual` para pessoa física ou `corporation` para pessoa jurídica" }, "country": { "type": "string", "description": "País" }, "birthday": { "type": "string", "description": "Data de nascimento" }, "phone_numbers": { "type": "array", "description": "Números de telefone. Requer ao menos um valor. Deve seguir o padrão E.164", "items": { "type": "string" } }, "documents": { "type": "array", "description": "Documento. Contém campos `type` para tipo de documento e `number` para número do documento. Para mais informações, clique [**aqui**](https://docs.pagar.me/reference#objeto-documents-documentos)" } } } } } }, "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"object\": \"customer\",\n \"id\": 233406,\n \"external_id\": \"#123456789\",\n \"type\": \"individual\",\n \"country\": \"br\",\n \"document_number\": null,\n \"document_type\": \"cpf\",\n \"name\": \"João das Neves\",\n \"email\": \"joaoneves@norte.com\",\n \"phone_numbers\": [\n \"+5511999999999\",\n \"+5511888888888\"\n ],\n \"born_at\": null,\n \"birthday\": \"1985-01-01\",\n \"gender\": null,\n \"date_created\": \"2017-08-14T23:28:36.296Z\",\n \"documents\": [\n {\n \"object\": \"document\",\n \"id\": \"doc_cj6csivuv05zj696dkzzjbfmq\",\n \"type\": \"cpf\",\n \"number\": \"11111111111\"\n }\n ],\n \"addresses\": [],\n \"phones\": []\n}" } }, "schema": { "type": "object", "properties": { "object": { "type": "string", "example": "customer" }, "id": { "type": "integer", "example": 233406, "default": 0 }, "external_id": { "type": "string", "example": "#123456789" }, "type": { "type": "string", "example": "individual" }, "country": { "type": "string", "example": "br" }, "document_number": {}, "document_type": { "type": "string", "example": "cpf" }, "name": { "type": "string", "example": "João das Neves" }, "email": { "type": "string", "example": "joaoneves@norte.com" }, "phone_numbers": { "type": "array", "items": { "type": "string", "example": "+5511999999999" } }, "born_at": {}, "birthday": { "type": "string", "example": "1985-01-01" }, "gender": {}, "date_created": { "type": "string", "example": "2017-08-14T23:28:36.296Z" }, "documents": { "type": "array", "items": { "type": "object", "properties": { "object": { "type": "string", "example": "document" }, "id": { "type": "string", "example": "doc_cj6csivuv05zj696dkzzjbfmq" }, "type": { "type": "string", "example": "cpf" }, "number": { "type": "string", "example": "11111111111" } } } }, "addresses": { "type": "array", "items": { "type": "object", "properties": {} } }, "phones": { "type": "array", "items": { "type": "object", "properties": {} } } } } } } } }, "deprecated": false, "x-readme": { "code-samples": [ { "language": "curl", "code": "curl -X POST https://api.pagar.me/1/customers -H 'content-type: application/json' -d '{\n \"api_key\": \"SUA_API_KEY\",\n \"external_id\": \"#123456789\",\n \"name\": \"João das Neves\",\n \"type\": \"individual\",\n \"country\": \"br\",\n \"email\": \"joaoneves@norte.com\",\n \"documents\": [\n {\n \"type\": \"cpf\",\n \"number\": \"11111111111\"\n }\n ],\n \"phone_numbers\": [\n \"+5511999999999\",\n \"+5511888888888\"\n ],\n \"birthday\": \"1985-01-01\"\n}'" }, { "language": "javascript", "code": "const pagarme = require('pagarme')\n\npagarme.client.connect({ api_key: 'SUA_API_KEY' })\n .then(client => client.customers.create({\n external_id: '#12345d789',\n name: 'João das Neves',\n type: 'individual',\n country: 'br',\n email: 'joaoneves@norte.com',\n documents: [\n {\n type: 'cpf',\n number: '11111111111'\n }\n ],\n phone_numbers: ['+5511999999999', '+5511888888888'],\n birthday: '1985-01-01'\n }))\n .then(customer => console.log(customer))", "name": "JS" }, { "language": "python", "code": "# coding: utf8\nimport pagarme\n\npagarme.authentication_key('SUA_API_KEY')\n\ncustomer_data = {\n 'external_id': '#123456789',\n 'name': 'João das Neves',\n 'type': 'individual',\n 'country': 'br',\n 'email': 'joaoneves@norte.com',\n 'documents': [\n {\n 'type': 'cpf',\n 'number': '11111111111'\n }\n ],\n 'phone_numbers': ['+5511999999999', '+5511888888888'],\n 'birthday': '1985-01-01'\n}\n\ncustomer = pagarme.customer.create(customer_data)\n\nprint(customer)" }, { "language": "java", "code": "import me.pagar.model.PagarMe;\n\nCustomer customer = new Customer();\ncustomer.setType(Customer.Type.INDIVIDUAL);\ncustomer.setExternalId(\"1001\");\ncustomer.setName(\"Phineas Flynn\");\ncustomer.setBirthday(\"1999-07-09\");" }, { "language": "csharp", "code": " var Customer = new Customer\n {\n\tExternalId = \"#3311\",\n\tName = \"Rick\",\n\tType = CustomerType.Individual,\n\tCountry = \"br\",\n\tEmail = \"rick@morty.com\",\n\tDocuments = new[]\n\t{\n\t\tnew Document{\n\t\t\t\tType = DocumentType.Cpf,\n\t\t\t\tNumber = \"11111111111\"\n\t\t},\n\t\tnew Document{\n\t\t\tType = DocumentType.Cnpj,\n\t\t\tNumber = \"83134932000154\"\n\t\t}\n\t},\n\tPhoneNumbers = new string[]\n\t{\n\t\t\"+5511982738291\",\n\t\t\"+5511829378291\"\n\t},\n\tBirthday = new DateTime(1991, 12, 12).ToString(\"yyyy-MM-dd\")\n};\nCustomer.Save();" }, { "language": "php", "code": "customers()->create([\n 'external_id' => '#123456789',\n 'name' => 'João das Neves',\n 'type' => 'individual',\n 'country' => 'br',\n 'email' => 'joaoneves@norte.com',\n 'documents' => [\n [\n 'type' => 'cpf',\n 'number' => '11111111111'\n ]\n ],\n 'phone_numbers' => [\n '+5511999999999',\n '+5511888888888'\n ],\n 'birthday' => '1985-01-01'\n]);" }, { "language": "ruby", "code": "require 'pagarme'\n\nPagarMe.api_key = \"SUA_API_KEY\"\n\ncustomer = PagarMe::Customer.create(\n name: 'Tommy Oliver',\n email: 'mopheus@nabucodonozor.com',\n type: 'individual',\n external_id: \"222\",\n country: 'br',\n birthday: \"1965-01-01\",\n documents: [\n {type: \"cpf\", number: \"86870624194\"}\n ],\n phone_numbers: [\"+5511999998888\", \"+5511888889999\"]\n)" } ], "samples-languages": [ "curl", "javascript", "python", "java", "csharp", "php", "ruby" ] } } } }, "x-readme": { "headers": [], "explorer-enabled": true, "proxy-enabled": true }, "x-readme-fauxas": true } ```