> 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/ecommerce.md).

# eCommerce

The **Verifone eCommerce API** is a RESTful interface using JSON to describe payment transactions. It covers the full payment lifecycle — from authorisation and capture through refunds, reversals, and tokenisation — across card, wallet, and alternative payment methods.

{% hint style="info" %}
All endpoints require either **Bearer Auth** (JWT) or **Basic Auth**. Servers are available for EMEA, Americas, New Zealand, and Global/Americas Sandboxes.
{% endhint %}

## Environments

{% tabs %}
{% tab title="Production" %}

<table><thead><tr><th width="130.888916015625">Region</th><th>Endpoint</th></tr></thead><tbody><tr><td>EMEA</td><td><code>https://emea.gsc.verifone.cloud/oidc</code></td></tr><tr><td>Americas</td><td><code>https://us.gsc.verifone.cloud/oidc</code></td></tr><tr><td>New Zealand</td><td><code>https://nz.gsc.verifone.cloud/oidc</code></td></tr></tbody></table>
{% endtab %}

{% tab title="Sandbox" %}

<table><thead><tr><th width="130.888916015625">Region</th><th>Endpoint</th></tr></thead><tbody><tr><td>Global</td><td><code>https://cst.test-gsc.vfims.com/oidc</code></td></tr><tr><td>Americas</td><td><code>https://uscst-gb.gsc.vficloud.net/oidc</code></td></tr></tbody></table>
{% endtab %}
{% endtabs %}

