Pagar.me v5 · Docs Legacy
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
Response
application/json
200
dataarray[object]
Show Child Parameters
pagingobject
Show Child Parameters
get/recipients
Authentication
Query Parameters
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
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
Authentication
Path Parameters
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
Body
application/json
One Ofregister_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
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}
Authentication
Path Parameters
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
Obter recebedor
Retorna um objeto com os dados de um recebedor específico.
get
https://api.stone.com.br/core/v5/recipients/{recipient_id}
Path Parameters
recipient_idstringrequired
Código do recebedor.
Response
application/json
Response
application/json
200
One Ofidstring
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
get/recipients/{recipient_id}
Authentication
Path Parameters
application/json
Editar code de recebedor
patch
https://api.stone.com.br/core/v5/recipients/{recipient_id}/code
Path Parameters
recipient_idstringrequired
Identificador do recebedor
Body
application/json
Body
application/json
Codestringrequired
Referencia externa única por recebedor
Response
application/json
Response
application/json
200
idstring
Example:rp_23452cBK6lP
namestring
Example:Tony Stark
emailstring
Example:tstark@avengers.com
documentstring
Example:223451990
descriptionstring
Example:Recebedor Tony Stark
typestring
Example:individual
statusstring
Example:active
created_atstring
Example:2018-05-23T16:17:39Z
updated_atstring
Example:2018-05-23T16:17:39Z
codestring
Example:123
transfer_settingsobject
Show Child Parameters
default_bank_accountobject
Show Child Parameters
automatic_anticipation_settingsobject
Show Child Parameters
gateway_recipientsarray[object]
Show Child Parameters
metadataobject
Show Child Parameters
patch/recipients/{recipient_id}/code
Authentication
Path Parameters
Body
{
"code": "123"
}
application/json