Pagar.me v5 · Docs Legacy
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
Listar saques
Rota para realizar a consulta de saques para um determinado recebedor.
get
https://api.stone.com.br/core/v5/recipients/{recipient_id}/withdrawals
Query Parameters
statusstring
Filtro para o status da transferência
created_sincestring(date)
Filtro para início do range da data de criação da transferência
created_untilstring(date)
Filtro para o fim do range da data de criação da transferência
Path Parameters
recipient_idstringrequired
Código do recebedor
Response
application/json
Response
application/json
200
get/recipients/{recipient_id}/withdrawals
Authentication
Path Parameters
Query Parameters
application/json
Obter saque
Rota para realizar a consulta de um saque específico.
get
https://api.stone.com.br/core/v5/recipients/{recipient_id}/withdrawals/{withdrawals_id}
Path Parameters
recipient_idstringrequired
Código do recebedor
withdrawals_idstringrequired
Código da transferência
Response
application/json
Response
application/json
200
idstring
Example:transf_1A68BR3izKHz8Zqr
amountinteger
Default:0
Example:100
statusstring
Example:pending
created_atstring
Example:2017-10-27T16:12:56Z
updated_atstring
Example:2017-10-27T16:12:57Z
bank_accountobject
Show Child Parameters
get/recipients/{recipient_id}/withdrawals/{withdrawals_id}
Authentication
Path Parameters
application/json
Atualizar configurações de transferência
patch
https://api.stone.com.br/core/v5/recipients/{recipient_id}/transfer-settings
Path Parameters
recipient_idstringrequired
Identificador do recebedor
Body
application/json
Body
application/json
transfer_enabledbooleanrequired
Variável que indica se o recebedor irá receber os transferências automaticamente.
transfer_intervalstringrequired
Frequência na qual o recebedor irá receber transferências. Valores possíveis: daily, weekly, monthly
transfer_dayinteger(int32)required
Dia no qual o recebedor vai receber a transferência. Depende do transfer_interval. Se for daily, é necessário informar 0. Se for weekly pode ser de 1 (segunda) a 5 (sexta). Se for monthly, pode ser de 1 a 31.
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
transfer_settingsobject
Show Child Parameters
default_bank_accountobject
Show Child Parameters
gateway_recipientsarray[object]
Show Child Parameters
metadataobject
Show Child Parameters
patch/recipients/{recipient_id}/transfer-settings
Authentication
Path Parameters
Body
{
"transfer_enabled": false,
"transfer_interval": "Daily",
"transfer_day": 0
}
application/json