Pagar.me v5 · Docs Legacy

Pagar.me v5 API (Legado)

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
bank_accountobjectrequired

Dados da conta bancária

Show Child Parameters

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

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

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
 
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
amountinteger(int32)

Valor da cobrança em centavos

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

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

200

get/recipients/{recipient_id}/withdrawals
 
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

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