Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.momentco.io/llms.txt

Use this file to discover all available pages before exploring further.

​
id
string

The unique identifier for the payment session.

Example:

"ps_kfAWZgfQIoeG0q"

​
type
enum<string>

The type of payment session (defaults to one_time):

  • one_time: A one-time payment where the customer is present in the flow and completes the payment. Optionally, the payment method can be saved for future use where the customer is present in the flow. For example, buying a product and optionally saving the card for later one-off purchases.
  • first_in_series: The first payment where the customer is present in the flow, representing the first payment in a series of future next_in_series payments where the payment method is saved for future use when the customer is not present in the flow. A mandate is recorded for compliance purposes. For example, setting up a subscription or installment plan for a product or service.
  • next_in_series: A subsequent payment where the customer is not present in the flow, representing the next payment in a series of payments, and is charged automatically using a saved payment method (payment_method_id) and the associated customer (customer_id). For example, the next payment on a subscription or installment plan for a product or service.
Available options:
one_time,
first_in_series,
next_in_series
​
amount
integer

The amount to be charged in the smallest currency unit. For example, 20.00 ZAR is represented as 2000 cents. Learn more about minor units.

Example:

1000

​
currency
string

The ISO 4217 currency code for the payment.

Example:

"ZAR"

​
status
enum<string>

The current status of the payment session.

  • active: The session is in progress. The customer is interacting with the payment flow or the payment (via session_url), or the payment is being processed programmitcally using a saved payment method. Dependendent on the payment session type.
  • completed: The session completed successfully.
  • expired: The session expired due to inactivity or a timeout.
  • cancelled: The session was cancelled by the customer or merchant.
Available options:
active,
completed,
expired,
cancelled
​
payment_status
enum<string>
deprecated

Deprecated. Use payment_outcome instead.

The status of the payment associated with the session:

  • paid: The payment succeeded.
  • unpaid: The payment failed or has not yet succeeded.
  • pending: The payment is still being processed and has not succeeded yet.
Available options:
paid,
unpaid,
pending
​
payment_outcome
enum<string>

The outcome of the payment associated with the session:

  • not_started: Payment has not been initiated. A draft payment object may exist but nothing is awaiting an outcome.
  • pending: Payment has been initiated and is awaiting a final outcome. May be waiting on customer action (for example, authentication, redirect, voucher) or provider confirmation (for example, bank, network, async settlement).
  • paid: Payment succeeded. Terminal.
  • unpaid: Payment failed, expired, or was cancelled. Terminal.
  • reserved: Funds were authorised successfully and are reserved on the payment method. Applies to capture_method: manual flows. The session outcome remains reserved even after subsequent capture or void operations, which are tracked on the underlying payment resource.
  • payment_method_verified: No payment was taken. Payment method was verified and vaulted via a supported amount: 0 one_time or first_in_series session. Terminal. Only applicable when amount: 0 on those supported session types.
Available options:
not_started,
pending,
paid,
unpaid,
reserved,
payment_method_verified
​
customer_id
string

The ID of the customer associated with the payment session.

​
payment_method_id
string

The ID of the saved payment method for a customer associated with this payment session.

​
checkout_session_id
null | string

The ID of the associated checkout session (for one_time or first_in_series types).

Example:

"chk_456789abc123def"

​
payment_id
string

Unique identifier for a payment

Example:

"p_xyz789abc123def456"

​
session_url
string<uri>

The URL where the customer is redirected to complete their payment in a secure payment flow. The customer can choose from a list of available payment methods, complete the payment, and is returned to the return_url once the session is complete.

  • Only returned for one_time and first_in_series types where where the customer is present in the flow and needs to complete the payment.
  • Not returned for subsequent payments where the customer is not present in the flow, and payment is completed automatically.
Example:

"https://moment.dev.momentpay.io/checkout/cktNnkWtk7p5GJd85"

​
return_url
string<uri>

The URL where the customer that is present in the payment flow is redirected to after completing the payment. Only applicable to one_time and first_in_series payment session types where the customer is present in the flow. The customer is typically redirected on success, cancellation or expiration.

Example:

"https://callback.merchant-shop.com"

​
last_payment_error
Last Payment Error · object

Details of last error that occurred during a payment attempt.

​
mode
enum<string>

Indicates whether the payment session is in live or test mode:

  • test: Used for testing and development. Payments are simulated, and no real transactions are processed. You can use test credit cards and accounts to ensure your integration works as expected before going live.
  • live: Used in production to process real payments. Real credit cards and accounts are used, and actual transactions occur. This mode is for accepting real money from customers.
Available options:
live,
test
​
external_reference
string

External reference for reconciliation or tracking purposes. Must be unique within your merchant account.

Maximum string length: 255
Pattern: ^[a-zA-Z0-9_-]+$
Example:

"INV-2024-001"

​
metadata
object

Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format. NEW Limitations:

  • Maximum 20 keys
  • Key names must be strings (max 40 characters)
  • Values must be strings (max 500 characters)
Example:
{
  "customer_id": "cust_123456",
  "order_id": "ord_789012"
}
​
created_at
string<date-time>

ISO 8601 timestamp when the resource was created

Example:

"2025-06-16T10:30:00Z"

​
updated_at
string<date-time>

ISO 8601 timestamp when the resource was last updated

Example:

"2025-06-16T10:30:00Z"