GET
/
collect
/
payment_sessions
/
{id}
Retrieve a payment session
curl --request GET \
  --url https://api.momentco.io/collect/payment_sessions/{id} \
  --header 'Authorization: Bearer <token>'
{
  "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": "pl_6phg74i4jG9wbzZbFDUQB",
  "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"
}

Authorizations

​
Authorization
string
header
required

Authentication using Bearer tokens. Include your API key in the Authorization header.

Key Types:

  • Test Keys: sk_test_* for development and testing
  • Live Keys: sk_* for production environments
  • Public Keys: pk_test_* or pk_* for client-side operations

📩 Need access? Contact Support to request your API keys.

Usage:

Authorization: Bearer sk_test_4eC39HqLyjWDarjtT1zdp7dc

Path Parameters

​
id
string
required

The unique identifier for the payment session.

Response

200
application/json

Payment session retrieved

The response is of type object.