--- title: "Editar recebedor" url: "https://devcenter.stone.com.br/apis/v5-docs-legacy/versions/b9aaff36-6dcc-4353-8398-836d6c13dfa5/operations/editar-recebedor-1" --- > Full API specification: https://devcenter.stone.com.br/apis/v5-docs-legacy/versions/b9aaff36-6dcc-4353-8398-836d6c13dfa5.md # Editar recebedor `PUT` `/recipients/{recipient_id}` Operation ID: `editar-recebedor-1` Rota para editar um recebedor, definindo os dados do recebedor, transferência e qual a conta bancária que será utilizada para envio dos pagamentos. Para recebedores no contrato antigo, é possível alterar apenas os dados do recebedor (veja a opção "Contrato antigo" no corpo da requisição). ## Path parameters - `recipient_id` (string, required) - Código do recebedor ## Request body Content types: `application/json` ## Responses - `200` - 200 - `400` - 400 ## OpenAPI definition ```yaml openapi: 3.1.0 info: title: Pagar.me v5 API (Legado) version: 5.0.0 servers: - url: https://api.stone.com.br/core/v5 paths: /recipients/{recipient_id}: put: summary: Editar recebedor description: Rota para editar um recebedor, definindo os dados do recebedor, transferência e qual a conta bancária que será utilizada para envio dos pagamentos. Para recebedores no contrato antigo, é possível alterar apenas os dados do recebedor (veja a opção "Contrato antigo" no corpo da requisição). operationId: editar-recebedor-1 requestBody: content: application/json: schema: oneOf: - title: Editar recebedor type: object properties: register_information: type: object description: Dados cadastrais do recebedor. O objeto deve ser preenchido de acordo com o tipo do recebedor, Pessoa Física [PF] ou Pessoa Jurídica [PJ]. properties: email: type: string description: "[PF/PJ] E-mail do recebedor." document: type: string description: "[PF/PJ] Para recebedores Pessoa Física, utilizar 'individual' e para recebedores Pessoa Jurídica, utilizar 'corporation'." site_url: type: string description: "[PF/PJ] Site do recebedor. Observação: É necessário incluir o protocolo Http ou Https." phone_numbers: type: array description: "[PJ/PJ] Telefone do recebedor." items: properties: ddd: type: string description: DDD (Discagem Direta à Distância) number: type: string description: Número do telefone type: type: string description: Tipo do telefone required: - ddd - number type: object main_address: type: object required: - street - complementary - street_number - neighborhood - city - state - zip_code - reference_point properties: street: type: string description: Rua complementary: type: string description: Complemento street_number: type: string description: Número neighborhood: type: string description: Bairro city: type: string description: Cidade state: type: string description: Estado zip_code: type: string description: CEP. Para endereço brasileiro, deve conter uma numeração de 8 dígitos reference_point: type: string description: Ponto de referência do endereço metadata: type: string description: Objeto chave/valor utilizado para armazenar informações adicionais sobre o recebedor. - title: Contrato antigo type: object required: - type properties: email: type: string description: "E-mail do recebedor. Max: 64 caracteres" description: type: string description: Descrição do recebedor. Max:256 caracteres type: type: string description: "Tipo de recebedor. Valores possíveis: **individual** (pessoa física) ou **company** (pessoa jurídica)" metadata: type: object description: Objeto chave/valor utilizado para armazenar informações adicionais sobre o recebedor. properties: {} examples: Request Pessoa Jurídica: value: register_information: type: corporation document: "27123482000123" site_url: http://www.site.com company_name: Jorge e Isabel Publicidade e Propaganda Alterado trading_name: Jorge e Isabel Publicidade e Propaganda ME Alterado annual_revenue: "100000000" email: alterado@teste.com founding_date: 10/11/2010 cnae: 8599-6/03 managing_partners: - document: "26224451990" type: individual name: João da Silva Alterado birthdate: 10/02/1995 Alterado email: alterado@teste.com monthly_income: "30000" professional_occupation: Professor Alterado self_declared_legal_representative: true address: street: Av.Santos Lopes Alterada complementary: Apto. 104 Alterado street_number: 189 Alterado neighborhood: Centro Alterado city: Irecê Alterado state: BA Alterado zip_code: 44900000 Alterado reference_point: Em frente ao clube de tiro 1910 Alterado phone_numbers: - ddd: "75" number: "98999999" type: celular - ddd: "75" number: "98777777" type: celular main_address: street: Av.Santos Lopes Alterado complementary: Apto. 104 Alterado street_number: 189 Alterado neighborhood: Centro Alterado city: Irecê Alterado state: BA Alterado zip_code: 44900000 Alterado reference_point: Em frente ao clube de tiro 1910 Alterado phone_numbers: - ddd: "75" number: "97999991" type: celular metadata: meta_key: meta_value Request Pessoa Física: value: register_information: email: change@avengers.com document: "26224451990" type: individual site_url: http://www.site.com phone_numbers: - ddd: "85" number: "987655433" type: celular name: Antonio da Silva e Santos mother_name: Maria da Silva Santos birthdate: 02/02/1990 monthly_income: "30000" professional_occupation: Padeiro address: street: Rua Alberto Pereira complementary: Apto. 348 street_number: "115" neighborhood: Gomes Souza city: Campina Grande state: PB zip_code: "44900012" reference_point: Em frente a UFPB Contrato antigo: value: email: tstark@avengers.com description: Recebedor Tony Stark type: individual metadata: key: value responses: "200": description: "200" content: application/json: examples: Result: value: |- { "id": "rp_P6b2aBqtPsbwG7xw", "name": "Tony Stark", "email": "tstark@pagar.me", "document": "26224451990", "description": "Recebedor tony stark", "type": "individual", "status": "active", "created_at": "2017-08-03T20:29:28Z", "updated_at": "2017-08-03T20:29:28Z", "transfer_settings": { "transfer_enabled": false, "transfer_interval": "Daily", "transfer_day": 0 }, "default_bank_account": { "id": "ba_Ez2lE71FBUPa3XZK", "holder_name": "Tony Stark", "holder_type": "individual", "holder_document": "26224451990", "bank": "341", "branch_number": "1234", "branch_check_digit": "6", "account_number": "12345", "account_check_digit": "6", "type": "checking", "status": "active", "created_at": "2017-08-03T20:29:28Z", "updated_at": "2017-08-03T20:29:28Z", "metadata": { "key": "value" } }, "gateway_recipients": [ { "gateway": "pagarme", "status": "active", "pgid": "re_cj5aaa5i000cdhj6ernz14j1i", "createdAt": "2017-08-03T20:29:28Z", "updatedAt": "2017-08-03T20:29:28Z" } ], "metadata": { "key": "value" } } schema: type: object properties: id: type: string example: rp_P6b2aBqtPsbwG7xw name: type: string example: Tony Stark email: type: string example: tstark@pagar.me document: type: string example: "26224451990" description: type: string example: Recebedor tony stark type: type: string example: individual status: type: string example: active created_at: type: string example: 2017-08-03T20:29:28Z updated_at: type: string example: 2017-08-03T20:29:28Z transfer_settings: type: object properties: transfer_enabled: type: boolean example: false default: true transfer_interval: type: string example: Daily transfer_day: type: integer example: 0 default: 0 default_bank_account: type: object properties: id: type: string example: ba_Ez2lE71FBUPa3XZK holder_name: type: string example: Tony Stark holder_type: type: string example: individual holder_document: type: string example: "26224451990" bank: type: string example: "341" branch_number: type: string example: "1234" branch_check_digit: type: string example: "6" account_number: type: string example: "12345" account_check_digit: type: string example: "6" type: type: string example: checking status: type: string example: active created_at: type: string example: 2017-08-03T20:29:28Z updated_at: type: string example: 2017-08-03T20:29:28Z metadata: type: object properties: key: type: string example: value gateway_recipients: type: array items: type: object properties: gateway: type: string example: pagarme status: type: string example: active pgid: type: string example: re_cj5aaa5i000cdhj6ernz14j1i createdAt: type: string example: 2017-08-03T20:29:28Z updatedAt: type: string example: 2017-08-03T20:29:28Z metadata: type: object properties: key: type: string example: value "400": description: "400" content: application/json: examples: Result: value: "{}" schema: type: object properties: {} deprecated: false parameters: - name: recipient_id in: path description: Código do recebedor schema: type: string required: true security: - sec0: [] components: securitySchemes: sec0: type: http scheme: basic ```