--- title: "Obter recebedor" url: "https://devcenter.stone.com.br/apis/v5-docs-legacy/versions/b9aaff36-6dcc-4353-8398-836d6c13dfa5/operations/obter-recebedor-1" --- > Full API specification: https://devcenter.stone.com.br/apis/v5-docs-legacy/versions/b9aaff36-6dcc-4353-8398-836d6c13dfa5.md # Obter recebedor `GET` `/recipients/{recipient_id}` Operation ID: `obter-recebedor-1` Retorna um objeto com os dados de um recebedor específico. ## Path parameters - `recipient_id` (string, required) - Código do recebedor. ## 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}: get: summary: Obter recebedor description: Retorna um objeto com os dados de um recebedor específico. operationId: obter-recebedor-1 parameters: - name: recipient_id in: path description: Código do recebedor. schema: type: string required: true responses: "200": description: "200" content: application/json: examples: Contrato antigo: 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": "12345", "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" } } Contrato novo - PF: value: >- { "id": "re_clt7l11wu03cl019tj3frja7x", "name": "Antonio da Silva", "email": "tstark@avengers.com", "code": "2c0b5b0b-7be5-4a29-b26d-12dd7ed71311", "document": "26224451990", "type": "individual", "payment_mode": "bank_transfer", "status": "active", "created_at": "2024-02-29T18:51:57Z", "updated_at": "2024-02-29T18:51:57Z", "transfer_settings": { "transfer_enabled": true, "transfer_interval": "Weekly", "transfer_day": 1 }, "default_bank_account": { "id": "ba_dO5X325CBHr3QYe9", "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": "2024-02-29T18:51:57Z", "updated_at": "2024-02-29T18:51:57Z", "metadata": { "key": "value" } }, "gateway_recipients": [ { "gateway": "pagarme", "status": "active", "pgid": "re_clt7l11wu03cl019tj3frja7x", "createdAt": "2024-02-29T18:51:58Z", "updatedAt": "2024-02-29T18:51:58Z" } ], "automatic_anticipation_settings": { "enabled": false, "type": "full", "volume_percentage": 0, "delay": 365 }, "metadata": { "key": "value" }, "register_information": { "email": "tstark@avengers.com", "document": "26224451990", "type": "individual", "site_url": "http://www.site.com", "phone_numbers": [ { "ddd": "77", "number": "987655432", "type": "mobile" } ], "name": "Antonio da Silva", "mother_name": "Maria da Silva", "birthdate": "02/10/1990", "monthly_income": "300000", "professional_occupation": "Professor", "address": { "street": "Rua Alberto Carvalho", "complementary": "Apto. 345", "street_number": "111", "neighborhood": "Gomes Pereira", "city": "Porto Seguro", "state": "BA", "zip_code": "44900000", "reference_point": "Próximo ao Posto Quatro Rodas" } } } Contrato novo - PJ: value: >- { "id": "re_clt7md7ej03th019tm0n4c1ct", "name": "Jorge e Isabel Publicidade e Propaganda", "email": "teste@teste.com", "code": "2c0b5b0b-7be5-4a29-b26d-12dd7ed713e0", "document": "27123482000123", "type": "company", "payment_mode": "bank_transfer", "status": "active", "created_at": "2024-02-29T19:29:24Z", "updated_at": "2024-02-29T19:29:24Z", "transfer_settings": { "transfer_enabled": true, "transfer_interval": "Weekly", "transfer_day": 1 }, "default_bank_account": { "id": "ba_301y9evH6NIgy6rl", "holder_name": "Tony Stark", "holder_type": "individual", "holder_document": "27123482000123", "bank": "341", "branch_number": "1234", "branch_check_digit": "6", "account_number": "12345", "account_check_digit": "6", "type": "checking", "status": "active", "created_at": "2024-02-29T19:29:24Z", "updated_at": "2024-02-29T19:29:24Z", "metadata": { "key": "value" } }, "gateway_recipients": [ { "gateway": "pagarme", "status": "active", "pgid": "re_clt7md7ej03th019tm0n4c1ct", "createdAt": "2024-02-29T19:29:24Z", "updatedAt": "2024-02-29T19:29:24Z" } ], "automatic_anticipation_settings": { "enabled": false, "type": "full", "volume_percentage": 0, "delay": 365 }, "metadata": { "key": "value" }, "register_information": { "email": "teste@teste.com", "document": "27123482000123", "type": "corporation", "site_url": "http://www.site.com", "phone_numbers": [ { "ddd": "71", "number": "99999999", "type": "mobile" } ], "company_name": "Jorge e Isabel Publicidade e Propaganda", "trading_name": "Jorge e Isabel Publicidade e Propaganda ME", "annual_revenue": "100000000", "founding_date": "10/10/2010", "cnae": "4651-6/01", "main_address": { "street": "Av.Santos Lopes", "complementary": "Apto. 104", "street_number": "189", "neighborhood": "Centro", "city": "Irecê", "state": "BA", "zip_code": "44900000", "reference_point": "Em frente ao clube de tiro 1910" }, "managing_partners": [ { "name": "João da Silva", "email": "teste@teste.com", "document": "26224451990", "type": "individual", "birthdate": "10/02/1995", "monthly_income": "300000", "professional_occupation": "Professor", "self_declared_representative": true, "address": { "street": "Av.Santos Lopes", "complementary": "Apto. 104", "street_number": "189", "neighborhood": "Centro", "city": "Irecê", "state": "BA", "zip_code": "44900000", "reference_point": "Em frente ao clube de tiro 1910" }, "phone_numbers": [ { "ddd": "71", "number": "99999999", "type": "mobile" }, { "ddd": "71", "number": "97777777", "type": "mobile" } ] } ] } } schema: oneOf: - title: Contrato antigo 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: "12345" 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 - title: Contrato novo - PF type: object properties: id: type: string example: re_clt7l11wu03cl019tj3frja7x name: type: string example: Antonio da Silva email: type: string example: tstark@avengers.com code: type: string example: 2c0b5b0b-7be5-4a29-b26d-12dd7ed71311 document: type: string example: "26224451990" type: type: string example: individual payment_mode: type: string example: bank_transfer status: type: string example: active created_at: type: string example: 2024-02-29T18:51:57Z updated_at: type: string example: 2024-02-29T18:51:57Z transfer_settings: type: object properties: transfer_enabled: type: boolean example: true default: true transfer_interval: type: string example: Weekly transfer_day: type: integer example: 1 default: 0 default_bank_account: type: object properties: id: type: string example: ba_dO5X325CBHr3QYe9 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: 2024-02-29T18:51:57Z updated_at: type: string example: 2024-02-29T18:51:57Z 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_clt7l11wu03cl019tj3frja7x createdAt: type: string example: 2024-02-29T18:51:58Z updatedAt: type: string example: 2024-02-29T18:51:58Z automatic_anticipation_settings: type: object properties: enabled: type: boolean example: false default: true type: type: string example: full volume_percentage: type: integer example: 0 default: 0 delay: type: integer example: 365 default: 0 metadata: type: object properties: key: type: string example: value register_information: type: object properties: email: type: string example: tstark@avengers.com document: type: string example: "26224451990" type: type: string example: individual site_url: type: string example: http://www.site.com phone_numbers: type: array items: type: object properties: ddd: type: string example: "77" number: type: string example: "987655432" type: type: string example: mobile name: type: string example: Antonio da Silva mother_name: type: string example: Maria da Silva birthdate: type: string example: 02/10/1990 monthly_income: type: string example: "300000" professional_occupation: type: string example: Professor address: type: object properties: street: type: string example: Rua Alberto Carvalho complementary: type: string example: Apto. 345 street_number: type: string example: "111" neighborhood: type: string example: Gomes Pereira city: type: string example: Porto Seguro state: type: string example: BA zip_code: type: string example: "44900000" reference_point: type: string example: Próximo ao Posto Quatro Rodas - title: Contrato novo - PJ type: object properties: id: type: string example: re_clt7md7ej03th019tm0n4c1ct name: type: string example: Jorge e Isabel Publicidade e Propaganda email: type: string example: teste@teste.com code: type: string example: 2c0b5b0b-7be5-4a29-b26d-12dd7ed713e0 document: type: string example: "27123482000123" type: type: string example: company payment_mode: type: string example: bank_transfer status: type: string example: active created_at: type: string example: 2024-02-29T19:29:24Z updated_at: type: string example: 2024-02-29T19:29:24Z transfer_settings: type: object properties: transfer_enabled: type: boolean example: true default: true transfer_interval: type: string example: Weekly transfer_day: type: integer example: 1 default: 0 default_bank_account: type: object properties: id: type: string example: ba_301y9evH6NIgy6rl holder_name: type: string example: Tony Stark holder_type: type: string example: individual holder_document: type: string example: "27123482000123" 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: 2024-02-29T19:29:24Z updated_at: type: string example: 2024-02-29T19:29:24Z 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_clt7md7ej03th019tm0n4c1ct createdAt: type: string example: 2024-02-29T19:29:24Z updatedAt: type: string example: 2024-02-29T19:29:24Z automatic_anticipation_settings: type: object properties: enabled: type: boolean example: false default: true type: type: string example: full volume_percentage: type: integer example: 0 default: 0 delay: type: integer example: 365 default: 0 metadata: type: object properties: key: type: string example: value register_information: type: object properties: email: type: string example: teste@teste.com document: type: string example: "27123482000123" type: type: string example: corporation site_url: type: string example: http://www.site.com phone_numbers: type: array items: type: object properties: ddd: type: string example: "71" number: type: string example: "99999999" type: type: string example: mobile company_name: type: string example: Jorge e Isabel Publicidade e Propaganda trading_name: type: string example: Jorge e Isabel Publicidade e Propaganda ME annual_revenue: type: string example: "100000000" founding_date: type: string example: 10/10/2010 cnae: type: string example: 4651-6/01 main_address: type: object properties: street: type: string example: Av.Santos Lopes complementary: type: string example: Apto. 104 street_number: type: string example: "189" neighborhood: type: string example: Centro city: type: string example: Irecê state: type: string example: BA zip_code: type: string example: "44900000" reference_point: type: string example: Em frente ao clube de tiro 1910 managing_partners: type: array items: type: object properties: name: type: string example: João da Silva email: type: string example: teste@teste.com document: type: string example: "26224451990" type: type: string example: individual birthdate: type: string example: 10/02/1995 monthly_income: type: string example: "300000" professional_occupation: type: string example: Professor self_declared_representative: type: boolean example: true default: true address: type: object properties: street: type: string example: Av.Santos Lopes complementary: type: string example: Apto. 104 street_number: type: string example: "189" neighborhood: type: string example: Centro city: type: string example: Irecê state: type: string example: BA zip_code: type: string example: "44900000" reference_point: type: string example: Em frente ao clube de tiro 1910 phone_numbers: type: array items: type: object properties: ddd: type: string example: "71" number: type: string example: "99999999" type: type: string example: mobile "400": description: "400" content: application/json: examples: Result: value: "{}" schema: type: object properties: {} deprecated: false security: - sec0: [] components: securitySchemes: sec0: type: http scheme: basic ```