List events
curl --request GET \
--url https://api-beta.pepay.io/api/v1/events \
--header 'x-api-key: <api-key>'import requests
url = "https://api-beta.pepay.io/api/v1/events"
headers = {"x-api-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};
fetch('https://api-beta.pepay.io/api/v1/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-beta.pepay.io/api/v1/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 => [
"x-api-key: <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://api-beta.pepay.io/api/v1/events"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("x-api-key", "<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://api-beta.pepay.io/api/v1/events")
.header("x-api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api-beta.pepay.io/api/v1/events")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"success": true,
"data": {
"object": "list",
"data": [
{
"id": "evt_1700000000000-123",
"object": "event",
"api_version": "2025-12-16",
"created": 1700000000,
"type": "invoice.updated",
"livemode": false,
"pending_webhooks": 0,
"request": {
"id": "<string>",
"idempotency_key": "<string>"
},
"data": {
"object": {
"object": "invoice",
"id": "550e8400-e29b-41d4-a716-446655440000",
"merchant_id": 123,
"status": "paid",
"invoice_type": "standard",
"currency": "usd",
"amount": 10000,
"amount_decimal": "10.000",
"amount_paid": 10000,
"amount_paid_decimal": "10.000",
"amount_remaining": 0,
"amount_remaining_decimal": "0.000",
"amount_unit": "usd_millis",
"customer_id": "<string>",
"payer_wallet_address": "<string>",
"payer_wallet_network": "<string>",
"commerce_order_id": "<string>",
"expires_at": 123,
"created_at": 123,
"paid_at": 123,
"last_payment_at": 123,
"metadata": {}
},
"previous_attributes": {}
}
}
],
"has_more": false
}
}Merchant
List events
Returns canonical PepayEvent objects produced by the unified outbox/dispatcher.
Ordering:
- Newest first.
Pagination:
- Use
starting_afterto fetch older events. - Use
ending_beforeto fetch newer events.
Scoping:
x-api-keyreturns events for the merchant account (including commerce invoices when applicable).- Commerce-scoped keys restrict results to commerce-related events in the key’s environment.
x-commerce-api-keyis a legacy alias for commerce-scoped keys.
GET
/
api
/
v1
/
events
List events
curl --request GET \
--url https://api-beta.pepay.io/api/v1/events \
--header 'x-api-key: <api-key>'import requests
url = "https://api-beta.pepay.io/api/v1/events"
headers = {"x-api-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};
fetch('https://api-beta.pepay.io/api/v1/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-beta.pepay.io/api/v1/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 => [
"x-api-key: <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://api-beta.pepay.io/api/v1/events"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("x-api-key", "<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://api-beta.pepay.io/api/v1/events")
.header("x-api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api-beta.pepay.io/api/v1/events")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"success": true,
"data": {
"object": "list",
"data": [
{
"id": "evt_1700000000000-123",
"object": "event",
"api_version": "2025-12-16",
"created": 1700000000,
"type": "invoice.updated",
"livemode": false,
"pending_webhooks": 0,
"request": {
"id": "<string>",
"idempotency_key": "<string>"
},
"data": {
"object": {
"object": "invoice",
"id": "550e8400-e29b-41d4-a716-446655440000",
"merchant_id": 123,
"status": "paid",
"invoice_type": "standard",
"currency": "usd",
"amount": 10000,
"amount_decimal": "10.000",
"amount_paid": 10000,
"amount_paid_decimal": "10.000",
"amount_remaining": 0,
"amount_remaining_decimal": "0.000",
"amount_unit": "usd_millis",
"customer_id": "<string>",
"payer_wallet_address": "<string>",
"payer_wallet_network": "<string>",
"commerce_order_id": "<string>",
"expires_at": 123,
"created_at": 123,
"paid_at": 123,
"last_payment_at": 123,
"metadata": {}
},
"previous_attributes": {}
}
}
],
"has_more": false
}
}Authorizations
merchantApiKeycommerceApiKeybearerAuth
API key for server-to-server operations (scope=merchant or commerce)
Query Parameters
Comma-separated list of event types (supports wildcards like invoice.*)
Example:
50
Available options:
devnet, mainnet Was this page helpful?
⌘I

