Skip to main content
GET
/
checkout
List payment links
curl --request GET \
  --url https://api.sbx.moduluslabs.io/ecom/v1/checkout \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "merchant_branch_reference_number": "SH-ANG-001",
      "merchant_branch_name": "SM City Angeles - Branch 1",
      "currency": "PHP",
      "amount": 150000,
      "line_items": [
        {
          "sku": "PROD-001",
          "name": "Wireless Earbuds",
          "unit_price": 75000,
          "quantity": 2,
          "metadata": {}
        }
      ],
      "expires_at": "2026-07-18T00:00:00Z",
      "hosted_url": "https://pay.moduluslabs.io/checkout/550e8400-e29b-41d4-a716-446655440000",
      "successful_payment_count": 3,
      "metadata": {},
      "created_at": "2026-06-18T10:30:00Z",
      "updated_at": "2026-06-18T14:22:00Z",
      "description": "Order for wireless earbuds",
      "order_reference": "ORD-2026-0618-001",
      "redirect_urls": {
        "success": "https://merchant.com/payment/success",
        "declined": "https://merchant.com/payment/declined",
        "expired": "https://merchant.com/payment/expired"
      },
      "max_uses": 10,
      "cancelled_at": "2023-11-07T05:31:56Z",
      "cancellation_reason": "<string>"
    }
  ],
  "pagination": {
    "page_size": 20,
    "has_more": true,
    "next_cursor": "Y3JlYXRlZF9hdHwxNzE4NzA0MjAwMDAwfDE5"
  }
}
Results are returned in the data array with a pagination object. Links are scoped automatically to your API key’s entity level.

​
Filtering

ParameterDescription
statusACTIVE, CONSUMED, EXPIRED, or CANCELLED
merchant_branch_reference_numberFilter by branch. Only applicable for partner- or merchant-level keys.
created_after / created_beforeISO 8601 timestamps to bound the creation window

​
Cursor pagination

To fetch the next page, pass the next_cursor value from the previous response as the cursor query parameter: 
curl 'https://api.sbx.moduluslabs.io/ecom/v1/checkout?status=ACTIVE&page_size=20&cursor=Y3JlYXRlZF9hdHwxNzE4NzA0MjAwMDAwfDE5' \
  -H 'Authorization: Bearer sk_test_your_api_key_here'
When has_more is false, you have reached the last page.

​
Required scope

payment_links.read

Authorizations

​
Authorization
string
header
required

API key passed as a bearer token. Use sk_live_ keys for production and sk_test_ keys for sandbox. Keys are provisioned during merchant onboarding.

Query Parameters

​
status
enum<string>

Filter by payment link status. Current status of the payment link.

Available options:
ACTIVE,
CONSUMED,
EXPIRED,
CANCELLED
​
merchant_branch_reference_number
string

Filter by branch reference number. Only applicable for partner- or merchant-level keys.

​
created_after
string<date-time>

ISO 8601 timestamp. Only return links created after this time.

​
created_before
string<date-time>

ISO 8601 timestamp. Only return links created before this time.

​
page_size
integer
default:50

Number of results per page.

Required range: 1 <= x <= 200
​
cursor
string

Opaque pagination token from a previous response's next_cursor.

Response

A paginated list of payment links

​
data
object[]
required
​
pagination
object
required