Skip to main content
GET
/
checkout
/
{id}
Retrieve a payment link
curl --request GET \
  --url https://api.sbx.moduluslabs.io/ecom/v1/checkout/{id} \
  --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>"
  }
}
Returns the full payment link object wrapped in data, including its current status and successful_payment_count.

​
Required scope

payment_links.read A payment link is only returned if it is accessible by your API key’s entity. Requesting a link outside your scope returns 404 not_found.

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.

Path Parameters

​
id
string<uuid>
required

The payment link ID (UUID v4).

Response

The requested payment link

​
data
object
required

The payment link object returned by all endpoints.