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

# PSDK Getting Started

The Verifone **Payment Software Development Kit** (PSDK) is a **PCI** (Payment Card Industry)-compliant payment solution that offers a secure payment transaction.

{% if visitor.isSet === true && (visitor.claims.hasAccessToPSDK === false || visitor.claims.hasAccessToDEVPORTAL\_VFI === false) %}
{% columns %}
{% column width="16.666666666666664%" %}

<figure><picture><source srcset="/spaces/YxYaIQQ51Y1kp5Oav4GZ/files/h8CUQCrn7gGJx3iTwKEZ" media="(prefers-color-scheme: dark)"><img src="/spaces/YxYaIQQ51Y1kp5Oav4GZ/files/rOelFPj8VuctGQ5lNjAC" alt=""></picture><figcaption></figcaption></figure>
{% endcolumn %}

{% column width="83.33333333333334%" valign="middle" %}

<h3 align="center">Need access to this content? Contact your Verifone representative.</h3>
{% endcolumn %}
{% endcolumns %}
{% endif %}

{% if visitor.isSet === false %}
{% columns %}
{% column %}

<h4 align="center"><strong>Please login or register to gain access to the detailed material on this page.</strong></h4>
{% endcolumn %}

{% column %}

<p align="right"><a href="https://identity.verifone.com/am/XUI/?realm=/alpha&#x26;authIndexType=service&#x26;authIndexValue=DocsLoginV7&#x26;goto=https://docs.verifone.com/" class="button primary" data-icon="shield-keyhole">Login</a><a href="https://partner-registration.verifone.com/" class="button secondary">Register for an Account</a></p>
{% endcolumn %}
{% endcolumns %}
{% endif %}

<details>

<summary>Learn more about about PSDK benefits</summary>

**Simple, secure payments on every device in every region**

* One integration
  * Across regions
  * Across hosts
  * Across connections
  * Across payment protocols
  * Across Verifone platforms & devices
    * POS app written for CM5 or Carbon will also work on an Android BYOD with an e280.
  * Across Merchant platforms & devices
    * POS app written for Android on Carbon will use the same APIs and flows if ported to iOS, Windows or Linux.
* Simplifies and streamlines the experience for the developer
  * The POS can integrate once and it works regardless of the region, host, or Verifone device.
  * One set of documentation covering 4 merchant platforms (Android, iOS, Windows, Linux) and Verifone devices (Carbon, Carbon Mobile, e280, …)
  * Unified API and error codes across Verifone and Merchant platforms

</details>

{% stepper %}
{% step %}

### <i class="fa-play">:play:</i> Watch the Overview

{% embed url="<https://vimeo.com/1132591217/ce1e6b5c67>" %}

Get a quick overview of PSDK in this short 3 min video. You will learn about PSDK's features, architecture and supported platforms.
{% endstep %}

{% step %}

### PSDK Libraries

<table data-header-hidden><thead><tr><th width="390.33203125" valign="top"></th><th valign="top"></th></tr></thead><tbody><tr><td valign="top">Download the libraries for your platform, install and configure them in your IDE.</td><td valign="top"><img src="/files/yzdMfW6Ky1DYk4B5xGpo" alt=""></td></tr></tbody></table>

{% if visitor.isSet === false %}
{% columns %}
{% column %}

{% endcolumn %}

{% column %}

<p align="right"><a href="https://identity.verifone.com/am/XUI/?realm=/alpha&#x26;authIndexType=service&#x26;authIndexValue=DocsLoginV7&#x26;goto=https://docs.verifone.com/" class="button primary" data-icon="shield-keyhole">Login</a></p>
{% endcolumn %}
{% endcolumns %}
{% endif %}

{% if visitor.isSet === true && (visitor.claims.hasAccessToDEVPORTAL\_VFI || visitor.claims.hasAccessToPSDK === true) %} <a href="/pages/ZdNZqMVZ8zLc6vXB4R0j" class="button primary" data-icon="desktop-arrow-down">Download PSDK Libraries</a>
{% endif %}
{% endstep %}

{% step %}

### User Guide

<table data-header-hidden><thead><tr><th width="390.33203125" valign="top"></th><th valign="top"></th></tr></thead><tbody><tr><td valign="top">This guide offers detailed instructions on integrating PSDK, along with an overview of its features and functionalities.</td><td valign="top"><img src="/files/pIaLZMF2fuOZCgVKSdmp" alt=""></td></tr></tbody></table>

{% if visitor.isSet === false %}
{% columns %}
{% column %}

{% endcolumn %}

{% column %}

<p align="right"><a href="https://identity.verifone.com/am/XUI/?realm=/alpha&#x26;authIndexType=service&#x26;authIndexValue=DocsLoginV7&#x26;goto=https://docs.verifone.com/" class="button primary" data-icon="shield-keyhole">Login</a></p>
{% endcolumn %}
{% endcolumns %}
{% endif %}

