Pagar.me v5 · Docs Legacy

Pagar.me v5 API (Legado)

Editar item do pedido

Quando um pedido está aberto, você pode editar os itens dele.

put
https://api.stone.com.br/core/v5/orders/{order_id}/items/{item_id}

Path Parameters

order_idstringrequired

Código do pedido

item_idstringrequired

Código do item do pedido

Body

application/json
amountinteger(int32)required

Valor do item.

descriptionstringrequired

Descrição do item. Max: 256 caracteres.

quantityinteger(int32)required

Quantidade de itens.

categorystring

Categoria do item. Max: 64 caracteres.

Response

application/json

200

idstring

Example:oi_AQKqAnGhQGsYd1b6

descriptionstring

Example:Água com gás

amountinteger

Default:0

Example:1090

quantityinteger

Default:0

Example:2

statusstring

Example:active

created_atstring

Example:2017-04-05T03:55:48

updated_atstring

Example:2017-04-05T05:05:14

orderobject
Show Child Parameters
put/orders/{order_id}/items/{item_id}

Body

{ "amount": 1090, "description": "Água com gás", "quantity": 2 }
 
application/json

Deletar item

Quando um pedido está aberto, você pode excluir itens dele.

delete
https://api.stone.com.br/core/v5/orders/{order_id}/items/{item_id}

Path Parameters

order_idstringrequired

Códido do pedido.

item_idstringrequired

Código do item do pedido.

Response

application/json

200

idstring

Example:oi_AQKqAnGhQGsYd1b6

descriptionstring

Example:Caneca Zero Grau

amountinteger

Default:0

Example:1090

quantityinteger

Default:0

Example:2

statusstring

Example:deleted

created_atstring

Example:2017-04-05T03:55:48

updated_atstring

Example:2017-04-05T05:05:14

deleted_atstring

Example:2017-04-05T05:30:34

orderobject
Show Child Parameters
delete/orders/{order_id}/items/{item_id}
 
application/json

Obter item do pedido

Obter um item especifico dentro de um pedido especifico.

get
https://api.stone.com.br/core/v5/orders/{order_id}/items/{item_id}

Path Parameters

order_idstringrequired

Código do pedido.

item_idstringrequired

Código do item do pedido.

Response

application/json

200

idstring

Example:oi_gJ4RZVujNFDVRwpn

descriptionstring

Example:Chaveiro do Tesseract

amountinteger

Default:0

Example:2990

quantityinteger

Default:0

Example:1

statusstring

Example:active

created_atstring

Example:2017-12-18T16:49:43Z

updated_atstring

Example:2017-12-18T16:49:43Z

orderobject
Show Child Parameters
get/orders/{order_id}/items/{item_id}
 
application/json

Capturar cobrança com split

Rota para capturar uma cobrança com split, definindo a regra de split e os recebedor que irão participar da divisão dos pagamentos.

post
https://api.stone.com.br/core/v5/charges/{charge_id}/capture

Path Parameters

charge_idstringrequired

Código da cobrança.

Body

application/json
amountinteger(int32)

Valor a ser capturado. Caso não seja informado, será considerado o valor total da cobrança.

splitarray[object]

Lista de regras de split.

Show Child Parameters

Response

application/json

200

idstring

Example:ch_WOoyJ6u3kUzGyj46

codestring

Example:G11LT7MHVL

gateway_idstring

Example:3910377

amountinteger

Default:0

Example:100

paid_amountinteger

Default:0

Example:100

statusstring

Example:paid

currencystring

Example:BRL

payment_methodstring

Example:credit_card

paid_atstring

Example:2018-07-11T17:08:54Z

canceled_atstring

Example:2018-07-11T17:09:04Z

created_atstring

Example:2018-07-11T17:08:52Z

updated_atstring

Example:2018-07-11T17:09:04Z

customerobject
Show Child Parameters
last_transactionobject
Show Child Parameters
metadataobject
Show Child Parameters
post/charges/{charge_id}/capture

Body

{ "amount": 100, "split": [ { "amount": 50, "recipient_id": "rp_5yGwpMGckBHVYmb6", "type": "percentage", "options": { "charge_processing_fee": true, "charge_remainder_fee": true, "liable": true } }, { "amount": 50, "type": "percentage", "recipient_id": "rp_yLnAyVpHbQIqZxwO", "options": { "charge_processing_fee": false, "charge_remainder_fee": false, "liable": false } } ] }
 
application/json

Obter cobrança

get
https://api.stone.com.br/core/v5/charges/{charge_id}

Path Parameters

charge_idstringrequired

Código da cobrança.

Response

application/json

200

One Of
idstring

Example:ch_6NXoYXyiNfP3A54l

codestring

Example:ABCDE123

amountinteger

Default:0

Example:1490

paid_amountinteger

Default:0

Example:1490

statusstring

Example:paid

currencystring

Example:BRL

payment_methodstring

Example:credit_card

paid_atstring

Example:2019-01-22T14:31:36Z

created_atstring

Example:2019-01-22T14:30:12Z

updated_atstring

Example:2019-01-22T14:31:36Z

customerobject
Show Child Parameters
last_transactionobject
Show Child Parameters
metadataobject
Show Child Parameters
get/charges/{charge_id}
 
application/json