Pagar.me v5 · Docs Legacy

Pagar.me v5 API (Legado)

Criar recebedor contrato antigo

Rota para criar um recebedor, definindo os dados do recebedor, transferência e qual a conta bancária que será utilizada para envio dos pagamentos.

post
https://api.stone.com.br/core/v5/recipients1

Body

application/json
namestringrequired

Nome do recebedor. Max:128 caracteres

emailstring

E-mail do recebedor. Max: 64 caracteres

descriptionstring

Descrição do recebedor. Max:256 caracteres

documentstringrequired

CPF ou CNPJ do recebedor. Max: 16 caracteres

typestringrequired

Tipo de recebedor. Valores possíveis: individual (pessoa física) ou company (pessoa jurídica)

codestring

Referencia externa única por recebedor

default_bank_accountobject

Dados da conta bancária do recebedor.

Show Child Parameters
transfer_settingsobject

Informações de transferência do recebedor

Show Child Parameters
automatic_anticipation_settingsobject

Informações de antecipação automática do recebedor

Show Child Parameters
metadatastring

Objeto chave/valor utilizado para armazenar informações adicionais sobre o recebedor.

Response

application/json

200

idstring

Example:rp_P6b2aBqtPsbwG7xw

namestring

Example:Tony Stark

emailstring

Example:tstark@avengers.com

documentstring

Example:26224451990

descriptionstring

Example:Recebedor tony stark

typestring

Example:individual

statusstring

Example:active

created_atstring

Example:2017-08-03T20:29:28Z

updated_atstring

Example:2017-08-03T20:29:28Z

transfer_settingsobject
Show Child Parameters
default_bank_accountobject
Show Child Parameters
gateway_recipientsarray[object]
Show Child Parameters
automatic_anticipation_settingsobject
Show Child Parameters
metadataobject
Show Child Parameters
post/recipients1

Body

{ "name": "Teste campos", "email": "tstark@avengers.com", "description": "Recebedor tony stark", "document": "26224451990", "type": "individual", "default_bank_account": { "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", "metadata": { "key": "value" } }, "transfer_settings": { "transfer_enabled": false, "transfer_interval": "Daily", "transfer_day": 0 }, "automatic_anticipation_settings": { "enabled": true, "type": "full", "volume_percentage": "50", "delay": null }, "metadata": { "key": "value" } }
 
application/json

Criar recebedor

Rota para criar um recebedor, definindo os dados do recebedor, transferência e qual a conta bancária que será utilizada para envio dos pagamentos.

post
https://api.stone.com.br/core/v5/recipients

Body

application/json
codestring

Referencia externa única por recebedor

register_informationobjectrequired

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].

Show Child Parameters
default_bank_accountobjectrequired

Dados da conta bancária do recebedor.

Show Child Parameters
transfer_settingsobject

Informações de transferência do recebedor

Show Child Parameters
automatic_anticipation_settingsobject

Informações de antecipação automática do recebedor

Show Child Parameters
metadatastring

Objeto chave/valor utilizado para armazenar informações adicionais sobre o recebedor.

Response

application/json

200

idstring

Example:re_clxnqkxk709sc019taqhmj4kf

namestring

Example:Antonio da Silva

emailstring

Example:tstark@avengers.com

codestring

Example:21875b51-d4c3-46d3-aeee-d8b3112aab55

documentstring

Example:26224451990

typestring

Example:individual

payment_modestring

Example:bank_transfer

statusstring

Example:active

created_atstring

Example:2024-06-20T20:50:31Z

updated_atstring

Example:2024-06-20T20:50:31Z

transfer_settingsobject
Show Child Parameters
default_bank_accountobject
Show Child Parameters
gateway_recipientsarray[object]
Show Child Parameters
automatic_anticipation_settingsobject
Show Child Parameters
metadataobject
Show Child Parameters
register_informationobject
Show Child Parameters
post/recipients

Body

{ "code": "1234", "register_information": { "company_name": "Recebedor pessoa juridica", "trading_name": "Empresa LTDA", "email": "empresax@avengers.com", "document": "77699131000133", "type": "corporation", "site_url": "http://www.site.com", "annual_revenue": 1000000, "corporation_type": "LTDA", "founding_date": "2010-10-30", "main_address": { "street": "Av. General Justo", "complementary": "Bloco A", "street_number": "375", "neighborhood": "Centro", "city": "Rio de Janeiro", "state": "RJ", "zip_code": "20021130", "reference_point": "Ao lado da banca de jornal" }, "phone_numbers": [ { "ddd": "21", "number": "994647568", "type": "mobile" } ], "managing_partners": [ { "name": "Tony Stark", "email": "tstark@avengers.com", "document": "26224451990", "type": "individual", "mother_name": "Nome da mae", "birthdate": "12/10/1995", "monthly_income": 120000, "professional_occupation": "Vendedor", "self_declared_legal_representative": true, "address": { "street": "Av. General Justo", "complementary": "Bloco A", "street_number": "375", "neighborhood": "Centro", "city": "Rio de Janeiro", "state": "RJ", "zip_code": "20021130", "reference_point": "Ao lado da banca de jornal" }, "phone_numbers": [ { "ddd": "27", "number": "999992628", "type": "mobile" } ] } ] }, "transfer_settings": { "transfer_enabled": "false", "transfer_interval": "Daily", "transfer_day": 0 }, "default_bank_account": { "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" }, "automatic_anticipation_settings": { "enabled": "true", "type": "full", "volume_percentage": "50", "delay": "null" } }
 
application/json

Listar recebedores

Retorna uma lista de objetos com os dados dos recebedor encontrados.

get
https://api.stone.com.br/core/v5/recipients

Query Parameters

pageinteger(int32)

Página atual.

Default:1

sizeinteger(int32)

Quantidade de itens por página.

Default:10

Response

application/json

200

dataarray[object]
Show Child Parameters
pagingobject
Show Child Parameters
get/recipients
 
application/json

Criar link de de Prova de Vida (KYC)

Rota para gerar o QR Code de acesso ao webapp.

post
https://api.stone.com.br/core/v5/recipients/{recipient_id}/kyc_link

Path Parameters

recipient_idstringrequired

Código do recebedor.

Response

application/json

200

urlstring

Example:www.pagar.me/kyc/14214214215...

base64_qrcodestring

Example:PD56bWwgdVyc2lvb...pIi8+PC9zdmc+

expires_atstring

Example:2025-05-10T17:17:26Z

post/recipients/{recipient_id}/kyc_link
 
application/json

Editar recebedor

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).

put
https://api.stone.com.br/core/v5/recipients/{recipient_id}

Path Parameters

recipient_idstringrequired

Código do recebedor

Body

application/json
One Of
register_informationobject

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].

Show Child Parameters
metadatastring

Objeto chave/valor utilizado para armazenar informações adicionais sobre o recebedor.

Response

application/json

200

idstring

Example:rp_P6b2aBqtPsbwG7xw

namestring

Example:Tony Stark

emailstring

Example:tstark@pagar.me

documentstring

Example:26224451990

descriptionstring

Example:Recebedor tony stark

typestring

Example:individual

statusstring

Example:active

created_atstring

Example:2017-08-03T20:29:28Z

updated_atstring

Example:2017-08-03T20:29:28Z

transfer_settingsobject
Show Child Parameters
default_bank_accountobject
Show Child Parameters
gateway_recipientsarray[object]
Show Child Parameters
metadataobject
Show Child Parameters
put/recipients/{recipient_id}

Body

{ "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" } }
 
application/json