Pagar.me v5 · Docs Legacy

Pagar.me v5 API (Legado)

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

Atualizar configurações de transferência

patch
https://api.stone.com.br/core/v5/recipients/{recipient_id}/transfer-settings

Path Parameters

recipient_idstringrequired

Identificador do recebedor

Body

application/json
transfer_enabledbooleanrequired

Variável que indica se o recebedor irá receber os transferências automaticamente.

transfer_intervalstringrequired

Frequência na qual o recebedor irá receber transferências. Valores possíveis: daily, weekly, monthly

transfer_dayinteger(int32)required

Dia no qual o recebedor vai receber a transferência. Depende do transfer_interval. Se for daily, é necessário informar 0. Se for weekly pode ser de 1 (segunda) a 5 (sexta). Se for monthly, pode ser de 1 a 31.

Response

application/json

200

idstring

Example:rp_23452cBK6lP

namestring

Example:Tony Stark

emailstring

Example:tstark@avengers.com

documentstring

Example:223451990

descriptionstring

Example:Recebedor Tony Stark

typestring

Example:individual

statusstring

Example:active

created_atstring

Example:2018-05-23T16:17:39Z

updated_atstring

Example:2018-05-23T16:17:39Z

transfer_settingsobject
Show Child Parameters
default_bank_accountobject
Show Child Parameters
gateway_recipientsarray[object]
Show Child Parameters
metadataobject
Show Child Parameters
patch/recipients/{recipient_id}/transfer-settings

Body

{ "transfer_enabled": false, "transfer_interval": "Daily", "transfer_day": 0 }
 
application/json

Atualizar configurações de antecipação automática

patch
https://api.stone.com.br/core/v5/recipients/{recipient_id}/automatic-anticipation-settings

Path Parameters

recipient_idstringrequired

Identificador do recebedor

Body

application/json
enabledboolean

Variável que indica se o recebedor irá possuir antecipação automaticamentica.

Default:false

typestring

Configuração de como devemos criar as antecipações automáticas do recebedor. Valores possíveis full e 1025. Se informado full será criada antecipações seguindo a regra de volume máximo antecipável. Se informado 1025 será criada antecipações de vendas inteiras, modelos D+X e 10/25.

Default:full

volume_percentagestring

Porcentagem do valor passível de antecipação para este recebedor. Valores entre 0 e 100.

daysarray[string]

Lista de dias em que serão criar as antecipações automáticas. Valores possíveis de 1 a 31, necessário informar entre chaves"[ ]"

delaystring

Quantidade de dias, contados a partir do dia da antecipação para trás, que serão desconsiderados na criação desta antecipação

Response

application/json

200

idstring

Example:rp_23452cBK6lP

namestring

Example:Tony Stark

emailstring

Example:tstark@avengers.com

documentstring

Example:223451990

descriptionstring

Example:Recebedor Tony Stark

typestring

Example:individual

statusstring

Example:active

created_atstring

Example:2018-05-23T16:17:39Z

updated_atstring

Example:2018-05-23T16:17:39Z

transfer_settingsobject
Show Child Parameters
default_bank_accountobject
Show Child Parameters
automatic_anticipation_settingsobject
Show Child Parameters
gateway_recipientsarray[object]
Show Child Parameters
metadataobject
Show Child Parameters
patch/recipients/{recipient_id}/automatic-anticipation-settings

Body

{ "enabled": true, "type": "full", "volume_percentage": "50", "days": [ 1, 3, 5 ], "delay": null }
 
application/json

Obter recebíveis

Retorna os recebíveis da sua loja.

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

Query Parameters

created_sincestring(date)

Filtro pela data de criação do recebível como data de partida. Quando não informado, o padrão é a data atual menos 6 meses

Default:

created_untilstring(date)

Filtro pela data de criação do recebível como data limite

statusstring

Filtro pelo status do recebível, paid ou waiting_funds

payment_date_sincestring(date)

Filtro pela data de pagamento do recebível, como data de partida

payment_date_untilstring(date)

Filtro pela data de pagamento do recebível, como data limite

typestring

Filtro pelo type do recebível. Pode ser chargeback, refund, chargeback_refund ou credit

updated_sincestring(date)

Filtro pela data de atualização do recebível, como data de partida

updated_untilstring(date)

Filtro pela data de atualização do recebível, como data limite

charge_idstring

Filtro pelo código da cobrança

recipient_idstring

Filtro pelo código do recebedor

split_idstring

Filtro pelo identificador da regra de split

idstring

Filtro pelo identificador do recebível

sizeinteger(int32)

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

pageinteger(int32)

Filtro pela página de retorno. Utilize o parâmetro forward_cursor para paginação

forward_cursorstring

Cursor para retorno da próxima página, seu valor é retornado no corpo da resposta em paging.forward_cursor

Response

application/json

200

One Of
dataarray[object]
Show Child Parameters
pagingobject
get/payables
 
application/json

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