--- updatedAt: 2026-04-06T17:33:28.000Z agentTools: projectIndex: https://docs.pagar.me/v4/llms.txt --- # Criando um recebedor Com essa rota você consegue criar um recebedor, definindo o período que ele irá receber os pagamentos e qual a conta bancária que será utilizada para envio dos pagamentos. > ❗️ 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. > ❗️ Recebedores inativos > > Todos os recebedores que foram criados a mais de 60 dias, não possuem valores a receber e nos últimos 60 dias não transacionaram ou realizaram transferências terão a transferência automática desabilitada. Mesmo que esse recebedor volte a transacionar eventualmente, a transferência automática precisa ser reabilitada manualmente nesses casos. > 🚧 Rate Limit > > Essa rota possui um limite de requisições.\ > Caso você ultrapasse esse valor será retornado o erro “**StatusCode 429**” por nossa API. > > Para saber qual o limite dessa e demais rotas acesse : [Rate Limit](https://docs.pagar.me/docs/rate-limit) # 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": { "/recipients": { "post": { "summary": "Criando um recebedor", "description": "Com essa rota você consegue criar um recebedor, definindo o período que ele irá receber os pagamentos e qual a conta bancária que será utilizada para envio dos pagamentos.", "operationId": "criando-um-recebedor", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "transfer_interval", "transfer_day", "transfer_enabled", "bank_account_id", "register_information" ], "properties": { "external_id": { "type": "string", "description": "Identificador externo do recebedor" }, "transfer_interval": { "type": "string", "description": "Frequência na qual o recebedor irá ser pago. Valores possíveis: `daily`, `weekly`, `monthly`" }, "transfer_day": { "type": "string", "description": "Dia no qual o recebedor vai ser pago. Depende do transfer_interval. Se for daily, não é necessário. Se for weekly pode ser de 1 (segunda) a 5 (sexta). Se for monthly, pode ser de 1 a 31." }, "transfer_enabled": { "type": "boolean", "description": "Variável que indica se o recebedor pode receber os pagamentos automaticamente" }, "bank_account_id": { "type": "string", "description": "Identificador de uma conta bancária previamente criada. Você também pode passar todos parâmetros necessários para criação de uma conta bancária." }, "postback_url": { "type": "string", "description": "URL (endpoint) de seu sistema que recebe notificações a cada mudança no status do recebedor." }, "bank_account": { "type": "object", "required": [ "bank_code", "agencia", "conta", "conta_dv", "document_number", "legal_name" ], "properties": { "bank_code": { "type": "string", "description": "Código do banco da conta" }, "agencia": { "type": "string", "description": "Agencia do banco da conta" }, "agencia_dv": { "type": "string", "description": "Apenas números, deve conter somente 1 dígito" }, "conta": { "type": "string", "description": "Número da conta" }, "type": { "type": "string", "description": "Tipo da conta. Pode ser: `conta_corrente`, `conta_poupanca`, `conta_corrente_conjunta`, `conta_poupanca_conjunta`" }, "conta_dv": { "type": "string", "description": "Dígito verificador da conta" }, "document_number": { "type": "string", "description": "CPF/CNPJ atrelado à conta" }, "legal_name": { "type": "string", "description": "Nome/Razão social do dono da conta" } } }, "anticipatable_volume_percentage": { "type": "string", "description": "Porcentagem do valor passível de antecipação para este recebedor." }, "automatic_anticipation_enabled": { "type": "string", "description": "Se o recebedor está habilitado para receber automaticamente ou não o valor disponível para antecipação." }, "automatic_anticipation_type": { "type": "string", "description": "Configuração de como devemos criar as antecipações automáticas do recebedor. Valor **full** para criarmos antecipações seguindo a regra de volume máximo antecipável. Valor **1025**, para criarmos antecipações de vendas inteiras, modelos D+X e 10/25." }, "automatic_anticipation_days": { "type": "string", "description": "Lista de dias em que devemos criar as antecipações automáticas." }, "automatic_anticipation_1025_delay": { "type": "string", "description": "Parâmetro de quantos dias, contados do dia da antecipação para trás, devemos desconsiderar na criação desta antecipação." }, "register_information": { "type": "string", "description": "Campo usado para receber informações cadastrais de um recebedor. Este recebedor pode ser pessoal física ou pessoa jurídica, onde cada um tem formato especifico.", "format": "json" }, "metadata": { "type": "string", "description": "Objeto com dados adicionais do recebedor.", "format": "json" } } } } } }, "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"object\": \"recipient\",\n \"id\": \"re_cix7pnghi02wm196emgbthh8u\",\n \"transfer_enabled\": true,\n \"last_transfer\": null,\n \"transfer_interval\": \"weekly\",\n \"transfer_day\": 5,\n \"automatic_anticipation_enabled\": true,\n \"anticipatable_volume_percentage\": 85,\n \"date_created\": \"2016-12-27T16:11:58.911Z\",\n \"date_updated\": \"2016-12-27T16:11:58.911Z\",\n \"postback_url\": \"https://requestb.in/tl0092tl\",\n \"status\": \"active\",\n \"status_reason\": null,\n \"metadata\": null,\n \"bank_account\": {\n \"object\": \"bank_account\",\n \"id\": 17345188,\n \"bank_code\": \"33\",\n \"agencia\": \"00000\",\n \"agencia_dv\": null,\n \"conta\": \"00000\",\n \"conta_dv\": \"0\",\n \"type\": \"conta_corrente\",\n \"document_type\": \"cpf\",\n \"document_number\": \"35965816804\",\n \"legal_name\": \"Nome much legal\",\n \"charge_transfer_fees\": true,\n \"date_created\": \"2016-12-27T16:08:26.202Z\"\n },\n \"mcc\": \"5812\",\n\"register_information\": {\n \"type\": \"corporation\",\n \"document_number\": \"43633675456\",\n \"company_name\": \"Full Name Company\",\n \"trading_name\": \"Full Name Company SA\",\n \"annual_revenue\": \"1000\",\n \"corporation_type\": \"\",\n \"founding_date\": \"\",\n \"cnae\": \"\",\n \"email\": \"some@email.com\",\n \"site_url\":\"http://www.site.com\",\n \"phone_numbers\": [{\n \"ddd\": \"11\",\n \"number\": \"11987654321\",\n \"type\": \"mobile\"\n }],\n \"main_address\": {\n \"street\": null,\n \"complementary\": \"SN\",\n \"street_number\": null,\n \"neighborhood\": null,\n \"city\": null,\n \"state\": null,\n \"zipcode\": null,\n \"reference_point\": null\n },\n \"managing_partners\": [{\n \"type\": \"individual\",\n \"name\": \"Teste Onboarding\",\n \"document_number\": \"50107915014\",\n \"mother_name\": \"Eliana das Neves\",\n \"birthdate\": \"01/01/0001\",\n \"email\": \"some@email.com\",\n \"monthly_income\": \"1000\",\n \t\t\"professional_occupation\": \"Empresário\",\n \"self_declared_legal_representative\": true,\n\t \"address\": {\n \"street\": null,\n \"complementary\": \"SN\",\n \"street_number\": null,\n \"neighborhood\": null,\n \"city\": null,\n \"state\": null,\n \"zipcode\": null,\n \"reference_point\": null\n },\n\t \"phone_numbers\": [\n {\n \"ddd\": \"27\",\n \"number\": \"999992628\",\n \"type\": \"primary\"\n }\n ]\n }\n}" } } } } } }, "deprecated": false, "x-readme": { "code-samples": [ { "language": "ruby", "code": "require 'pagarme'\n\nPagarMe.api_key = 'SUA_API_KEY'\n\nrecipient = PagarMe::Recipient.new({\n :anticipatable_volume_percentage => 85, \n :automatic_anticipation_enabled => true, \n :bank_account_id => \"17490076\", \n :transfer_day => \"5\", \n :transfer_enabled => true, \n :transfer_interval => \"weekly\"\n}).create" }, { "language": "php", "code": "recipients()->create([\n 'anticipatable_volume_percentage' => '85', \n 'automatic_anticipation_enabled' => 'true', \n 'bank_account_id' => '17899179', \n 'transfer_day' => '5', \n 'transfer_enabled' => 'true', \n 'transfer_interval' => 'weekly'\n]);" }, { "language": "csharp", "code": "PagarMeService.DefaultApiKey = \"SUA_API_KEY\";\n\nRecipient recipient = new Recipient();\nrecipient.TransferInterval = TransferInterval.Weekly;\nrecipient.TransferDay = 5;\nrecipient.TransferEnabled = true;\nrecipient.BankAccount = PagarMeService.GetDefaultService().BankAccounts.Find(\"4840\");\nrecipient.Save();\n" }, { "language": "javascript", "code": "const pagarme = require('pagarme')\n\npagarme.client.connect({ api_key: 'SUA_API_KEY' })\n .then(client => client.recipients.create({\n bank_account_id: 'bank_account_id',\n transfer_interval: 'weekly',\n transfer_day: 5,\n transfer_enabled: true\n }))\n .then(recipient => console.log(recipient))", "name": "JS" }, { "language": "java", "code": "import me.pagar.model.PagarMe;\nimport me.pagar.model.Recipient;\nimport me.pagar.model.Recipient.TransferInterval;\n\nPagarMe.init(\"SUA_API_KEY\");\nRecipient recipient = new Recipient();\nrecipient.setAnticipatableVolumePercentage(85);\nrecipient.setAutomaticAnticipationEnabled(true);\nrecipient.setBankAccountId(17490076);\nrecipient.setTransferDay(5);\nrecipient.setTransferEnabled(true);\nrecipient.setTransferInterval(TransferInterval.WEEKLY);\nrecipient.save();" }, { "language": "python", "code": "import pagarme\n\npagarme.authentication_key('SUA_API_KEY')\n\nparams = {\n 'anticipatable_volume_percentage': '80',\n 'automatic_anticipation_enabled': 'true',\n 'transfer_day': '5',\n 'transfer_enabled': 'true',\n 'transfer_interval': 'weekly',\n 'bank_account':{\n 'agencia': '0932',\n 'agencia_dv': '5',\n 'bank_code': '341',\n 'conta': '58054',\n 'conta_dv': '1',\n 'document_number': '26268738888',\n 'legal_name': 'HOUSE TARGARYEN'\n }\n}\n\nrecipient = pagarme.recipient.create(params)\n\nprint(recipient)" } ], "samples-languages": [ "ruby", "php", "csharp", "javascript", "java", "python" ] } } } }, "x-readme": { "headers": [], "explorer-enabled": true, "proxy-enabled": true }, "x-readme-fauxas": true } ```