Pagar.me v5 · Docs Legacy

Pagar.me v5 API (Legado)

Obtendo os limites de antecipação

Retorna os limites máximos e mínimos de antecipação que um recebedor pode fazer.

get
https://api.stone.com.br/core/v5/recipients/{recipient_id}/bulk_anticipations/limits

Query Parameters

payment_datestringrequired

Data de pagamento desejada para a antecipação, ou seja, data em que você deseja que o dinheiro esteja em sua conta Pagar.me disponível para saque

timeframestring

Define o período de onde os recebíveis serão escolhidos. start define recebíveis próximos, perto de serem pagos, e end define recebíveis longes, no final de todos recebíveis que você possui para receber

Path Parameters

recipient_idstringrequired

Identificador do recebedor

Response

application/json

200

maximumobject
Show Child Parameters
minimumobject
Show Child Parameters
get/recipients/{recipient_id}/bulk_anticipations/limits
 
application/json

Cancelando uma antecipação pending

Cancela uma antecipação com status pending. Enquanto a antecipação foi criada e o Pagar.me ainda não a confirmou, você pode cancelar a antecipação a qualquer momento.

post
https://api.stone.com.br/core/v5/recipients/{recipient_id}/bulk_anticipations/{bulk_anticipation_id}/cancel

Path Parameters

recipient_idstringrequired

ID de recebedor desejado

bulk_anticipation_idstringrequired

ID da antecipação desejada

Response

application/json

200

idstring

Example:ba_123456789

statusstring

Example:canceled

amountinteger

Default:0

Example:100000

feeinteger

Default:0

Example:5000

fraud_coverage_feeinteger

Default:0

anticipation_feeinteger

Default:0

Example:3000

automatic_transferboolean

Default:true

typestring

Example:spot

timeframestring

Example:start

payment_datestring

Example:2025-08-20T00:00:00.000Z

created_atstring

Example:2025-08-19T14:23:00.000Z

updated_atstring

Example:2025-08-20T10:15:00.000Z

anticipation_taxnumber

Default:0

Example:0.018

post/recipients/{recipient_id}/bulk_anticipations/{bulk_anticipation_id}/cancel
 
application/json

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

200

object
get/settlements
 
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

200

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

200

object
get/settlements/{settlement_id}
 
application/json