List Events V2
curl --request GET \
--url https://api.spherepay.co/v2/events \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.spherepay.co/v2/events"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.spherepay.co/v2/events', 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://api.spherepay.co/v2/events",
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: Bearer <token>"
],
]);
$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://api.spherepay.co/v2/events"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.spherepay.co/v2/events")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.spherepay.co/v2/events")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"data": [
{
"createdAt": "2026-01-01T00:00:00.000Z",
"delivery": {
"attemptsUsed": 1,
"deliveredAt": "2026-01-01T00:05:00.000Z",
"id": "eventDelivery_a1b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6",
"latestAttempt": {
"responseCode": 200,
"success": true,
"type": "original"
},
"status": "delivered",
"webhookEndpointId": "webhook_a1b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6"
},
"id": "event_a1b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6",
"sequence": 3,
"type": "transfer.succeeded"
}
],
"hasNext": false,
"hasPrevious": false,
"limit": 10,
"page": 1,
"total": 1,
"totalPages": 1
}{
"code": "address/invalid",
"correlationId": "28c61e885c6e5eaa78c1a2183a9b883c",
"detail": "Invalid request parameters",
"status": 400
}{
"code": "resource/not-found",
"correlationId": "28c61e885c6e5eaa78c1a2183a9b883c",
"detail": "Resource not found",
"status": 404
}{
"code": "validation/failed",
"correlationId": "28c61e885c6e5eaa78c1a2183a9b883c",
"detail": "Validation failed",
"errors": [
{
"detail": "Invalid email format",
"pointer": "/email"
},
{
"detail": "Name is required",
"pointer": "/name"
}
],
"status": 422
}Eventos
Listar Eventos e seu Status de Entrega
List events for the authenticated application, with optional filtering by webhook endpoint, event type, delivery status, and creation date range.
List Events V2
curl --request GET \
--url https://api.spherepay.co/v2/events \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.spherepay.co/v2/events"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.spherepay.co/v2/events', 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://api.spherepay.co/v2/events",
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: Bearer <token>"
],
]);
$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://api.spherepay.co/v2/events"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.spherepay.co/v2/events")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.spherepay.co/v2/events")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"data": [
{
"createdAt": "2026-01-01T00:00:00.000Z",
"delivery": {
"attemptsUsed": 1,
"deliveredAt": "2026-01-01T00:05:00.000Z",
"id": "eventDelivery_a1b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6",
"latestAttempt": {
"responseCode": 200,
"success": true,
"type": "original"
},
"status": "delivered",
"webhookEndpointId": "webhook_a1b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6"
},
"id": "event_a1b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6",
"sequence": 3,
"type": "transfer.succeeded"
}
],
"hasNext": false,
"hasPrevious": false,
"limit": 10,
"page": 1,
"total": 1,
"totalPages": 1
}{
"code": "address/invalid",
"correlationId": "28c61e885c6e5eaa78c1a2183a9b883c",
"detail": "Invalid request parameters",
"status": 400
}{
"code": "resource/not-found",
"correlationId": "28c61e885c6e5eaa78c1a2183a9b883c",
"detail": "Resource not found",
"status": 404
}{
"code": "validation/failed",
"correlationId": "28c61e885c6e5eaa78c1a2183a9b883c",
"detail": "Validation failed",
"errors": [
{
"detail": "Invalid email format",
"pointer": "/email"
},
{
"detail": "Name is required",
"pointer": "/name"
}
],
"status": 422
}Use este endpoint para recuperar uma lista paginada dos eventos que o SpherePay registrou para a sua aplicação. Todo evento é consultável, tenha a entrega sido bem-sucedida ou não, portanto esta é a trilha de auditoria por trás do seu tráfego de webhooks. Filtre por
type (um nome exato, um curinga de recurso como transfer.*, ou *), pelo status de entrega, por webhookEndpointId e pelos limites createdStart e createdEnd sobre o horário de criação.
Cada item resume o evento junto com sua entrega mais recente, incluindo a contagem de tentativas e a resposta que seu endpoint retornou.
Filtre por
status=failed para encontrar tudo que precisa de atenção. Um responseCode igual a null significa que seu endpoint não respondeu de forma alguma — um timeout ou erro de rede, e não um erro HTTP.Autorizações
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Parâmetros de consulta
object
obrigatório
Show child attributes
Show child attributes
Resposta
A paginated list of events.
Array of event presentations
Show child attributes
Show child attributes
Whether there is a next page
Exemplo:
false
Whether there is a previous page
Exemplo:
false
Number of items per page
Intervalo obrigatório:
1 < x < 100Exemplo:
10
Current page number
Exemplo:
1
Total number of items
Exemplo:
1
Total number of pages
Exemplo:
1
Última modificação em 27 de agosto de 2026