Pagar.me v5 · Docs Legacy

Pagar.me v5 API (Legado)

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

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

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

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

200

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

Obter pedido

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

Path Parameters

order_idstringrequired

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

Response

application/json

200

One Of
idstring

Example:or_28dN9w7CLU79kDjL

codestring

Example:62LVFN7I4R

amountinteger

Default:0

Example:2990

currencystring

Example:BRL

closedboolean

Default:true

Example:true

itemsarray[object]
Show Child Parameters
customerobject
Show Child Parameters
statusstring

Example:paid

created_atstring

Example:2017-04-19T16:01:09Z

updated_atstring

Example:2017-04-19T16:01:11Z

closed_atstring

Example:2017-04-19T16:01:11Z

chargesarray[object]
Show Child Parameters
get/orders/{order_id}
 
application/json