Payment Session object

string

Example:

type

enum<string>

Available options:

one_time,

first_in_series,

next_in_series

amount

integer

Example:

currency

string

Example:

status

enum<string>

Available options:

active,

completed,

expired,

cancelled

payment_status

enum<string>

Available options:

paid,

unpaid

customer_id

string

payment_method_id

string

checkout_session_id

string | null

Example:

payment_id

string

Example:

session_url

string<uri>

Example:

return_url

string<uri>

Example:

last_payment_error

object

Show child attributes

mode

enum<string>

Available options:

live,

test

external_reference

string

Maximum length: 255

Example:

metadata

object

Example:

created_at

string<date-time>

Example:

updated_at

string<date-time>

Example:

Create a Payment SessionCreate a payment session

⌘I

{
  "id": "ps_kfAWZgfQIoeG0q",
  "type": "one_time",
  "amount": 1000,
  "currency": "ZAR",
  "status": "active",
  "payment_status": "paid",
  "customer_id": "<string>",
  "payment_method_id": "<string>",
  "checkout_session_id": "chk_456789abc123def",
  "payment_id": "p_xyz789abc123def456",
  "session_url": "https://moment.dev.momentpay.io/checkout/cktNnkWtk7p5GJd85",
  "return_url": "https://callback.merchant-shop.com",
  "last_payment_error": {
    "error_code": "<string>",
    "decline_code": "<string>",
    "message": "General Error",
    "timestamp": "2023-11-07T05:31:56Z"
  },
  "mode": "live",
  "external_reference": "INV-2024-001",
  "metadata": {
    "customer_id": "cust_123456",
    "order_id": "ord_789012"
  },
  "created_at": "2025-06-16T10:30:00Z",
  "updated_at": "2025-06-16T10:30:00Z"
}

Collect

Billing

Technical Guides