Pagar.me v5 · Docs Legacy
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
Atualizar conta bancária do recebedor
patch
https://api.stone.com.br/core/v5/recipients/{recipient_id}/default-bank-account
Path Parameters
recipient_idstringrequired
Código do recebedor
Body
application/json
Body
application/json
bank_accountobjectrequired
Dados da conta bancária
Show Child Parameters
Response
application/json
Response
application/json
200
idstring
Example:rp_Gxb5NJNiqvf0Y5Xv
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-10-27T16:12:37Z
updated_atstring
Example:2017-10-27T16:12:37Z
default_bank_accountobject
Show Child Parameters
gateway_recipientsarray[object]
Show Child Parameters
metadataobject
Show Child Parameters
patch/recipients/{recipient_id}/default-bank-account
Authentication
Path Parameters
Body
{
"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": {
"meta_key": "meta_value"
}
}
}
application/json
Obter saldo
get
https://api.stone.com.br/core/v5/recipients/{recipient_id}/balance
Path Parameters
recipient_idstringrequired
Identificador do recebedor
Response
application/json
Response
application/json
200
currencystring
Example:BRL
available_amountinteger
Default:0
waiting_funds_amountinteger
Default:0
transferred_amountinteger
Default:0
recipientobject
Show Child Parameters
get/recipients/{recipient_id}/balance
Authentication
Path Parameters
application/json
Cria saque
Rota para realizar o saque para uma conta bancária de um recebedor.
post
https://api.stone.com.br/core/v5/recipients/{recipient_id}/withdrawals
Path Parameters
recipient_idstringrequired
Código do recebedor
Body
application/json
Body
application/json
amountinteger(int32)
Valor da cobrança em centavos
Response
application/json
Response
application/json
200
idstring
Example:with_LJ0OkmVcJCVPj4Yp
amountinteger
Default:0
Example:100
statusstring
Example:failed
created_atstring
Example:2020-01-16T16:36:39Z
updated_atstring
Example:2020-01-16T16:36:39Z
bank_accountobject
Show Child Parameters
post/recipients/{recipient_id}/withdrawals
Authentication
Path Parameters
Body
{
"amount": 100
}
application/json