Pagar.me v5 · Docs Legacy
Retornando pagamentos
Retorna um Array contendo objetos de pagamentos (settlements) de um recebedor ordenados a partir da data de criação colocando os mais recentes no topo.
get
https://api.stone.com.br/core/v5/settlements
Query Parameters
payment_date_startstringrequired
Início da data de pagamento. Data no formato YYYY-MM-DD
payment_date_endstringrequired
Fim da data de pagamento. Data no formato YYYY-MM-DD
liquidation_arrangement_idstring
ID da LiquidationArrangement
pageinteger(int32)
Número da página
limitinteger(int32)
Limite de itens por página. Valor máximo = 2000
get_ispbboolean
Se retorna ou não os dados de ISPB das Settlements
settlement_idstring
ID da Settlement para usar como base. O ID da LiquidationArrangement desta Settlement será utilizado como filtro. Sobrescreve o parâmetro liquidation_arrangement_id
external_engine_payment_idstring
ID do motor de liquidação utilizado internamente
orderstring
Ordernar pela criação da Settlement crescente ou decrescente. String asc ou desc
Default:desc
Response
application/json
Response
application/json
200
object
get/settlements
Authentication
Query Parameters
application/json
Retornando pagamentos por recebedor
Retorna um Array contendo objetos de pagamentos (settlements) de um recebedor ordenados a partir da data de criação colocando os mais recentes no topo.
get
https://api.stone.com.br/core/v5/recipients/{recipient_id}/settlements
Query Parameters
payment_date_startstringrequired
Início da data de pagamento (inclusivo). Data no formato YYYY-MM-DD
payment_date_endstringrequired
Fim da data de pagamento (inclusivo). Data no formato YYYY-MM-DD
Path Parameters
recipient_idstringrequired
ID do recebedor
Response
application/json
Response
application/json
200
object
get/recipients/{recipient_id}/settlements
Authentication
Path Parameters
Query Parameters
application/json
Retornando um pagamento
get
https://api.stone.com.br/core/v5/settlements/{settlement_id}
Path Parameters
settlement_idstringrequired
ID do pagamento
Response
application/json
Response
application/json
200
object
get/settlements/{settlement_id}
Authentication
Path Parameters
application/json
Criando uma transferência
Realiza uma transferência para uma conta bancária previamente criada.
post
https://api.stone.com.br/core/v5/transfers
Headers
Idempotency-Keystring
Valor único que identifica a transação para permitir uma nova tentativa de requisição com a segurança de que a mesma operação não será executada duas vezes acidentalmente.
Body
application/json
Body
application/json
amountinteger(int32)required
Valor, em centavos, a ser transferido para uma determinada conta bancária (valor precisa estar entre 1 e 2147483647)
recipient_idstring
Indica que o valor da transferência sairá da conta do recebedor identificado por este parâmetro. OBS: Caso o recipient_id seja passado, não é necessário passar bank_account_id
metadatastring(json)
Você pode passar dados adicionais na criação da transferência para facilitar uma futura análise de dados por seus sistemas.
Response
application/json
Response
application/json
200
objectstring
Example:transfer
idinteger
Default:0
Example:65485
amountinteger
Default:0
Example:100
typestring
Example:ted
statusstring
Example:pending_transfer
source_typestring
Example:recipient
source_idstring
Example:re_cix7pxz6f02ppcv6dn4ckcrcc
target_typestring
Example:bank_account
target_idstring
Example:17346045
feeinteger
Default:0
Example:367
funding_date
funding_estimated_datestring
Example:2017-02-18T02:00:00.000Z
transaction_id
date_createdstring
Example:2017-02-17T16:24:20.933Z
bank_accountobject
Show Child Parameters
metadataobject
Show Child Parameters
post/transfers
Authentication
Headers
Body
{
"amount": 0
}
application/json
Retornando transferências
Retorna os dados de todas as transferências previamente realizadas.
get
https://api.stone.com.br/core/v5/transfers
Query Parameters
countstring
Retorna n resultados, com um máximo de 1000
Default:10
cursorstring
Útil para implementação de uma paginação de resultados, permitindo a troca de páginas utilizando x-cursor-nextpage ou x-cursor-previouspage.
x-cursor-nextpagestring
Retornado nos headers da resposta contém o Token que permite acesso a próxima página.
x-cursor-previouspagestring
Retornado nos headers da resposta contém o Token que permite acesso a página anterior.
bank_account_idstring
Filtro de bank account id
amountstring
Filtro de amount
recipient_idstring
Filtro de recipient id
idstring
ID da transferência procurada
date_createdstring(date)
Filtro de data da criação da transferência
created_atstring(date)
Mesmo que date_created
statusstring
Filtro para um dos status: pending_transfer, transferred, failed, processing, canceled
date_updatedstring(date)
Filtro para data de último update
Response
application/json
Response
application/json
200
objectstring
Example:transfer
idinteger
Default:0
Example:65485
amountinteger
Default:0
Example:100
typestring
Example:ted
statusstring
Example:pending_transfer
source_typestring
Example:recipient
source_idstring
Example:re_cix7pxz6f02ppcv6dn4ckcrcc
target_typestring
Example:bank_account
target_idstring
Example:17346045
feeinteger
Default:0
Example:367
funding_date
funding_estimated_datestring
Example:2017-02-18T02:00:00.000Z
transaction_id
date_createdstring
Example:2017-02-17T16:24:20.933Z
bank_response
bank_accountobject
Show Child Parameters
metadataobject
Show Child Parameters
get/transfers
Authentication
Query Parameters
application/json