Retrieve an event
curl --request GET \
--url https://api-dashboard.payra.com/v1/events/{id} \
--header 'Authorization: Bearer <token>'import requests
url = "https://api-dashboard.payra.com/v1/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-dashboard.payra.com/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://api-dashboard.payra.com/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: 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-dashboard.payra.com/v1/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-dashboard.payra.com/v1/events/{id}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api-dashboard.payra.com/v1/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{
"object": "event",
"id": "evt_test_7Hs2kQ9mL1pXv4cR8tWzAbCdEf",
"type": "payment.succeeded",
"created_at": "2026-09-19T21:04:11.000Z",
"livemode": false,
"data": {
"object": {
"object": "payment",
"id": "pay_test_7Hs2kQ9mL1pXv4cR8tWzAbCdEf",
"status": "succeeded",
"amount": 12550,
"currency": "USD",
"payment_method": "pm_test_9kQ2mL7Hs1pXv4cR8tWzAbCdEf",
"customer": null,
"description": "Invoice INV-1042",
"reference": "INV-1042",
"card": {
"brand": "visa",
"last4": "4242",
"exp_month": 12,
"exp_year": 2030
},
"failure": {
"code": "card_declined",
"message": "The card was declined."
},
"next_action": null,
"livemode": false,
"created_at": "2026-09-18T20:00:00.000Z",
"succeeded_at": "2026-09-18T20:00:01.312Z",
"amount_refunded": 0,
"payment_method_type": "card",
"us_bank_account": null
}
},
"deliveries": [
{
"endpoint": "we_test_4kQ2mL7Hs1pXv4cR8tWzAbCdEf",
"status": "succeeded",
"origin": "emit",
"attempt_count": 1,
"last_attempt_at": "<string>",
"next_attempt_at": "<string>",
"last_response_status": 200,
"last_error": null,
"created_at": "<string>"
}
]
}{
"error": {
"type": "invalid_request_error",
"code": "<string>",
"message": "<string>",
"request_id": "<string>",
"param": "<string>"
}
}{
"error": {
"type": "invalid_request_error",
"code": "<string>",
"message": "<string>",
"request_id": "<string>",
"param": "<string>"
}
}{
"error": {
"type": "invalid_request_error",
"code": "<string>",
"message": "<string>",
"request_id": "<string>",
"param": "<string>"
}
}{
"error": {
"type": "invalid_request_error",
"code": "<string>",
"message": "<string>",
"request_id": "<string>",
"param": "<string>"
}
}{
"error": {
"type": "invalid_request_error",
"code": "<string>",
"message": "<string>",
"request_id": "<string>",
"param": "<string>"
}
}Webhooks
Retrieve an event
The event and its delivery log: one entry per endpoint, with every attempt counted.
GET
/
events
/
{id}
Retrieve an event
curl --request GET \
--url https://api-dashboard.payra.com/v1/events/{id} \
--header 'Authorization: Bearer <token>'import requests
url = "https://api-dashboard.payra.com/v1/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-dashboard.payra.com/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://api-dashboard.payra.com/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: 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-dashboard.payra.com/v1/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-dashboard.payra.com/v1/events/{id}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api-dashboard.payra.com/v1/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{
"object": "event",
"id": "evt_test_7Hs2kQ9mL1pXv4cR8tWzAbCdEf",
"type": "payment.succeeded",
"created_at": "2026-09-19T21:04:11.000Z",
"livemode": false,
"data": {
"object": {
"object": "payment",
"id": "pay_test_7Hs2kQ9mL1pXv4cR8tWzAbCdEf",
"status": "succeeded",
"amount": 12550,
"currency": "USD",
"payment_method": "pm_test_9kQ2mL7Hs1pXv4cR8tWzAbCdEf",
"customer": null,
"description": "Invoice INV-1042",
"reference": "INV-1042",
"card": {
"brand": "visa",
"last4": "4242",
"exp_month": 12,
"exp_year": 2030
},
"failure": {
"code": "card_declined",
"message": "The card was declined."
},
"next_action": null,
"livemode": false,
"created_at": "2026-09-18T20:00:00.000Z",
"succeeded_at": "2026-09-18T20:00:01.312Z",
"amount_refunded": 0,
"payment_method_type": "card",
"us_bank_account": null
}
},
"deliveries": [
{
"endpoint": "we_test_4kQ2mL7Hs1pXv4cR8tWzAbCdEf",
"status": "succeeded",
"origin": "emit",
"attempt_count": 1,
"last_attempt_at": "<string>",
"next_attempt_at": "<string>",
"last_response_status": 200,
"last_error": null,
"created_at": "<string>"
}
]
}{
"error": {
"type": "invalid_request_error",
"code": "<string>",
"message": "<string>",
"request_id": "<string>",
"param": "<string>"
}
}{
"error": {
"type": "invalid_request_error",
"code": "<string>",
"message": "<string>",
"request_id": "<string>",
"param": "<string>"
}
}{
"error": {
"type": "invalid_request_error",
"code": "<string>",
"message": "<string>",
"request_id": "<string>",
"param": "<string>"
}
}{
"error": {
"type": "invalid_request_error",
"code": "<string>",
"message": "<string>",
"request_id": "<string>",
"param": "<string>"
}
}{
"error": {
"type": "invalid_request_error",
"code": "<string>",
"message": "<string>",
"request_id": "<string>",
"param": "<string>"
}
}Authorizations
A secret key, sk_test_... or sk_live_...; a publishable key (pk_...) on the browser routes only
Path Parameters
Required string length:
1 - 64Response
The event with its deliveries
Available options:
event Example:
"evt_test_7Hs2kQ9mL1pXv4cR8tWzAbCdEf"
Available options:
payment.processing, payment.authorized, payment.succeeded, payment.failed, payment.canceled, payment.returned, refund.pending, refund.succeeded, refund.failed, checkout_session.completed, checkout_session.expired Example:
"payment.succeeded"
When the object reached this state: by the ledger for a payment or a refund, by the session for a checkout session.
Example:
"2026-09-19T21:04:11.000Z"
Example:
false
Show child attributes
Show child attributes
One per endpoint the event was sent to, oldest first.
Show child attributes
Show child attributes