Accept card payments with a Hosted Payments Page—a fast and easy way to collect your customer’s payment information, process the payment request and handle authentication.

Supported payment methods

You can accept the following payment methods with Hosted Payments:

• International cards
• KNET
• Mada
• PayPal
• Sofort

How it works

When your customer is ready to check out:

1. Create a Hosted Payments Page session and pass through all the payment information, like the amount, currency, country and reference.
2. We'll use this information to render the Hosted Payments Page to which you will redirect your customer to make their payment.
3. Once your customer fills in the required payment details, we will process the payment and handle the authentication flow.
4. And after the payment has been successfully processed, you will be notified by a webhook.

Try it out

Preview a Hosted Payments Page using one of our test cards with any future expiry date, or use the details below for a basic payment flow:

• Card number: 4242 4242 4242 4242
• Expiry date: Any future date
• CVV: 100

Get started

Step 1: Register to use Hosted Payments Pages

To get started with our Hosted Payments Page, contact your Solutions Engineer or integration@checkout.com.

Step 2: Create a Hosted Payments Page session

To create a Hosted Payments Page on which your customers can make their payment, use the endpoint below.

The request

Endpoints

POSThttps://api.checkout.com/hosted-payments

POSThttps://api.sandbox.checkout.com/hosted-payments

Header parameters

Body parameters

Request examples

{
  "amount": 1000,
  "currency": "GBP",
  "reference": "ORD-123A",
  "billing": {
    "address": {
      "country": "GB"
    }
  },
  "customer": {
    "name": "Jack Napier",
    "email": "jokershere@gmail.com"
  },
  "success_url": "https://example.com/payments/success",
  "failure_url": "https://example.com/payments/failure",
  "cancel_url": "https://example.com/payments/checkout"
}

{
  "amount": 1000,
  "currency": "KWD",
  "reference": "ORD-123A",
  "billing": {
    "address": {
      "country": "KW"
    }
  },
  "customer": {
    "name": "Jack Napier",
    "email": "jokershere@gmail.com"
  },
  "success_url": "https://example.com/payments/success",
  "failure_url": "https://example.com/payments/failure",
  "cancel_url": "https://example.com/payments/checkout"
}

{
  "amount": 1000,
  "currency": "SAR",
  "reference": "ORD-123A",
  "billing": {
    "address": {
      "country": "SA"
    }
  },
  "customer": {
    "name": "Jack Napier",
    "email": "jokershere@gmail.com"
  },
  "success_url": "https://example.com/payments/success",
  "failure_url": "https://example.com/payments/failure",
  "cancel_url": "https://example.com/payments/checkout"
}

{
  "amount": 1000,
  "currency": "EUR",
  "reference": "ORD-123A",
  "billing": {
    "address": {
      "country": "BE"
    }
  },
  "customer": {
    "name": "Jack Napier",
    "email": "jokershere@gmail.com"
  },
  "success_url": "https://example.com/payments/success",
  "failure_url": "https://example.com/payments/failure",
  "cancel_url": "https://example.com/payments/checkout"
}

The response

The response will include the redirect link to which you should redirect your customer to finalize the payment.

Response example

{
  "reference": "ORD-123A",
  "_links": {
    "redirect": {
      "href": "https://pay.sandbox.checkout.com/page/xGQBg0AXl3cM"
    }
  } 
}

Step 3: Redirect your customer

Redirect the customer to the _links.redirect URL you received in the response above, using either a server-side or client-side call.

res.redirect(hostedPaymentsResponse._links.redirect.href);

window.location.href(hostedPaymentsResponse._links.redirect.href);

Step 4: Confirm the payment status

When your customer completes the payment, they will be redirected to the success_url. The session ID is provided in the cko-session-id query parameter included in the redirect URL. It should look something like this: http://example.com/success?cko-session-id=sid_ubfj2q76miwundwlk72vxt2i7.

You can set up webhooks to be notified when the payment has been approved to continue the sales fulfilment flow.

Next steps

• Learn how to refund a payment, and more.
• Set up webhooks to be notified about the status of payments.