CHcheckout
Hosted Payments Page

Get Hosted Payments Page details

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>.

get/hosted-payments/{id}

Request

Path parameters

idstring required

The unique identifier for a Hosted Payments Page.

Response

Hosted Payments Page details retrieved successfully

OR
OR

Example response

{
  "id": "hpp_xGQBg0AXl3cM",
  "status": "Payment Pending",
  "payment_id": "pay_88cb4e671m1da22e9bbbyx",
  "amount": 100,
  "currency": "GBP",
  "reference": "ORD-123A",
  "description": "Payment for Gold Necklace",
  "customer": {
    "email": "brucewayne@email.com",
    "name": "Bruce Wayne"
  },
  "billing": {
    "address": {
      "address_line1": "123 High St.",
      "address_line2": "Flat 456",
      "city": "London",
      "zip": "SW1A 1AA",
      "country": "GB"
    },
    "phone": {
      "country_code": "+1",
      "number": "415 555 2671"
    }
  },
  "products": [
    {
      "url": "https://example.com/products/gold-necklace",
      "name": "Gold Necklace",
      "quantity": 1,
      "price": 1000
    }
  ],
  "success_url": "https://example.com/success",
  "cancel_url": "https://example.com/cancel",
  "failure_url": "https://example.com/failure",
  "amount_allocations": [
    {
      "id": "ent_w4jelhppmfiufdnatam37wrfc4",
      "amount": 1000,
      "reference": "ORD-5023-4E89",
      "commission": {
        "amount": 1000,
        "percentage": 1.125
      }
    }
  ],
  "_links": {
    "self": {
      "href": "https://{prefix}.api.sandbox.checkout.com/hosted-payments/hpp_xGQBg0AXl3cM"
    },
    "redirect": {
      "href": "https://pay.sandbox.checkout.com/page/hpp_xGQBg0AXl3cM"
    }
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.