---
title: "Get Hosted Payments Page details"
method: GET
path: "/hosted-payments/{id}"
tags: ["Hosted Payments Page"]
---

# Get Hosted Payments Page details

`GET /hosted-payments/{id}`

## Request

- Base URL: `https://{prefix}.api.sandbox.checkout.com`
- URL: `https://{prefix}.api.sandbox.checkout.com/hosted-payments/{id}`
- Auth: API key in header `Authorization`
- TypeScript: <https://skmtc.dev/checkout/apis/checkout-com-api-reference/docs/hosted-payments/:id/get.ts> (a function with typed inputs; its response is checked against the schema)

Retrieve details about a specific Hosted Payments Page using the ID returned when it was created. In the response, you will see the status of the Hosted Payments Page.<br><br>
For more information, see the <a target="_blank" href="https://www.checkout.com/docs/integrate/hosted-payments-page">Hosted Payments Page documentation</a>.

## Path parameters

- `id` string, required: The unique identifier for a Hosted Payments Page.

## Response `200`

Hosted Payments Page details retrieved successfully

- union
  - object: A Hosted Payments Page that can accept a payment from a customer.
    - `id` string, required: The unique identifier for a Hosted Payments Page.
    - `status` 'Payment Pending', required: The status of the Hosted Payments Page: - `Payment Pending`: The Hosted Payments Page can accept a payment from the customer. A payment may have been attempted by the customer but not completed successfully. - `Payment Received`: A payment has been received successfully using this Hosted Payments Page. - `Expired`: The Hosted Payments Page has expired and can no longer be accessed.
    - `payment_id` string: Unique identifier for an in progress or completed payment for this Payment Link.
    - `amount` integer, required: The original payment amount.
    - `currency` string, required: The three-letter <a href="https://www.checkout.com/docs/resources/codes/currency-codes" target="blank">ISO currency code</a> of the payment.<br>
    - `reference` string: Your reference for the payment.
    - `description` string: A description of the payment.
    - `customer` object: The customer's details.
      - `email` string, email: The email address for the customer.
      - `name` string: The customer's name.
    - `billing` object, required: The billing details.
      - `address` object, required: The billing address.
        - `address_line1` string: The first line of the address.
        - `address_line2` string: The second line of the address. <p/> For SEPA payments, this value has a maximum length of 10 characters.
        - `city` string: The address city.
        - `state` string: The state or province of the address country <a href="https://en.wikipedia.org/wiki/ISO_3166-2" target="_blank">ISO 3166-2 code</a> (for example: CA for California in the United States).
        - `zip` string: The address zip or postal code.
        - `country` string, required: The two-letter <a href="https://www.checkout.com/docs/resources/codes/country-codes" target="_blank">ISO country code</a> of the address.
      - `phone` object: The customer's phone number.
        - `country_code` string: The international <a href="https://www.checkout.com/docs/resources/codes/country-codes" target="_blank">country calling code</a>. Required if `source.type` is `tamara`.
        - `number` string, required: The phone number. Required if `source.type` is `tamara`.
    - `products` object[]: Contains details about the products in the order.
      - `reference` string: The item reference or product stock keeping unit (SKU).
      - `url` string: Link to the line item's product page.
      - `name` string, required: The descriptive name of the line item.
      - `quantity` integer, required: The number of line items.
      - `price` integer, required: The price per item in minor units, including tax but excluding discounts. The exact format depends on the currency. See <a href="https://www.checkout.com/docs/resources/calculating-the-amount" target="_blank">Calculating the amount</a>.
    - `metadata` object: Any additional information stored at the point of creation.
    - `success_url` string, uri, required: The provided URL your customer will be redirected to upon a successful payment.
    - `cancel_url` string, uri, required: The provided URL your customer will be redirected to if the payment is cancelled.
    - `failure_url` string, uri, required: The provided URL your customer will be redirected to upon a failed payment.
    - `amount_allocations` object[]: The sub-entities that the payment is being processed on behalf of
      - `id` string, required: The id of the sub-entity.
      - `amount` integer, required: The split amount - this will be credited to your sub-entity's currency account. The sum of all split amounts must be equal to the payment amount. The amount must be provided in the <a href="https://www.checkout.com/docs/resources/calculating-the-amount" target="blank">minor currency unit</a>.
      - `reference` string: A reference you can later use to identify this split, such as an order number.
      - `commission` object: Commission you'd like to collect from this split - this will be credited to your currency account. The commission cannot exceed the split amount. Commission = (`amount` * `commission.percentage`) + `commission.amount`
        - `amount` integer: Optional fixed amount of commission to collect. The amount must be provided in the <a href="https://www.checkout.com/docs/resources/calculating-the-amount" target="blank">minor currency unit</a>.
        - `percentage` number: Optional percentage of commission to collect. Supports up to 8 decimal places.
    - `_links` object, required: The links related to the Hosted Payments Page.
      - `self` object, required: The URI of the Hosted Payments Page details.
        - `href` string, required: The link URL
      - `redirect` object, required: The link to visit the Hosted Payments Page.
        - `href` string, required: The link URL
      - `payment` object: The URI of the in progress or completed payment for this Hosted Payments Page.
        - `href` string, required: The link URL
      - `payment_actions` object: The URI of the actions associated with the in progress or completed payment for this Hosted Payments Page.
        - `href` string, required: The link URL
  - object: A Hosted Payments Page that has received a payment
    - `id` string, required: The unique identifier for a Hosted Payments Page.
    - `status` 'Payment Received', required: The status of the Hosted Payments Page: - `Payment Pending`: The Hosted Payments Page can accept a payment from the customer. A payment may have been attempted by the customer but not completed successfully. - `Payment Received`: A payment has been received successfully using this Hosted Payments Page. - `Expired`: The Hosted Payments Page has expired and can no longer be accessed.
    - `payment_id` string, required: Unique identifier for an in progress or completed payment for this Payment Link.
    - `amount` integer, required: The original payment amount.
    - `currency` string, required: The three-letter <a href="https://www.checkout.com/docs/resources/codes/currency-codes" target="blank">ISO currency code</a> of the payment.<br>
    - `reference` string: Your reference for the payment.
    - `description` string: A description of the payment.
    - `customer` object: The customer's details.
      - `email` string, email: The email address for the customer.
      - `name` string: The customer's name.
    - `billing` object, required: The billing details.
      - `address` object, required: The billing address.
        - `address_line1` string: The first line of the address.
        - `address_line2` string: The second line of the address. <p/> For SEPA payments, this value has a maximum length of 10 characters.
        - `city` string: The address city.
        - `state` string: The state or province of the address country <a href="https://en.wikipedia.org/wiki/ISO_3166-2" target="_blank">ISO 3166-2 code</a> (for example: CA for California in the United States).
        - `zip` string: The address zip or postal code.
        - `country` string, required: The two-letter <a href="https://www.checkout.com/docs/resources/codes/country-codes" target="_blank">ISO country code</a> of the address.
      - `phone` object: The customer's phone number.
        - `country_code` string: The international <a href="https://www.checkout.com/docs/resources/codes/country-codes" target="_blank">country calling code</a>. Required if `source.type` is `tamara`.
        - `number` string, required: The phone number. Required if `source.type` is `tamara`.
    - `products` object[]: Contains details about the products in the order.
      - `reference` string: The item reference or product stock keeping unit (SKU).
      - `url` string: Link to the line item's product page.
      - `name` string, required: The descriptive name of the line item.
      - `quantity` integer, required: The number of line items.
      - `price` integer, required: The price per item in minor units, including tax but excluding discounts. The exact format depends on the currency. See <a href="https://www.checkout.com/docs/resources/calculating-the-amount" target="_blank">Calculating the amount</a>.
    - `metadata` object: Any additional information stored at the point of creation.
    - `success_url` string, uri, required: The provided URL your customer will be redirected to upon a successful payment.
    - `cancel_url` string, uri, required: The provided URL your customer will be redirected to if the payment is cancelled.
    - `failure_url` string, uri, required: The provided URL your customer will be redirected to upon a failed payment.
    - `amount_allocations` object[]: The sub-entities that the payment is being processed on behalf of
      - `id` string, required: The id of the sub-entity.
      - `amount` integer, required: The split amount - this will be credited to your sub-entity's currency account. The sum of all split amounts must be equal to the payment amount. The amount must be provided in the <a href="https://www.checkout.com/docs/resources/calculating-the-amount" target="blank">minor currency unit</a>.
      - `reference` string: A reference you can later use to identify this split, such as an order number.
      - `commission` object: Commission you'd like to collect from this split - this will be credited to your currency account. The commission cannot exceed the split amount. Commission = (`amount` * `commission.percentage`) + `commission.amount`
        - `amount` integer: Optional fixed amount of commission to collect. The amount must be provided in the <a href="https://www.checkout.com/docs/resources/calculating-the-amount" target="blank">minor currency unit</a>.
        - `percentage` number: Optional percentage of commission to collect. Supports up to 8 decimal places.
    - `_links` object, required: The links related to the Hosted Payments Page.
      - `self` object, required: The URI of the Hosted Payments Page details.
        - `href` string, required: The link URL
      - `redirect` object, required: The link to visit the Hosted Payments Page.
        - `href` string, required: The link URL
      - `payment` object: The URI of the in progress or completed payment for this Hosted Payments Page.
        - `href` string, required: The link URL
      - `payment_actions` object: The URI of the actions associated with the in progress or completed payment for this Hosted Payments Page.
        - `href` string, required: The link URL
  - object: An expired Hosted Payments Page.
    - `id` string, required: The unique identifier for a Hosted Payments Page.
    - `status` 'Expired', required: The status of the Hosted Payments Page: - `Payment Pending`: The Hosted Payments Page can accept a payment from the customer. A payment may have been attempted by the customer but not completed successfully. - `Payment Received`: A payment has been received successfully using this Hosted Payments Page. - `Expired`: The Hosted Payments Page has expired and can no longer be accessed.
    - `payment_id` string: Unique identifier for an in progress or completed payment for this Payment Link.
    - `amount` integer, required: The original payment amount.
    - `currency` string, required: The three-letter <a href="https://www.checkout.com/docs/resources/codes/currency-codes" target="blank">ISO currency code</a> of the payment.<br>
    - `reference` string: Your reference for the payment.
    - `description` string: A description of the payment.
    - `customer` object: The customer's details.
      - `email` string, email: The email address for the customer.
      - `name` string: The customer's name.
    - `billing` object, required: The billing details.
      - `address` object, required: The billing address.
        - `address_line1` string: The first line of the address.
        - `address_line2` string: The second line of the address. <p/> For SEPA payments, this value has a maximum length of 10 characters.
        - `city` string: The address city.
        - `state` string: The state or province of the address country <a href="https://en.wikipedia.org/wiki/ISO_3166-2" target="_blank">ISO 3166-2 code</a> (for example: CA for California in the United States).
        - `zip` string: The address zip or postal code.
        - `country` string, required: The two-letter <a href="https://www.checkout.com/docs/resources/codes/country-codes" target="_blank">ISO country code</a> of the address.
      - `phone` object: The customer's phone number.
        - `country_code` string: The international <a href="https://www.checkout.com/docs/resources/codes/country-codes" target="_blank">country calling code</a>. Required if `source.type` is `tamara`.
        - `number` string, required: The phone number. Required if `source.type` is `tamara`.
    - `products` object[]: Contains details about the products in the order.
      - `reference` string: The item reference or product stock keeping unit (SKU).
      - `url` string: Link to the line item's product page.
      - `name` string, required: The descriptive name of the line item.
      - `quantity` integer, required: The number of line items.
      - `price` integer, required: The price per item in minor units, including tax but excluding discounts. The exact format depends on the currency. See <a href="https://www.checkout.com/docs/resources/calculating-the-amount" target="_blank">Calculating the amount</a>.
    - `metadata` object: Any additional information stored at the point of creation.
    - `success_url` string, uri, required: The provided URL your customer will be redirected to upon a successful payment.
    - `cancel_url` string, uri, required: The provided URL your customer will be redirected to if the payment is cancelled.
    - `failure_url` string, uri, required: The provided URL your customer will be redirected to upon a failed payment.
    - `amount_allocations` object[]: The sub-entities that the payment is being processed on behalf of
      - `id` string, required: The id of the sub-entity.
      - `amount` integer, required: The split amount - this will be credited to your sub-entity's currency account. The sum of all split amounts must be equal to the payment amount. The amount must be provided in the <a href="https://www.checkout.com/docs/resources/calculating-the-amount" target="blank">minor currency unit</a>.
      - `reference` string: A reference you can later use to identify this split, such as an order number.
      - `commission` object: Commission you'd like to collect from this split - this will be credited to your currency account. The commission cannot exceed the split amount. Commission = (`amount` * `commission.percentage`) + `commission.amount`
        - `amount` integer: Optional fixed amount of commission to collect. The amount must be provided in the <a href="https://www.checkout.com/docs/resources/calculating-the-amount" target="blank">minor currency unit</a>.
        - `percentage` number: Optional percentage of commission to collect. Supports up to 8 decimal places.
    - `_links` object, required: The links related to the Hosted Payments Page.
      - `self` object, required: The URI of the Hosted Payments Page details.
        - `href` string, required: The link URL
      - `redirect` object, required: The link to visit the Hosted Payments Page.
        - `href` string, required: The link URL
      - `payment` object: The URI of the in progress or completed payment for this Hosted Payments Page.
        - `href` string, required: The link URL
      - `payment_actions` object: The URI of the actions associated with the in progress or completed payment for this Hosted Payments Page.
        - `href` string, required: The link URL

## Other responses

- `401`: Unauthorized
- `404`: Hosted Payments Page not found

---

[API](https://skmtc.dev/checkout/apis/checkout-com-api-reference.md) - [All operations](https://skmtc.dev/checkout/apis/checkout-com-api-reference/llms.txt) - [OpenAPI document](https://skmtc.dev/checkout/apis/checkout-com-api-reference/revisions/0f1abdb1c3e9?raw)