Pagar.me v5 · Docs Legacy
Confirmar cobrança (cash)
Para a confirmação de cobranças com meio de pagamento cash com o status pending.
post
https://api.stone.com.br/core/v5/charges/{charge_id}/confirm-payment
Path Parameters
charge_idstringrequired
Código da cobrança.
Body
application/json
Body
application/json
amountinteger(int32)
Valor a ser confirmado. Caso não seja informado, será considerado o valor total da cobrança
codestring
Código da cobrança no sistema da loja. Irá atualizar o valor informado na criação da cobrança. Max: 52 caracteres
descriptionstring
Descrição
Response
application/json
Response
application/json
200
idstring
Example:ch_7YBoBPWCVKS3QdyM
codestring
Example:WZQS3LHEKW
gateway_idstring
Example:42c243c4-0b52-49f3-ba92-e8661ebc7916
amountinteger
Default:0
Example:1490
statusstring
Example:paid
currencystring
Example:BRL
payment_methodstring
Example:credit_card
due_atstring
Example:2017-04-04T00:00:00
paid_atstring
Example:2017-04-04T20:06:14
created_atstring
Example:2017-04-04T20:05:39
updated_atstring
Example:2017-04-04T20:06:14
customerobject
Show Child Parameters
last_transactionobject
Show Child Parameters
metadataobject
Show Child Parameters
post/charges/{charge_id}/confirm-payment
Authentication
Path Parameters
Body
{}
application/json
Criar cobrança
post
https://api.stone.com.br/core/v5/charges.
Body
application/json
Body
application/json
codestring
Código identificador da cobrança no sistema da loja.
amountinteger(int32)required
Valor da cobrança em centavos
currencystring
Moeda. Valores possíveis: BRL, ARS, BOB, CLP, **COP **, MXN, PYG, **USD **, UYU e EUR.
paymentobjectrequired
Dados sobre o pagamento. Saiba mais sobre pagamentos
customer_idstringrequired
Código do cliente.
customerobjectrequired
Dados do cliente. Obrigatório caso o customer_id não seja informado. Saiba mais sobre clientes.
metadatastring
Objeto chave/valor utilizado para armazenar informações adicionais sobre a cobrança. Saiba mais sobre metadata.
Response
application/json
Response
application/json
200
idstring
Example:ch_kp64Edig1t79NajE
codestring
Example:28ZMCQWSW4
gateway_idstring
Example:909f4fb7-17a2-4753-a5de-80491ffd80d3
amountinteger
Default:0
Example:1490
statusstring
Example:pending
currencystring
Example:BRL
payment_methodstring
Example:credit_card
created_atstring
Example:2017-10-19T21:45:21Z
updated_atstring
Example:2017-10-19T21:45:21Z
customerobject
Show Child Parameters
last_transactionobject
Show Child Parameters
metadataobject
Show Child Parameters
post/charges.
Authentication
Body
{
"amount": 1490,
"customer": {
"name": "Tony Stark",
"email": "tony@email.com"
},
"payment": {
"payment_method": "credit_card",
"credit_card": {
"capture": false,
"installments": 1,
"statement_descriptor": "AVENGERS",
"card": {
"number": "4556859837525",
"holder_name": "Tony Stark",
"exp_month": 1,
"exp_year": 30,
"cvv": "558"
}
}
},
"metadata": {
"code": "123"
}
}
application/json
Criar link de pagamento
post
https://api.stone.com.br/core/v5/paymentlinks
Body
application/json
Body
application/json
is_buildingboolean
Define se o link de pagamento será criado com o status building ou ativo, em caso de envio do campo true tal permite que você ative um link em determinado momento posteriormente, para realizar uma ação promocional, por exemplo;
Default:false
namestring
Nome que será exibido na dashboard e ao buscar o link de pagamento através da API. Máximo de 64 caracteres.
typestringrequired
Define o tipo do link de pagamento a ser criado, podendo ser “order”, para criação de pedidos, ou “subscription”, para recorrências.
expires_atstring(date)
Define a data de expiração do link de pagamento. Formato ISO 8601. Caso não seja enviado o link não terá expiração por tempo. Não deve ser enviado caso o campo expires_in seja enviado.
expires_ininteger(int32)
Define o tempo de expiração do link de pagamento em minutos após o mesmo estar ativo. Tempo em minutos. Caso não seja enviado, o link não terá expiração por tempo. Não deve ser enviado caso o campo expires_at seja enviado.
max_sessionsinteger(int32)
Define o máximo de pedidos que o link de pagamento pode gerar, sejam eles pagos ou não. Caso não seja enviado, não haverá limite de pedidos criados.
max_paid_sessionsinteger(int32)
Define o máximo de pedidos pagos que o link de pagamento pode gerar. Caso não seja enviado, não haverá limite de pagamentos.
payment_settingsobjectrequired
Configurações de pagamento do link.
Show Child Parameters
customer_settingsobject
Define os dados do cliente, se aplicável.
Show Child Parameters
cart_settingsobjectrequired
Define os dados do carrinho que será pago pelo link de pagamento.
Show Child Parameters
layout_settingsobject
Dados de layout.
Show Child Parameters
order_codestring
Permite ao lojista informar um identificador de sua plataforma para correlação
split_settingsobject
Define as regras de split de pagamento
Show Child Parameters
flow_settingsobject
Show Child Parameters
Response
application/json
Response
application/json
200
post/paymentlinks
Authentication
Body
{
"payment_settings": {
"accepted_payment_methods": [
"credit_card"
],
"credit_card_settings": {
"operation_type": "auth_and_capture",
"installments": [
{
"number": 1,
"total": 12000
},
{
"number": 2,
"total": 12000
}
]
}
},
"cart_settings": {
"items": [
{
"amount": 12000,
"name": "Banner",
"default_quantity": 1
}
]
},
"name": "Banner N12345",
"type": "order"
}
application/json
Obter links de pagamento
get
https://api.stone.com.br/core/v5/paymentlinks
Query Parameters
namestring
Nome do link de pagamento gerado.
statusstring
Status do link de pagamento gerado. Possíveis status: building, active, cancelled, expired
created_sincestring(date)
Define o filtro de data de criação do link de pagamento para busca. Formato ISO 8601.
created_untilstring(date)
Define o filtro de data de criação do link de pagamento para busca. Formato ISO 8601.
pageinteger(int32)
Página a ser recuperada.
per_pageinteger(int32)
Quantidade de links de pagamento recuperados por página. Máximo 30.
Response
application/json
Response
application/json
200
object
get/paymentlinks
Authentication
Query Parameters
application/json
Obter link de pagamento
get
https://api.stone.com.br/core/v5/paymentlinks/{payment_link_id}
Path Parameters
payment_link_idstringrequired
ID do link de pagamento. Exemplo: pl_gD2G97aVBqvREz3Hr4u1deLW40JlnmQ8
Response
application/json
Response
application/json
200
object
get/paymentlinks/{payment_link_id}
Authentication
Path Parameters
application/json