{% if visitor.isSet === true && (visitor.claims.hasAccessToDEVPORTAL\_VFI || visitor.claims.hasAccessToPSDK === true) %} <a href="/pages/cbtlBvjg9M7BCKKTHodT" class="button primary" data-icon="user-graduate">Review PSDK User Guide</a>
{% endif %}
{% endstep %}

{% step %}

### API & Code Labs

<table data-header-hidden><thead><tr><th width="390.33203125" valign="top"></th><th valign="top"></th></tr></thead><tbody><tr><td valign="top">Review the API documentation and complete the code labs to thoroughly understand how to integrate PSDK into your POS system.</td><td valign="top"><img src="/files/nvaobGyk9H5MeGAa1OPr" alt=""></td></tr></tbody></table>

{% if visitor.isSet === true && (visitor.claims.hasAccessToDEVPORTAL\_VFI || visitor.claims.hasAccessToPSDK === true) %} <a href="/spaces/H1fZTeFkydFyzqlXpEJF/pages/uFPfZouGOIbVqbmfjAzL" class="button primary" data-icon="webhook">Review PSDK API Documentation</a> <a href="/pages/mER0gM3O2HtoBS8MsEa9" class="button secondary" data-icon="square-code">Complete Code Labs</a>
{% endif %}

{% if visitor.isSet === false %}
{% columns %}
{% column %}

{% endcolumn %}

{% column %}

<p align="right"><a href="https://identity.verifone.com/am/XUI/?realm=/alpha&#x26;authIndexType=service&#x26;authIndexValue=DocsLoginV7&#x26;goto=https://docs.verifone.com/" class="button primary" data-icon="shield-keyhole">Login</a></p>
{% endcolumn %}
{% endcolumns %}
{% endif %}
{% endstep %}

{% step %}

### Reference Application

<table data-header-hidden><thead><tr><th width="390.33203125" valign="top"></th><th valign="top"></th></tr></thead><tbody><tr><td valign="top">Download the source code for the reference application and test the PSDK. Make necessary changes to the app to quickly reach a working solution.</td><td valign="top"><img src="/files/x7cKnd9yNJe6XBUaGeVT" alt=""></td></tr></tbody></table>

{% if visitor.isSet === true && (visitor.claims.hasAccessToDEVPORTAL\_VFI || visitor.claims.hasAccessToPSDK === true) %} <a href="/pages/l8vEGwYb78NSmVhQWZOC" class="button primary" data-icon="mobile-arrow-down">Download the Reference Application</a>
{% endif %}

{% if visitor.isSet === false %}
{% columns %}
{% column %}

{% endcolumn %}

{% column %}

<p align="right"><a href="https://identity.verifone.com/am/XUI/?realm=/alpha&#x26;authIndexType=service&#x26;authIndexValue=DocsLoginV7&#x26;goto=https://docs.verifone.com/" class="button primary" data-icon="shield-keyhole">Login</a></p>
{% endcolumn %}
{% endcolumns %}
{% endif %}
{% endstep %}

{% step %}

### Build & Submit Your Application

<table data-header-hidden><thead><tr><th width="390.33203125" valign="top"></th><th valign="top"></th></tr></thead><tbody><tr><td valign="top">Complete your solutions and submit your testing logs for Verifone assessment. Make sure you're ready with the self assessment first.</td><td valign="top"><img src="/files/ecH63qHJQqMVzzfQ7rm2" alt=""></td></tr></tbody></table>

{% if visitor.isSet === true && (visitor.claims.hasAccessToDEVPORTAL\_VFI || visitor.claims.hasAccessToPSDK === true) %} <a href="/pages/6mIuI7O77534kKNeGsMJ" class="button primary" data-icon="clipboard-question">Perform Self Assessment</a>
{% endif %}

{% if visitor.isSet === false %}
{% columns %}
{% column %}

{% endcolumn %}

{% column %}

<p align="right"><a href="https://identity.verifone.com/am/XUI/?realm=/alpha&#x26;authIndexType=service&#x26;authIndexValue=DocsLoginV7&#x26;goto=https://docs.verifone.com/" class="button primary" data-icon="shield-keyhole">Login</a></p>
{% endcolumn %}
{% endcolumns %}
{% endif %}
{% endstep %}

{% step %}

### Get Help

Stuck?... Need help? We're here to get you on track.

{% if visitor.isSet === true && (visitor.claims.hasAccessToDEVPORTAL\_VFI || visitor.claims.hasAccessToPSDK === true) %} <a href="https://verifone.atlassian.net/servicedesk/customer/portals" class="button primary" data-icon="jira">Raise a support ticket!</a>
{% endif %}
{% endstep %}
{% endstepper %}


---

# 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/psdk/readme.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.
