Checkout Pages API — List and Retrieve Checkout Pages

Checkout pages are the hosted payment forms you create in Nova.Pay. Each page can carry one or more products, accept multiple payment methods, and be customised with your brand colours and logo. The endpoints below let you programmatically list your pages, fetch their full configuration, and inspect the payments that have been made through them. Base URL: https://pay.nova.money/api/v1

List checkout pages

Authentication is required for all checkout-page endpoints. Pass your API key in the Authorization header as a Bearer token.

Retrieve a paginated list of your checkout pages. You can narrow the results with the optional query parameters below.

GET /checkout_pages

Query parameters

string

Free-text search string. Matches against the page title and other indexed fields.

has_products

boolean

When true, only returns pages that have at least one product attached. When false, returns pages with no products.

product_ids

array of integers

Filter pages to only those that include any of the specified product IDs. Pass multiple values as repeated query params: product_ids[]=1&product_ids[]=2.

Response

Returns an array of CheckoutPageSummary objects.

curl --request GET \
  --url "https://pay.nova.money/api/v1/checkout_pages?has_products=true" \
  --header "Authorization: Bearer YOUR_API_KEY"

Example response

[
  {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "page_title": "Summer Sale Checkout",
    "main_color": "#6366f1",
    "currency": "BRL",
    "gateway": "stripe",
    "public_key": "pk_live_xxxxxxxxxxxx",
    "subscription": false,
    "enable_coupons": true,
    "company_id": 42
  }
]

Retrieve a checkout page

Fetch the full configuration for a single checkout page by its UUID.

GET /checkout_pages/{id}

Path parameters

string

required

The UUID of the checkout page.

Response

Returns a CheckoutPageShow object, which extends CheckoutPageSummary with the full set of fields listed below.

string (uuid)

Unique identifier for the checkout page.

customer_data_at

string

Specifies at which step of the checkout flow customer data is collected. Typical values are "start" or "end".

gateway

string

The payment gateway configured for this page (e.g. "stripe", "pagarme").

main_color

string

Hex colour code used as the primary brand colour on the hosted page.

page_title

string

The display title shown to customers on the checkout page.

logo

string

URL of the logo image displayed on the checkout page.

currency

string

ISO 4217 currency code (e.g. "BRL", "USD").

menus

array

Navigation menu items configured for the page.

public_key

string

The gateway public key used to tokenise card data on the client side.

subscription

boolean

Whether the checkout page is configured for recurring / subscription billing.

enable_coupons

boolean

Whether coupon code entry is enabled on this page.

index_on_search_engines

boolean

When true, the hosted page allows indexing by search engine crawlers.

require_scheduling

boolean

When true, the customer must select a scheduled date before completing checkout.

enable_two_cards

boolean

When true, the customer may split the payment across two credit cards.

company_id

integer

ID of the Nova.Pay company that owns this checkout page.

upsell_product

object

An optional product offered as an upsell after the main purchase.

Show upsell_product fields

integer

Product ID.

name

string

Product name.

custom_code

string

Arbitrary HTML/JS snippet injected into the hosted page (e.g. tracking pixels).

default_payment_plan

object

The pre-selected payment plan shown to the customer on page load.

Show default_payment_plan fields

string

Payment plan ID (e.g. "42-1").

name

string

Human-readable label.

payment_method

string

Payment method for this plan.

integrations

object

Third-party integration configuration (webhooks, analytics, CRM connections, etc.).

products

array

The products attached to this checkout page.

Show Product fields

integer

Internal product ID.

uid

string

Public-facing unique identifier for the product.

name

string

Product name.

description

string

Product description shown to customers.

product_type

string

Category of the product (e.g. "digital", "physical").

subscription

boolean

Whether the product is sold as a subscription.

type

string

Product billing type.

interval

string

Recurrence interval for subscriptions (e.g. "monthly").

max_quantity

integer

Maximum number of units a customer can purchase.

value

number

Unit price of the product.

image

string

URL of the product image.

allow_quantity

boolean

Whether the customer can choose a quantity greater than one.

recommended

boolean

Whether this product is highlighted as recommended.

List payments for a checkout page

Returns all payments submitted through a given checkout page.

GET /checkout_pages/{id}/payments

Path parameters

string

required

The UUID of the checkout page.

Query parameters

ids

array

Filter the results to specific payments. Each value may be either a gateway_id (e.g. "pay_abc123") or an internal payment ID. Pass multiple values as repeated query params: ids[]=pay_abc123&ids[]=pay_def456.

Response

Returns an array of PaymentStatus objects, or HTTP 204 No Content if no payments have been made through this page yet.

Example response

[
  {
    "gateway_id": "pay_abc123",
    "status": "paid"
  },
  {
    "gateway_id": "pay_def456",
    "status": "waiting_payment"
  }
]

gateway_id

string

The payment identifier issued by the gateway (e.g. a Stripe PaymentIntent ID).

status

string

Current status of the payment. Common values: paid, waiting_payment, failed, cancelled.

Checkout

Payments

Management

Webhooks

Checkout Pages API — List and Retrieve Checkout Pages

List checkout pages

Query parameters

Response

Retrieve a checkout page

Path parameters

Response

List payments for a checkout page

Path parameters

Query parameters

Response

​List checkout pages

​Query parameters

​Response

​Retrieve a checkout page

​Path parameters

​Response

​List payments for a checkout page

​Path parameters

​Query parameters

​Response

List checkout pages

Query parameters

Response

Retrieve a checkout page

Path parameters

Response

List payments for a checkout page

Path parameters

Query parameters

Response