Pagar.me v5 · Docs Legacy
Excluir endereço
Com o verbo HTTP DELETE, através do identificador do endereço(address_id) e do identificador do cliente (customer_id) ao qual o endereço está associado, é possível remover o endereço da Wallet do cliente.
delete
https://api.stone.com.br/core/v5/customers/{customer_id}/addresses/{address_id}
Path Parameters
customer_idstringrequired
Código do cliente. Formato: cus_XXXXXXXXXXXXXXXX.
address_idstringrequired
Código do endereço. Formato: addr_XXXXXXXXXXXXXXXX.
Response
application/json
Response
application/json
200
idstring
Example:addr_GEjbAjaUK9h1PRLa
line_1string
Example:10882, Malibu Point, Central Malibu
streetstring
Example:Malibu Point
numberstring
Example:10882
zip_codestring
Example:90265
neighborhoodstring
Example:Central Malibu
citystring
Example:Malibu
statestring
Example:CA
countrystring
Example:US
statusstring
Example:deleted
created_atstring
Example:2018-12-14T18:57:18Z
updated_atstring
Example:2018-12-14T18:58:36Z
deleted_atstring
Example:2018-12-14T18:58:36Z
customerobject
Show Child Parameters
delete/customers/{customer_id}/addresses/{address_id}
Authentication
Path Parameters
application/json
Criar pedido com split
Para realizar pedidos com split, você deve criar um objeto order com o objeto split.
Para formar o objeto split, você deve primeiramente cadastrar recebedores.
O objeto order com split possui os seguintes atributos:
post
https://api.stone.com.br/core/v5/orders
Body
application/json
Body
application/json
codestring
Código identificador do pedido no sistema da loja. Max: 52 caracteres.
itemsarray[object]required
Itens do pedido. Saiba mais sobre itens do pedido
Show Child Parameters
customer_idstring
Código do cliente.
customerobject
Dados do cliente. Obrigatório caso o customer_id não seja informado. Saiba mais sobre clientes
Show Child Parameters
shippingobject
Dados para entrega.
Show Child Parameters
paymentsarray[object]required
Lista de dados de pagamento. Saiba mais sobre pagamentos.
Show Child Parameters
closedboolean
Informa se o pedido será criado aberto ou fechado
metadatastring
Objeto chave/valor utilizado para armazenar informações adicionais sobre o pedido.
Response
application/json
Response
application/json
200
idstring
Example:ch_NW0ABG5HQikn3Lv4
codestring
Example:487FO9HYV3
gateway_idstring
Example:3554818
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-05-22T18:38:22Z
created_atstring
Example:2018-05-22T18:38:08Z
updated_atstring
Example:2018-05-22T18:38:08Z
customerobject
Show Child Parameters
last_transactionobject
Show Child Parameters
metadataobject
Show Child Parameters
post/orders
Authentication
Body
{
"items": [
{
"amount": 100,
"description": "Chaveiro do Tesseract",
"quantity": 1,
"code": "12345"
}
],
"customer": {
"name": "Tony Stark",
"email": "Tony@Avangers.com"
},
"payments": [
{
"payment_method": "credit_card",
"credit_card": {
"installments": 1,
"statement_descriptor": "AVENGERS",
"card": {
"number": "342793631858229",
"holder_name": "Tony Stark",
"exp_month": 1,
"exp_year": 30,
"cvv": "3531",
"billing_address": {
"line_1": "10880, Malibu Point, Malibu Central",
"zip_code": "90265",
"city": "Malibu",
"state": "CA",
"country": "US"
}
}
},
"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
Listar pedidos
get
https://api.stone.com.br/core/v5/orders
Query Parameters
codestring
Código de referência do pedido no sistema da loja.
statusstring
Status do pedido. Valores possíveis: pending, paid, canceled ou failed
customer_idstring
Código do cliente.
created_sincestring(date)
Data de início do período de criação a ser listado.
created_untilstring(date)
Data de final do período de criação a ser listado.
pageinteger(int32)
Página atual.
Default:1
sizeinteger(int32)
Quantidade de itens.
Default:10
Response
application/json
Response
application/json
200
dataarray[object]
Show Child Parameters
pagingobject
Show Child Parameters
get/orders
Authentication
Query Parameters
application/json
Incluir cobrança no pedido
Enquanto um pedido estiver aberto, é possível adicionar novas cobranças utilizando o order_id na criação de uma cobrança.
post
https://api.stone.com.br/core/v5/charges
Body
application/json
Body
application/json
order_idstringrequired
Código do pedido
amountinteger(int32)required
Valor da cobrança em centavos
paymentobjectrequired
Dados sobre pagamento.
Show Child Parameters
due_atstring(date)
Data de vencimento da cobrança.
customer_idstring
Código do cliente.
customerobject
Dados do cliente. Se nem o customer_id nem o customer forem informados, será considerado o mesmo cliente do pedido.
metadatastring
Objeto chave/valor utilizado para armazenar informações adicionais sobre a cobrança.
Response
application/json
Response
application/json
200
idstring
Example:ch_xyRZw5XCLhl3ENjP
codestring
Example:LM4AVYSYQ9
gateway_idstring
Example:769e2123-a634-46dc-8bba-529bba7fb726
amountinteger
Default:0
Example:2990
statusstring
Example:paid
currencystring
Example:BRL
payment_methodstring
Example:credit_card
due_atstring
Example:2017-04-05T00:00:00
paid_atstring
Example:2017-04-05T05:51:44
created_atstring
Example:2017-04-05T05:51:37
updated_atstring
Example:2017-04-05T05:51:37
orderobject
Show Child Parameters
customerobject
Show Child Parameters
last_transactionobject
Show Child Parameters
post/charges
Authentication
Body
{
"order_id": "or_gnvV6V1VTgspL4JB",
"amount": 2990,
"payment": {
"payment_method": "credit_card",
"credit_card": {
"installments": 1,
"statement_descriptor": "AVENGERS",
"card": {
"number": "342793631858229",
"holder_name": "Tony Stark",
"exp_month": 1,
"exp_year": 30,
"cvv": "3531",
"billing_address": {
"zip_code": "90265",
"city": "Malibu",
"state": "CA",
"country": "US",
"line_1": "10880, Malibu Point, Malibu Central"
}
}
}
}
}
application/json
Listar cobranças
get
https://api.stone.com.br/core/v5/charges
Query Parameters
codestring
Código de referência da cobrança no sistema da loja
statusstring
Status da cobrança. Valores possíveis: pending, paid, canceled, processing, failed, overpaid ou underpaid
payment_methodstring
Meio de pagamento. Valores possíveis: credit_card, boleto, bank_transfer, safetypay ou voucher
customer_idstring
Código do cliente.
order_idstring
Código do pedido.
created_sincestring
Data de início do período de criação a ser listado.
created_untilstring(date)
Data de final do período de criação a ser listado.
pageinteger(int32)
Página atual.
Default:1
sizeinteger(int32)
Quantidade de itens por página.
Default:10
Response
application/json
Response
application/json
200
dataarray[object]
Show Child Parameters
pagingobject
Show Child Parameters
get/charges
Authentication
Query Parameters
application/json