Get an Event V2
curl --request GET \
--url https://api.spherepay.co/v2/events/{id} \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.spherepay.co/v2/events/{id}"
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/{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://api.spherepay.co/v2/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: 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/{id}"
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/{id}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.spherepay.co/v2/events/{id}")
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{
"attempts": [
{
"attemptedAt": "2026-01-01T00:05:00.000Z",
"id": "atmpt_a1b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6",
"latencyMs": 128,
"responseBody": "OK",
"responseCode": 200,
"success": true,
"type": "original"
}
],
"createdAt": "2026-01-01T00:00:00.000Z",
"deliveries": [
{
"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"
}{
"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
Recuperar um Evento com o Histórico Completo de Entregas
Retrieve an event by its ID.
Get an Event V2
curl --request GET \
--url https://api.spherepay.co/v2/events/{id} \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.spherepay.co/v2/events/{id}"
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/{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://api.spherepay.co/v2/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: 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/{id}"
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/{id}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.spherepay.co/v2/events/{id}")
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{
"attempts": [
{
"attemptedAt": "2026-01-01T00:05:00.000Z",
"id": "atmpt_a1b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6",
"latencyMs": 128,
"responseBody": "OK",
"responseCode": 200,
"success": true,
"type": "original"
}
],
"createdAt": "2026-01-01T00:00:00.000Z",
"deliveries": [
{
"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"
}{
"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 um evento junto com cada entrega e cada tentativa feita para ele. Cada tentativa registra se foi um
Para reenviar uma entrega listada no histórico, veja reenviar uma entrega de evento com falha.
original ou um replay, quando foi executada, se teve êxito, o código de resposta, o corpo da resposta (truncado em 200 caracteres e capturado nas falhas) e a latência.
O header
Sphere-Delivery-Id de uma entrega que você recebeu é o ID daquela entrega, portanto você pode usá-lo para relacionar uma requisição que chegou aos seus servidores com os registros de entrega e tentativas mostrados aqui.Autorizações
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Parâmetros de caminho
Resposta
The requested event, with its deliveries and delivery attempts.
Delivery attempts across the deliveries of this event
Show child attributes
Show child attributes
ISO 8601 timestamp when the event was created.
Exemplo:
"2026-01-01T00:00:00.000Z"
Deliveries of this event, one per subscribed endpoint
Show child attributes
Show child attributes
The unique identifier of the event.
Exemplo:
"event_a1b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6"
Monotonically increasing sequence number for ordering events, or null if not assigned.
Exemplo:
3
The type of the event.
Opções disponíveis:
*, customer.*, transfer.*, document.*, service.*, customer.created, customer.pending, customer.approved, customer.rejected, transfer.created, transfer.pendingFunding, transfer.pendingReview, transfer.fundsReceived, transfer.processing, transfer.succeeded, transfer.returned, transfer.pendingRefundInformation, transfer.failed, transfer.canceled, transfer.refunded, transfer.unexpectedError, transfer.failedPrecondition, transfer.expired, transfer.unfunded, document.pending, document.processing, document.verified, document.rejected, service.pending, service.processing, service.succeeded, service.failed, service.cancelled Exemplo:
"transfer.succeeded"
Última modificação em 27 de agosto de 2026