> 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="/spaces/OiXbo96Og9EN7rz2U44K/pages/8769b3f09d5616c0b9fedefc65dfc0b7f95a1876">/spaces/OiXbo96Og9EN7rz2U44K/pages/8769b3f09d5616c0b9fedefc65dfc0b7f95a1876</a></td><td data-object-fit="fill"><a href="/files/C1rTT2Cq1hDvr0F64Rgi">/files/C1rTT2Cq1hDvr0F64Rgi</a></td><td data-object-fit="fill"><a href="/files/RovtcTa3uAwQJjywlq4T">/files/RovtcTa3uAwQJjywlq4T</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="/spaces/OiXbo96Og9EN7rz2U44K/pages/3bc44f2694d366c110291ab88d24d90623298bee">/spaces/OiXbo96Og9EN7rz2U44K/pages/3bc44f2694d366c110291ab88d24d90623298bee</a></td><td data-object-fit="fill"><a href="/files/QlvXSFuWhRinwbFrRBEe">/files/QlvXSFuWhRinwbFrRBEe</a></td><td data-object-fit="fill"><a href="/files/S4fEklUZsLVEKIuVtVuv">/files/S4fEklUZsLVEKIuVtVuv</a></td></tr><tr><td>Payment Modifications</td><td>Capture, void, refund, adjust, reverse, and extend existing transactions.</td><td><a href="/spaces/OiXbo96Og9EN7rz2U44K/pages/08bc4177f18c358a950e9085d0ad540f5d9f652b">/spaces/OiXbo96Og9EN7rz2U44K/pages/08bc4177f18c358a950e9085d0ad540f5d9f652b</a></td><td data-object-fit="fill"><a href="/files/RZV8xIpsE1fSGGuBkMXE">/files/RZV8xIpsE1fSGGuBkMXE</a></td><td data-object-fit="fill"><a href="/files/byoPop8BRDUGloil7G2O">/files/byoPop8BRDUGloil7G2O</a></td></tr><tr><td>Transactions</td><td>Read, list, and count transaction records.</td><td><a href="/spaces/OiXbo96Og9EN7rz2U44K/pages/7d6a0e2c289da2dc2620f0e7c5bb64df09bda934">/spaces/OiXbo96Og9EN7rz2U44K/pages/7d6a0e2c289da2dc2620f0e7c5bb64df09bda934</a></td><td data-object-fit="fill"><a href="/files/zPTRJ919GGvRnG9QAVVc">/files/zPTRJ919GGvRnG9QAVVc</a></td><td data-object-fit="fill"><a href="/files/WUjxqpGyeznViHFLs4Gz">/files/WUjxqpGyeznViHFLs4Gz</a></td></tr><tr><td>Token Management</td><td>Create, update, retrieve, suspend, and delete reuse tokens.</td><td><a href="/spaces/OiXbo96Og9EN7rz2U44K/pages/cc80eb09eea372d41eb92896af01c159ce57e0b9">/spaces/OiXbo96Og9EN7rz2U44K/pages/cc80eb09eea372d41eb92896af01c159ce57e0b9</a></td><td data-object-fit="fill"><a href="/files/ACrmKokMuGOuhxS45S6X">/files/ACrmKokMuGOuhxS45S6X</a></td><td data-object-fit="fill"><a href="/files/RHq9vp7jGXePBqDumU0k">/files/RHq9vp7jGXePBqDumU0k</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="/spaces/OiXbo96Og9EN7rz2U44K/pages/9098b87cb7f0388aefa4ebe4e43e7ce9f1823332">/spaces/OiXbo96Og9EN7rz2U44K/pages/9098b87cb7f0388aefa4ebe4e43e7ce9f1823332</a></td><td data-object-fit="fill"><a href="/files/KSUbuxgbGmoFAM6giO5F">/files/KSUbuxgbGmoFAM6giO5F</a></td><td data-object-fit="fill"><a href="/files/e5pSVEwUH8BMmjiwDaQt">/files/e5pSVEwUH8BMmjiwDaQt</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="/spaces/OiXbo96Og9EN7rz2U44K/pages/36c0fb7d3484259c42cecfa028cf1a9ae39d15b0">/spaces/OiXbo96Og9EN7rz2U44K/pages/36c0fb7d3484259c42cecfa028cf1a9ae39d15b0</a></td><td data-object-fit="fill"><a href="/files/JliP5CXTEy4y5i3tyYZ8">/files/JliP5CXTEy4y5i3tyYZ8</a></td><td data-object-fit="fill"><a href="/files/kYzaehyUmdLXebALtuMy">/files/kYzaehyUmdLXebALtuMy</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="/spaces/OiXbo96Og9EN7rz2U44K/pages/76385d1cf00a773a6f46cc7880c69bc782dcfcc6">/spaces/OiXbo96Og9EN7rz2U44K/pages/76385d1cf00a773a6f46cc7880c69bc782dcfcc6</a></td><td data-object-fit="fill"><a href="/files/2t4A2xx0DVjXhfINWjDN">/files/2t4A2xx0DVjXhfINWjDN</a></td><td data-object-fit="fill"><a href="/files/dLvCGWuukYugUBIkiwWG">/files/dLvCGWuukYugUBIkiwWG</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="/spaces/OiXbo96Og9EN7rz2U44K/pages/fa9ac64748e88bac97e7ead47f5ff3b6b455056e">/spaces/OiXbo96Og9EN7rz2U44K/pages/fa9ac64748e88bac97e7ead47f5ff3b6b455056e</a></td><td data-object-fit="fill"><a href="/files/kUHHHVWvcWwoD4hWf4bK">/files/kUHHHVWvcWwoD4hWf4bK</a></td><td data-object-fit="fill"><a href="/files/pZggl1mCbhWHREP6WRUK">/files/pZggl1mCbhWHREP6WRUK</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/ecommerce.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.