Skip to content
Paymee Developers

List payment sessions

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

List the merchant account’s payment sessions, newest first, with cursor pagination.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Query Parameters

Section titled “Query Parameters”
ending_before
string

Return sessions created after this session id (backward pagination).

limit
integer

Page size (default 20, max 100).

starting_after
string

Return sessions created before this session id (forward pagination).

Responses

Section titled “Responses”

200

Section titled “200”
Media typeapplication/json

Cursor-paginated list of payment sessions.

object
data
required
Array<object>

Lightweight serializer for session list endpoint.

object
id
required
string
merchant_reference
required

Merchant-provided unique reference for idempotency

string
<= 200 characters
order_number
required

System-generated order number (PM-XXXXXX)

string
<= 10 characters
order_id
Merchant order ID

Merchant’s display-friendly order ID (separate from merchant_reference)

string
<= 100 characters
amount
required
string
currency
string
<= 3 characters
original
required
object
amount
required

Requested amount, as a decimal string at the requested currency’s precision.

string
currency
required

Requested ISO 4217 currency code.

string
rate
required

Exchange rate applied (1 original.currency = rate currency), six decimals. “1.000000” when no conversion.

string
status
  • CREATED - Created
  • PENDING - Pending
  • PROCESSING - Processing
  • SUCCEEDED - Succeeded
  • FAILED - Failed
  • EXPIRED - Expired
  • CANCELED - Canceled
string
Allowed values: CREATED PENDING PROCESSING SUCCEEDED FAILED EXPIRED CANCELED
livemode
required
boolean
buyer
required
object
first_name
required
string
last_name
required
string
email
required
string
phone
required
string
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": "CREATED"
    }
  ]
}

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