Skip to main content

A payment page represents a configurable payment collection interface that can be shared with customers.

​
id
string

Unique identifier for a payment page

Example:

"pp_SjSA234ADKA25245ADJKS"

​
status
enum<string>
default:active

Status of a payment page

Available options:
active,
inactive,
expired
Example:

"active"

​
page_url
string<uri>

The URL where customers can access the payment page

Example:

"https://pages.momentpay.io/PLSST12FWF"

​
amount
integer

Fixed amount for the payment page (null if variable amount/catalog support) 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"

​
title
string

Title displayed on the payment page

Maximum length: 200
Example:

"My Shop"

​
description
string

Description displayed on the payment page

Maximum length: 1000
Example:

"High-quality cotton t-shirt with custom design"

​
return_url
string<uri>

(Optional) The URL to redirect the customer to when they press the back button on the payment page. If this field is not supplied, the back button will be hidden. Must be a valid HTTPS URL.

Maximum length: 500
Example:

"https://store.com/home"

​
requires_customer_details
boolean
default:true

Indicates whether the payment page should explicitly require customer details. By default, the page collects the customer's name, email, and phone number. This flag can be set to false to hide or skip these fields if not needed.

Example:

true

​
requires_delivery_details
boolean
default:false

Indicates whether delivery details (e.g., shipping address) are required for this payment page.

Example:

true

​
products
string[]

List of product identifiers linked to this payment page. The Product identifiers are fetched from the catalog.

​
custom_fields
object[]

Custom fields for collecting additional information

​
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 10 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"