> For the complete documentation index, see [llms.txt](https://docs.omni.integratedcommerce.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.omni.integratedcommerce.io/readme.md).

# Omni-Channel Payment API

A single set of REST endpoints for taking payments in person, online, and by bank transfer across the United States and Canada.

The Integrated Commerce Omni-Channel Payment API is a RESTful API that provides a unified interface for processing payments across multiple channels. It lets you integrate payment processing into your applications with a single set of endpoints, simplifying implementation and reducing development time.

The API supports integration in both the United States and Canada, using USD and CAD currencies.

## Start here

<table data-view="cards"><thead><tr><th></th><th></th><th></th><th data-hidden data-card-target data-type="content-ref"></th></tr></thead><tbody><tr><td><i class="fa-bolt">:bolt:</i></td><td><strong>Get started</strong></td><td>Authenticate, learn the request conventions, and read your first response.</td><td><a href="https://docs.omni.integratedcommerce.io/get-started/get-started.md">Introduction</a></td></tr><tr><td><i class="fa-credit-card">:credit-card:</i></td><td><strong>Payments</strong></td><td>Pick a channel: card present, card not present, or ACH bank transfer.</td><td><a href="https://docs.omni.integratedcommerce.io/payments/payments.md">Choosing a channel</a></td></tr><tr><td><i class="fa-window-maximize">:window-maximize:</i></td><td><strong>Hosted Payment Form</strong></td><td>Embed the secure iframe and keep card data out of your environment.</td><td><a href="https://docs.omni.integratedcommerce.io/hosted-payment-form/hosted-payment-form.md">Overview</a></td></tr><tr><td><i class="fa-code">:code:</i></td><td><strong>Payment SDK</strong></td><td>Drop a web component into your checkout, with Apple Pay and Google Pay.</td><td><a href="https://docs.omni.integratedcommerce.io/payment-sdk/payment-sdk.md">Overview</a></td></tr><tr><td><i class="fa-webhook">:webhook:</i></td><td><strong>Webhooks</strong></td><td>Receive and verify real-time transaction, token, and merchant events, on legacy webhooks or, by invitation, on Svix.</td><td><a href="https://docs.omni.integratedcommerce.io/webhooks/webhooks.md">Overview</a></td></tr><tr><td><i class="fa-building-columns">:building-columns:</i></td><td><strong>Settlement reporting (beta)</strong></td><td>Reconcile deposits, settled transactions, and every fee charged. In beta, enabled on request.</td><td><a href="https://docs.omni.integratedcommerce.io/settlement-reporting/reporting.md">The reporting model</a></td></tr></tbody></table>

## Choosing an integration

| You want to                                                    | Use                                                                                                                                                                                                |
| -------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Take payments on a countertop or portable terminal             | [Card present](https://docs.omni.integratedcommerce.io/payments/card-present.md)                                                                                                                   |
| Take payments on your own website or app                       | [Hosted Payment Form](https://docs.omni.integratedcommerce.io/hosted-payment-form/hosted-payment-form.md) or the [Payment SDK](https://docs.omni.integratedcommerce.io/payment-sdk/payment-sdk.md) |
| Offer Apple Pay or Google Pay                                  | [Payment SDK](https://docs.omni.integratedcommerce.io/payment-sdk/payment-sdk.md)                                                                                                                  |
| Debit a US bank account                                        | [ACH bank transfers](https://docs.omni.integratedcommerce.io/payments/ach.md)                                                                                                                      |
| Charge a returning customer without re-collecting card details | [Tokenization](https://docs.omni.integratedcommerce.io/payments/tokenization.md)                                                                                                                   |
| Reconcile deposits into the merchant's bank account            | [Settlement reporting](https://docs.omni.integratedcommerce.io/settlement-reporting/reporting.md) (beta, enabled on request)                                                                       |

## Glossary

For definitions of the terms used throughout these docs, start with the [Glossary](https://docs.omni.integratedcommerce.io/glossary/accounts-and-api-access.md), including [payments](https://docs.omni.integratedcommerce.io/glossary/payments-and-transactions.md), [hosted forms](https://docs.omni.integratedcommerce.io/glossary/hosted-forms-and-sdk.md), [webhooks and outcomes](https://docs.omni.integratedcommerce.io/glossary/webhooks-and-outcomes.md), and [settlement and fees](https://docs.omni.integratedcommerce.io/glossary/settlement-and-fees.md).

## Support

For technical assistance, contact the support team at <support@integratedcommerce.io>.
