Pagar.me v5 · Docs Legacy

Pagar.me v5 API (Legado)

Obter um recebível

Retorna um recebível específico da sua loja.

get
https://api.stone.com.br/core/v5/payables/{payable_id}

Path Parameters

payable_idstringrequired

Filtro pelo identificador do recebível

Response

application/json

200

idinteger

Default:0

Example:4304198148

statusstring

Example:waiting_funds

amountinteger

Default:0

Example:927

feeinteger

Default:0

anticipation_feeinteger

Default:0

fraud_coverage_feeinteger

Default:0

installmentinteger

Default:0

Example:1

gateway_idinteger

Default:0

Example:23833759

split_idstring

Example:sr_cljh854vb03tf019thoelps6p

recipient_idstring

Example:re_clfj3jwyj051k019tyakiduuc

payment_datestring

Example:2023-08-01T03:00:00Z

typestring

Example:credit

payment_methodstring

Example:credit_card

accrual_atstring

Example:2023-06-29T14:11:52Z

created_atstring

Example:2023-06-29T14:11:56Z

get/payables/{payable_id}
 
application/json

Obter histórico das operações

Com esta rota é possível verificar os movimentos ocorridos no saldo da sua conta.

get
https://api.stone.com.br/core/v5/balance/operations

Query Parameters

created_sincestring

Filtro pela data de criação da operação de saldo, como data de partida

created_untilstring

Filtro pela data de criação da operação de saldo, como data limite

statusstring

Estado do saldo da conta. Valores possíveis: waiting_funds, available e transferred, sendo o default available

recipient_idstring

ID de recebedor desejado

sizeinteger(int32)

Filtro pela quantidade de objetos retornados. Deve ser menor ou igual a 1000

pageinteger(int32)

Filtro pela página de retorno

Response

application/json

200

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

Obter histórico específico de uma operação

Retorna uma operação específica ocorrida no saldo da sua conta.

get
https://api.stone.com.br/core/v5/balance/operations/{balance_operation_id}

Path Parameters

balance_operation_idstringrequired

ID da operação desejada

Response

application/json

200

idinteger

Default:0

Example:2155314409

statusstring

Example:available

balance_amountinteger

Default:0

typestring

Example:payable

amountinteger

Default:0

Example:-8990

feeinteger

Default:0

created_atstring

Example:2023-06-27T20:59:20Z

movement_objectobject
Show Child Parameters
get/balance/operations/{balance_operation_id}
 
application/json

Retornando URs de um Recebedor

get
https://api.stone.com.br/core/v5/recipients/{recipient_id}/receivable-units

Query Parameters

start_datestring(date-time)required

Dia inicial da consulta de agenda. Deve ser informado em timestamp

end_datestring(date-time)required

Dia final da consulta de agenda. Dia inicial da consulta de agenda. Deve ser informado em timestamp

Path Parameters

recipient_idstringrequired

Código do recebedor

Response

application/json

200

get/recipients/{recipient_id}/receivable-units
 
application/json

Enviar webhook

post
https://api.stone.com.br/core/v5/hooks/{hook_id}/retry

Path Parameters

hook_idstringrequired

Código do webhook.

Response

application/json

200

object
post/hooks/{hook_id}/retry
 
application/json