## 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>Ecom Payments</td><td>Initiate card and wallet payments, including Apple Pay and Google Pay.</td><td><a href="/api-reference/open-api-references/ecommerce/ecom-payments.md">eCom Payments</a></td><td data-object-fit="fill"><a href="https://3326538863-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FOiXbo96Og9EN7rz2U44K%2Fuploads%2FKoY2XSoUxhJDBRdW52b5%2FICON%20BLACK%20ECOMMERCE.svg?alt=media&amp;token=a3fd2ab6-329f-486f-9a2c-a95514bda9ef">ICON BLACK ECOMMERCE.svg</a></td><td data-object-fit="fill"><a href="https://3326538863-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FOiXbo96Og9EN7rz2U44K%2Fuploads%2FkUR09yV5bC1anPdtURMz%2FICON%20WHITE%20ECOMMERCE.svg?alt=media&amp;token=5889dcfb-7613-420a-adb5-0237536f1b80">ICON WHITE ECOMMERCE.svg</a></td></tr><tr><td>Alternative Payment Methods</td><td>Klarna, Vipps, MobilePay, Swish, OP Online, and Affirm two-step flows.</td><td><a href="/api-reference/open-api-references/ecommerce/alternative-payment-methods.md">Alternative Payment Methods</a></td><td data-object-fit="fill"><a href="https://3326538863-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FOiXbo96Og9EN7rz2U44K%2Fuploads%2F6fYNOo2KKzzJbaNWGCOa%2FICON%20BLACK%20ALTERNATIVE%20PAYMENTS.svg?alt=media&amp;token=b44e2e65-4d6e-4cd1-b187-ba4ed3d70cd9">ICON BLACK ALTERNATIVE PAYMENTS.svg</a></td><td data-object-fit="fill"><a href="https://3326538863-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FOiXbo96Og9EN7rz2U44K%2Fuploads%2FnOB5dI47layjyDqimR9i%2FICON%20WHITE%20ALTERNATIVE%20PAYMENTS.svg?alt=media&amp;token=3db44afd-76da-4148-b962-57f6cf97aa4c">ICON WHITE ALTERNATIVE PAYMENTS.svg</a></td></tr><tr><td>Payment Modifications</td><td>Capture, void, refund, adjust, reverse, and extend existing transactions.</td><td><a href="/api-reference/open-api-references/ecommerce/payment-modifications.md">Payment Modifications</a></td><td data-object-fit="fill"><a href="https://3326538863-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FOiXbo96Og9EN7rz2U44K%2Fuploads%2FeNKc15sVSLDNvIZmTwhn%2FICON%20BLACK%20UPDATE%20PAYMENT%20INFO.svg?alt=media&amp;token=537fe29f-bb8d-4606-9144-8422ce4c08d4">ICON BLACK UPDATE PAYMENT INFO.svg</a></td><td data-object-fit="fill"><a href="https://3326538863-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FOiXbo96Og9EN7rz2U44K%2Fuploads%2FCBdJdiduD19PmqhvLZ2m%2FICON%20WHITE%20UPDATE%20PAYMENT%20INFO.svg?alt=media&amp;token=e9ca8855-5d34-4cca-ae1f-5f2d0c65873f">ICON WHITE UPDATE PAYMENT INFO.svg</a></td></tr><tr><td>Transactions</td><td>Read, list, and count transaction records.</td><td><a href="/api-reference/open-api-references/ecommerce/transactions.md">Transactions</a></td><td data-object-fit="fill"><a href="https://3326538863-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FOiXbo96Og9EN7rz2U44K%2Fuploads%2FjaOqx5SBNbOOZnIXHsrw%2FICON%20BLACK%20PAYMENT%20PROCESSING.svg?alt=media&amp;token=16acf7e0-ac26-4371-b825-9709e427ac93">ICON BLACK PAYMENT PROCESSING.svg</a></td><td data-object-fit="fill"><a href="https://3326538863-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FOiXbo96Og9EN7rz2U44K%2Fuploads%2FD88afFX47nQitaZzFZqx%2FICON%20WHITE%20PAYMENT%20PROCESSING.svg?alt=media&amp;token=11315165-3039-4144-8eed-ca11ebf66700">ICON WHITE PAYMENT PROCESSING.svg</a></td></tr><tr><td>Token Management</td><td>Create, update, retrieve, suspend, and delete reuse tokens.</td><td><a href="/api-reference/open-api-references/ecommerce/token-management.md">Token Management</a></td><td data-object-fit="fill"><a href="https://3326538863-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FOiXbo96Og9EN7rz2U44K%2Fuploads%2FZ6pq3A3hWQHVCCgVYzrs%2FICON%20BLACK%20TOKEN.svg?alt=media&amp;token=55496c46-9de6-4b85-8991-8050693c1dcb">ICON BLACK TOKEN.svg</a></td><td data-object-fit="fill"><a href="https://3326538863-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FOiXbo96Og9EN7rz2U44K%2Fuploads%2FPjomWKGF7pPag8zxhssT%2FICON%20WHITE%20TOKEN.svg?alt=media&amp;token=70d06736-f2b2-45f3-84c2-a96811c04a95">ICON WHITE TOKEN.svg</a></td></tr><tr><td>Secure Card Capture</td><td>Generate and manage public/private key pairs for client-side card encryption.</td><td><a href="/api-reference/open-api-references/ecommerce/secure-card-capture.md">Secure Card Capture</a></td><td data-object-fit="fill"><a href="https://3326538863-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FOiXbo96Og9EN7rz2U44K%2Fuploads%2FRpPJRXKigyhoiGFJqVOA%2FICON%20BLACK%20CARD%20TOKENIZATION.svg?alt=media&amp;token=9028d545-a67a-4e95-a9fb-8a2dd4b608d9">ICON BLACK CARD TOKENIZATION.svg</a></td><td data-object-fit="fill"><a href="https://3326538863-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FOiXbo96Og9EN7rz2U44K%2Fuploads%2F7SgINoapZq3sJ5q8f9QP%2FICON%20WHITE%20CARD%20TOKENIZATION.svg?alt=media&amp;token=3a56893f-eea0-4bfe-88f1-deff857c6cde">ICON WHITE CARD TOKENIZATION.svg</a></td></tr><tr><td>Stored Value Cards</td><td>Balance enquiry, load (top-up), and activation for gift and prepaid cards.</td><td><a href="/api-reference/open-api-references/ecommerce/stored-value-cards.md">Stored Value Cards</a></td><td data-object-fit="fill"><a href="https://3326538863-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FOiXbo96Og9EN7rz2U44K%2Fuploads%2F4MIAtpy3F30X5Pqs6Z7f%2FICON%20BLACK%20GIFT%20CARD.svg?alt=media&amp;token=0d57e8fc-95ab-424a-ba32-908429dcbcc5">ICON BLACK GIFT CARD.svg</a></td><td data-object-fit="fill"><a href="https://3326538863-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FOiXbo96Og9EN7rz2U44K%2Fuploads%2FHNvYayKEQzZZZdYMI4j2%2FICON%20WHITE%20GIFT%20CARD.svg?alt=media&amp;token=cf44dacc-04a6-4225-84f3-70a52d88dce0">ICON WHITE GIFT CARD.svg</a></td></tr><tr><td>BIN Lookup</td><td>Look up card brand, type, and issuer details by card prefix or encrypted card.</td><td><a href="/api-reference/open-api-references/ecommerce/bin-lookup.md">BIN Lookup</a></td><td data-object-fit="fill"><a href="https://3326538863-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FOiXbo96Og9EN7rz2U44K%2Fuploads%2FgVID0ZA47a4mYf0No9tr%2FICON%20BLACK%20SIGN%20IN%20TO%20YOUR%20ACCOUNT.svg?alt=media&amp;token=2be068e9-3103-4365-875c-c93cf2df6430">ICON BLACK SIGN IN TO YOUR ACCOUNT.svg</a></td><td data-object-fit="fill"><a href="https://3326538863-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FOiXbo96Og9EN7rz2U44K%2Fuploads%2FrXMT7orpSWWXugv99raU%2FICON%20WHITE%20SIGN%20IN%20TO%20YOUR%20ACCOUNT.svg?alt=media&amp;token=efc599c8-6ab8-4185-bbe6-7cdd680bf9ec">ICON WHITE SIGN IN TO YOUR ACCOUNT.svg</a></td></tr><tr><td>Points Redemption</td><td>Redeem loyalty points associated with a card (currently Amex Pay with Points).</td><td><a href="/api-reference/open-api-references/ecommerce/points-redemption.md">Points Redemption</a></td><td data-object-fit="fill"><a href="https://3326538863-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FOiXbo96Og9EN7rz2U44K%2Fuploads%2Fv25rJbAWCv8eNYm4cwty%2FICON%20BLACK%20LOYALTY%20REWARDS.svg?alt=media&amp;token=1ff6ff47-ee87-4b67-91a5-26b16f99e65b">ICON BLACK LOYALTY REWARDS.svg</a></td><td data-object-fit="fill"><a href="https://3326538863-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FOiXbo96Og9EN7rz2U44K%2Fuploads%2FfqHRhUMvZk3hdaHLuvfI%2FICON%20WHITE%20LOYALTY%20REWARDS.svg?alt=media&amp;token=641873e7-9de4-4899-8274-d426d2983f16">ICON WHITE LOYALTY REWARDS.svg</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 by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

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

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

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.
