Skip to content
Paymee Developers

List webhook deliveries

GET
/gateway/webhooks/
curl --request GET \
  --url https://api.paymee.online/api/v1/gateway/webhooks/ \
  --header 'Authorization: Bearer <token>'

List the merchant account’s webhook delivery attempts, newest first, with cursor pagination.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Query Parameters

Section titled “Query Parameters”
limit
integer

Page size (default 20, max 100).

starting_after
string

Return deliveries created before this delivery id (forward pagination).

Responses

Section titled “Responses”

200

Section titled “200”
Media typeapplication/json

Cursor-paginated list of webhook deliveries for the account.

object
data
required
Array<object>

Serializer for merchant webhook delivery history.

object
id
required
string
session_id
required
string
event
required
Event type

E.g. session.succeeded, session.failed

string
<= 50 characters
event_id

Stable ID shared across retries for merchant deduplication

string
<= 64 characters
url
required
Webhook URL
string format: uri
<= 2048 characters
attempt_number
integer
<= 2147483647
status
  • PENDING - Pending
  • SUCCEEDED - Succeeded
  • FAILED - Failed
string
Allowed values: PENDING SUCCEEDED FAILED
http_status_code
integer | null
<= 2147483647
response_time_ms
Response time (ms)
integer | null
<= 2147483647
error_message
string
next_retry_at

Scheduled time for next retry attempt

string | null format: date-time
created_at
required
string format: date-time
has_more
required

True when more results exist past this page (use the last id as starting_after).

boolean
Example
{
  "data": [
    {
      "status": "PENDING"
    }
  ]
}

401

Section titled “401”

Missing, malformed, expired, or revoked API key.

Media typeapplication/problem+json

RFC 9457 problem detail body (application/problem+json).

object
type
required

URI identifying the error type.

string format: uri
title
required

Short, human-readable summary of the error type.

string
status
required

HTTP status code.

integer
detail
required

Human-readable explanation specific to this occurrence.

string
Examplegenerated
{
  "type": "https://example.com",
  "title": "example",
  "status": 1,
  "detail": "example"
}

422

Section titled “422”

A field failed validation (errors lists them), or a business rule refused the request (the type says which).

Media typeapplication/problem+json

Problem detail of a 422: a per-field errors array when fields failed validation; no errors when a business rule refused the request (the type says which).

object
type
required

URI identifying the error type.

string format: uri
title
required

Short, human-readable summary of the error type.

string
status
required

HTTP status code.

integer
detail
required

Human-readable explanation specific to this occurrence.

string
errors
Array<object>

A single field-level validation error inside a problem+json body.

object
field
required

Name of the field that failed validation.

string
code
required

Machine-readable error code, e.g. ‘required’.

string
message
required

Human-readable description of the failure.

string
Examplegenerated
{
  "type": "https://example.com",
  "title": "example",
  "status": 1,
  "detail": "example",
  "errors": [
    {
      "field": "example",
      "code": "example",
      "message": "example"
    }
  ]
}

429

Section titled “429”

Rate limit exceeded. Wait the number of seconds in the Retry-After header.

Media typeapplication/problem+json

RFC 9457 problem detail body (application/problem+json).

object
type
required

URI identifying the error type.

string format: uri
title
required

Short, human-readable summary of the error type.

string
status
required

HTTP status code.

integer
detail
required

Human-readable explanation specific to this occurrence.

string
Examplegenerated
{
  "type": "https://example.com",
  "title": "example",
  "status": 1,
  "detail": "example"
}

500

Section titled “500”

Unexpected error; nothing was changed. Safe to retry with backoff.

Media typeapplication/problem+json

RFC 9457 problem detail body (application/problem+json).

object
type
required

URI identifying the error type.

string format: uri
title
required

Short, human-readable summary of the error type.

string
status
required

HTTP status code.

integer
detail
required

Human-readable explanation specific to this occurrence.

string
Examplegenerated
{
  "type": "https://example.com",
  "title": "example",
  "status": 1,
  "detail": "example"
}