Skip to content
Paymee Developers

List webhook deliveries for a session

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

List the most recent webhook delivery attempts for a single payment session.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
session_id
required
string

Prefixed public id of the payment session (e.g. ps_...).

Responses

Section titled “Responses”

200

Section titled “200”
Media typeapplication/json

Webhook deliveries for a single payment session (most recent first).

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
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"
}

404

Section titled “404”

The payment session does not exist for this merchant account.

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"
}

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"
}