> For the complete documentation index, see [llms.txt](https://docs.verifone.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.verifone.com/api-reference/open-api-references/checkout.md).

# Checkout

The **Checkout API** enables merchants to create hosted payment pages (HPP) that accept cards, digital wallets, and local payment methods. Merchants can customise the shopper experience with branded themes and reusable templates, preview refunds before processing, and receive real-time notifications when checkout events occur.

{% hint style="warning" %}
**To start accepting eCommerce transactions using v2 card capture method, you will need to generate a** [**Secure Card Capture Key**](https://docs.verifone.com/online-payments/api-integration-methods-auth-and-endpoints/secure-card-capture-key)**.**
{% endhint %}

{% hint style="info" %}
All endpoints require authentication via **Basic Auth** or **Bearer Auth**. See your Verifone dashboard for credentials, see [api-authentication.](https://docs.verifone.com/online-payments/api-integration-methods-auth-and-endpoints/api-authentication.)
{% endhint %}

## API Reference

<table data-view="cards"><thead><tr><th>Name</th><th>Description</th><th data-hidden data-card-target data-type="content-ref">Page</th><th data-hidden data-card-cover data-type="image">Cover image</th><th data-hidden data-card-cover-dark data-type="image">Cover image (dark)</th></tr></thead><tbody><tr><td><strong>Checkout Sessions</strong></td><td>Create, retrieve, update, and list hosted payment sessions</td><td><a href="/spaces/OiXbo96Og9EN7rz2U44K/pages/5b9503e42554013cf5c61ed3467b7713f5bbd854">/spaces/OiXbo96Og9EN7rz2U44K/pages/5b9503e42554013cf5c61ed3467b7713f5bbd854</a></td><td data-object-fit="fill"><a href="/files/F8wlMSECfekFwq9eIYNv">/files/F8wlMSECfekFwq9eIYNv</a></td><td data-object-fit="fill"><a href="/files/l2JHUAwZZs8oxUktW4lA">/files/l2JHUAwZZs8oxUktW4lA</a></td></tr><tr><td><strong>Refund Preview</strong></td><td>Estimate refund amounts before committing a refund</td><td><a href="/spaces/OiXbo96Og9EN7rz2U44K/pages/9cdc1e684bbc5454379c199bc06b72ddcad5873d">/spaces/OiXbo96Og9EN7rz2U44K/pages/9cdc1e684bbc5454379c199bc06b72ddcad5873d</a></td><td data-object-fit="fill"><a href="/files/5A2KxU72FbjIYAAK7QcQ">/files/5A2KxU72FbjIYAAK7QcQ</a></td><td data-object-fit="fill"><a href="/files/djNSICPoGMfBzO297Xlj">/files/djNSICPoGMfBzO297Xlj</a></td></tr><tr><td><strong>Checkout Notifications</strong></td><td>Trigger manual notification events for a checkout session</td><td><a href="/spaces/OiXbo96Og9EN7rz2U44K/pages/81be817d7d52ddf83f70b33d5656b09b716e3dac">/spaces/OiXbo96Og9EN7rz2U44K/pages/81be817d7d52ddf83f70b33d5656b09b716e3dac</a></td><td data-object-fit="fill"><a href="/files/Sg39jfY1kU9vkm2rWiC7">/files/Sg39jfY1kU9vkm2rWiC7</a></td><td data-object-fit="fill"><a href="/files/RkNXO3s3OL4xUOmpBKKA">/files/RkNXO3s3OL4xUOmpBKKA</a></td></tr><tr><td><strong>Theming</strong></td><td>Create and manage visual themes and upload branding images</td><td><a href="/spaces/OiXbo96Og9EN7rz2U44K/pages/422b14c2495cc9344f11be310d9909c47dfa7c9c">/spaces/OiXbo96Og9EN7rz2U44K/pages/422b14c2495cc9344f11be310d9909c47dfa7c9c</a></td><td data-object-fit="fill"><a href="/files/eQ1JUKXnYyWk2aUNXlLX">/files/eQ1JUKXnYyWk2aUNXlLX</a></td><td data-object-fit="fill"><a href="/files/085BYN8fxxb2fNMVGW0B">/files/085BYN8fxxb2fNMVGW0B</a></td></tr><tr><td><strong>Templating</strong></td><td>Define reusable field layout templates for the checkout form</td><td><a href="/spaces/OiXbo96Og9EN7rz2U44K/pages/5eeb7a99a79262b4828c889221e60b1469a67741">/spaces/OiXbo96Og9EN7rz2U44K/pages/5eeb7a99a79262b4828c889221e60b1469a67741</a></td><td data-object-fit="fill"><a href="/files/FPPsMPaPQusKPPOF4NR5">/files/FPPsMPaPQusKPPOF4NR5</a></td><td data-object-fit="fill"><a href="/files/wEIj8Xo170lLtQXNt7TL">/files/wEIj8Xo170lLtQXNt7TL</a></td></tr><tr><td><strong>Error Codes</strong></td><td>Verifone error code reference for all API responses</td><td><a href="/spaces/OiXbo96Og9EN7rz2U44K/pages/6f4922a2ccaa3d5c5f4bea49d08d82337cf25f78">/spaces/OiXbo96Og9EN7rz2U44K/pages/6f4922a2ccaa3d5c5f4bea49d08d82337cf25f78</a></td><td data-object-fit="fill"><a href="/files/ZSvEpN6KfdIfym44EitI">/files/ZSvEpN6KfdIfym44EitI</a></td><td data-object-fit="fill"><a href="/files/RvtyuAGMkmgiUaWZdvvp">/files/RvtyuAGMkmgiUaWZdvvp</a></td></tr></tbody></table>


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.verifone.com/api-reference/open-api-references/checkout.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.