curl --request GET \
--url https://besimplo.com/api/v1/events/{id} \
--header 'Authorization: <api-key>'import requests
url = "https://besimplo.com/api/v1/events/{id}"
headers = {"Authorization": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: '<api-key>'}};
fetch('https://besimplo.com/api/v1/events/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://besimplo.com/api/v1/events/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://besimplo.com/api/v1/events/{id}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://besimplo.com/api/v1/events/{id}")
.header("Authorization", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://besimplo.com/api/v1/events/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"id": "evt_01h455vb4pex5vsknk084sn02e",
"object": "event",
"type": "invoice.paid",
"created": 1741541400,
"live_mode": true,
"data": {
"object": {
"id": "in_01h455vb4pex5vsknk084sn02q",
"object": "invoice",
"amount_due": 2990,
"amount_paid": 2990,
"amount_remaining": 0,
"created": 1741541000,
"currency": "brl",
"customer": "cus_01h455vb4pex5vsknk084sn02p",
"customer_email": "joao@acme.com",
"customer_name": "João Silva",
"external_code": null,
"live_mode": true,
"paid": true,
"payment_intent": "pi_01h455vb4pex5vsknk084sn02r",
"status": "paid",
"status_transitions": {
"paid_at": 1741541400
},
"subscription": "sub_01h455vb4pex5vsknk084sn02s",
"total": 2990
}
}
}Consultar evento
Devolve um evento pelo ID. A resposta é byte a byte o corpo que a entrega por webhook carregou, o que torna possível conferir o que você guardou contra o que a Simplo enviou.
Os eventos ficam disponíveis por 30 dias.
Limite de taxa: 100 requisições por minuto por chave de API.
curl --request GET \
--url https://besimplo.com/api/v1/events/{id} \
--header 'Authorization: <api-key>'import requests
url = "https://besimplo.com/api/v1/events/{id}"
headers = {"Authorization": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: '<api-key>'}};
fetch('https://besimplo.com/api/v1/events/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://besimplo.com/api/v1/events/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://besimplo.com/api/v1/events/{id}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://besimplo.com/api/v1/events/{id}")
.header("Authorization", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://besimplo.com/api/v1/events/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"id": "evt_01h455vb4pex5vsknk084sn02e",
"object": "event",
"type": "invoice.paid",
"created": 1741541400,
"live_mode": true,
"data": {
"object": {
"id": "in_01h455vb4pex5vsknk084sn02q",
"object": "invoice",
"amount_due": 2990,
"amount_paid": 2990,
"amount_remaining": 0,
"created": 1741541000,
"currency": "brl",
"customer": "cus_01h455vb4pex5vsknk084sn02p",
"customer_email": "joao@acme.com",
"customer_name": "João Silva",
"external_code": null,
"live_mode": true,
"paid": true,
"payment_intent": "pi_01h455vb4pex5vsknk084sn02r",
"status": "paid",
"status_transitions": {
"paid_at": 1741541400
},
"subscription": "sub_01h455vb4pex5vsknk084sn02s",
"total": 2990
}
}
}Authorizations
A chave de API usada para autenticar a requisição e identificar a sua conta.
Exemplo: Authorization: ApiKey my-secure-key
Path Parameters
ID do evento, no formato TypeID com prefixo evt_.
^evt_[0-9a-z]{26}$"evt_01h455vb4pex5vsknk084sn02e"
Response
Operação realizada com sucesso
ID do evento, no formato TypeID com prefixo evt_. É o mesmo valor do
cabeçalho webhook-id da entrega, e é a chave de idempotência: receber
o mesmo id duas vezes significa a mesma coisa que recebê-lo uma vez.
^evt_[0-9a-z]{26}$"evt_01h455vb4pex5vsknk084sn02e"
Tipo do objeto. Sempre 'event'.
event "event"
O que aconteceu.
- invoice.created: Fatura criada.
- invoice.paid: Fatura paga.
- invoice.uncollectible: Fatura dada como incobrável.
- invoice.voided: Fatura cancelada.
- payment_intent.created: Tentativa de cobrança criada.
- payment_intent.failed: Tentativa de cobrança falhou.
- payment_intent.attempts_exhausted: Sem novas tentativas de cobrança.
- payment_intent.refund_requested: Estorno solicitado.
- payment_intent.refunded: Estorno concluído.
- checkout_session.completed: Sessão de checkout concluída.
- checkout_session.expired: Sessão de checkout expirada.
- subscription.created: Assinatura criada.
- subscription.activated: Assinatura ativada pelo primeiro pagamento.
- subscription.overdue: Assinatura entrou em atraso.
- subscription.suspended: Assinatura suspensa após falhas de pagamento.
- subscription.reactivated: Assinatura voltou para a cobrança.
- subscription.canceled: Assinatura cancelada.
- subscription.period_started: Novo ciclo de cobrança iniciado.
invoice.created, invoice.paid, invoice.uncollectible, invoice.voided, payment_intent.created, payment_intent.failed, payment_intent.attempts_exhausted, payment_intent.refund_requested, payment_intent.refunded, checkout_session.completed, checkout_session.expired, subscription.created, subscription.activated, subscription.overdue, subscription.suspended, subscription.reactivated, subscription.canceled, subscription.period_started "invoice.paid"
Timestamp Unix do instante em que o fato aconteceu.
1741541400
Indica ambiente de produção (true) ou sandbox (false).
true
O recurso a que o evento se refere, no mesmo formato em que
GET /api/v1/<recurso>/{id} o devolve. Recursos relacionados aparecem
como IDs, não aninhados.
Show child attributes
Show child attributes

