Pagar.me v5 · Docs Legacy

Pagar.me v5 API (Legado)

Listar webhooks

get
https://api.stone.com.br/core/v5/hooks

Query Parameters

statusstring

Status do webhook (‘pending’, ‘sent’ or ‘failed’)

webhook_eventstring

Nome do evento do webhook

created_sincestring(date)

Data de início do período de criação a ser listado.

created_untilstring(date)

Data final do período de criação a ser listado.

pageinteger(int32)

Número da página.

Default:1

sizeinteger(int32)

Quantidade de itens por página.

Default:10

Response

application/json

200

dataarray[object]
Show Child Parameters
pagingobject
Show Child Parameters
get/hooks
 
application/json

Criação de pedido MF

post
https://api.stone.com.br/core/v5/odersMF

Body

application/json
amountstring

Allowed values:

Response

application/json

200

object
post/odersMF

Body

{ "items": [ { "amount": 1000, "description": "Chaveiro do Tesseract", "quantity": 1, "code": "123" } ], "closed": "false", "poi_payment_settings": { "visible": true, "display_name": "Teste NF", "print_order_receipt": true, "devices_serial_number": [ "6M489133" ], "payment_setup": { "type": "credit", "installments": 1, "installment_type": "merchant" } }, "customer": { "name": "Tony Stark", "email": "testes@gmail.com", "Document": "13621248773", "type": "individual", "phones": { "home_phone": { "country_code": "55", "area_code": "21", "number": "000000000" }, "mobile_phone": { "country_code": "55", "area_code": "21", "number": "000000000" } } } }
 
application/json

Criando uma antecipação

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

Path Parameters

recipient_idstringrequired

Código do recebedor

Body

application/json
payment_datestringrequired

Data de pagamento da antecipação. Data no formato ISO 8601

timeframestringrequired

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. String start ou end

requested_amountinteger(int32)required

Valor líquido, em centavos, que você deseja receber de antecipação

automatic_transferboolean

Define se o valor da antecipação será transferido automaticamente para a conta bancária do recebedor

Default:false

Response

application/json

200

idstring

Example:ba_123456789

statusstring

Example:approved

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_tax
post/recipients/{recipient_id}/bulk_anticipations

Body

{ "payment_date": "payment_date", "timeframe": "timeframe", "requested_amount": 0 }
 
application/json

Retornando antecipações

Retorna uma lista contendo objetos de antecipações.

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

Query Parameters

countstring

Retorna n resultados, com um máximo de 1000

pagestring

Útil para implementação de uma paginação de resultados

amountstring

Filtro de amount

feestring

Filtro de fee

anticipation_feestring

Filtro de anticipation fee

idstring

ID da antecipação procurada

payment_datestring

Data de pagamento procurada

Path Parameters

recipient_idstringrequired

Response

application/json

200

idstring

Example:ba_123456789

statusstring

Example:approved

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_tax
get/recipients/{recipient_id}/bulk_anticipations
 
application/json

Simulando uma Antecipação Spot

Obtem previsões precisas sobre o valor a ser recebido, os custos envolvidos na operação, e a data de pagamento. Para iniciar a simulação da antecipação, é necessário utilizar a rota:

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

Query Parameters

timeframestringrequired

Define o período de onde os recebíveis serão escolhidos para simulação — ou seja, do inicio ou do fim da sua agenda de recebíveis.

requested_amountinteger(int32)required

Valor líquido, em centavos, que você deseja receber na antecipação, o valor deve estar entre o limite antecipável do recebedor. Caso queira consultar os limites antecipáveis utilize a rota /limits.

payment_datestringrequired

Data que você deseja receber a antecipação em sua conta Pagar.me. O parâmetro payment_date pode ser para qualquer dia no futuro e do dia atual até as 11h, caso já tenha passado desse horário, por favor adicione um payment_date para o próximo dia útil. Data em string no formato ISO 8601

Path Parameters

recipient_idstringrequired

ID do recebedor para o qual deseja simular a antecipação.

Response

application/json

200

amountinteger

Default:0

Example:1000000

feeinteger

Default:0

Example:20000

fraudCoverageFeeinteger

Default:0

anticipationAmountinteger

Default:0

Example:900000

anticipationFeeinteger

Default:0

Example:80000

timeframestring

Example:start

paymentDatestring

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

startIntervalDatestring

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

endIntervalDatestring

Example:2024-12-18T00:00:00.000Z

get/recipients/{recipient_id}/bulk_anticipations/simulate
 
application/json