Pagar.me v5 · Docs Legacy

Pagar.me v5 API (Legado)

Obter endereço

Através dos identificadores do cliente (customer_id) e do endereço (address_id) é possível obter o endereço do cliente.

get
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

200

idstring

Example:addr_Pn5x69LCWhrANX2o

line_1string

Example:375, Av. General Justo, Centro

line_2string

Example:10º andar

zip_codestring

Example:20021130

citystring

Example:Rio de Janeiro

statestring

Example:RJ

countrystring

Example:BR

statusstring

Example:deleted

created_atstring

Example:2017-04-19T17:49:36Z

updated_atstring

Example:2017-04-19T17:50:18Z

deleted_atstring

Example:2017-04-19T17:50:34Z

customerobject
Show Child Parameters
metadataobject
Show Child Parameters
get/customers/{customer_id}/addresses/{address_id}
 
application/json

Editar endereço

Com o verbo HTTP PUT, através dos identificadores do cliente (customer_id) e do endereço (address_id) é possível atualizar informações complementares do endereço.

put
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.

Body

application/json
line_2string

Linha 2 do endereço. (Complemento - Andar, Sala, Apto). Max: 128 caracteres.

metadatastring

Objeto chave/valor utilizado para armazenar informações adicionais sobre o endereço. Saiba mais sobre metadata.

Response

application/json

200

idstring

Example:addr_Pn5x69LCWhrANX2o

line_1string

Example:375, Av. General Justo, Centro

line_2string

Example:10º andar

zip_codestring

Example:20021130

citystring

Example:Rio de Janeiro

statestring

Example:RJ

countrystring

Example:BR

statusstring

Example:active

created_atstring

Example:2017-04-19T17:49:36Z

updated_atstring

Example:2017-04-19T17:50:18Z

customerobject
Show Child Parameters
metadataobject
Show Child Parameters
put/customers/{customer_id}/addresses/{address_id}

Body

{ "line_2": "10º andar", "metadata": { "id": "work" } }
 
application/json

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

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}
 
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
codestring

Código identificador do pedido no sistema da loja. Max: 52 caracteres.

itemsarray[object]required
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

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

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

200

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