> For the complete documentation index, see [llms.txt](https://sandbox-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://sandbox-docs.verifone.com/adk-5.0-programmers-guide/readme/files/dir_2002fcb36e937be08e088f9ab4e81de8/dir_fad52422ca9a0153aca9cfe879bff259/dir_613e11e510006a27889deef70cf7d9b4/_api_8h.md). # Api.h [Data Structures](#nested-classes) | [Namespaces](#namespaces) | [Enumerations](#enum-members) `#include ` `#include ` `#include ` `#include "`[cpdllspec.h](/adk-5.0-programmers-guide/cpdllspec_8h_source.md)`"` Include dependency graph for Api.h: ![](/files/tfnH8s93CCW3guEUUzaL) This graph shows which files directly or indirectly include this file: ![](/files/LsurJoZNI8ZdJoYr1ujf) [Go to the source code of this file.](/adk-5.0-programmers-guide/_api_8h_source.md) | | | | --------------- | -------------------------------------------------------------------------------------------------------------------- | | Data Structures | | | struct | [TransactionData](/adk-5.0-programmers-guide/readme/namespaces/namespacevficpl.md#structvficpl_1_1_transaction_data) | | class | [Api](https://github.com/verifoneone/verifone-git-book-adk/tree/ADK5.0_staging/classvficpl_1_1_api.md) | | | | | ---------- | ------------------------------------------------------------------------- | | Namespaces | | | | [vficpl](/adk-5.0-programmers-guide/readme/namespaces/namespacevficpl.md) | | | | | ------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | Enumerations | | | enum |

ApiError {
API\_OK, API\_FAIL, API\_SERVICE\_TIMEOUT, API\_INVALID\_PARAMETERS,
API\_UNSUPPORTED\_REQUEST, API\_ENCRYPTION\_UNAVAILABLE, API\_NO\_PAPER
}

| *** ### DataStructure Documentation ### vficpl::TransactionData struct vficpl::TransactionData [TransactionData](/adk-5.0-programmers-guide/readme/namespaces/namespacevficpl.md#structvficpl_1_1_transaction_data) container struct for defined return values of [Api](https://github.com/verifoneone/verifone-git-book-adk/tree/ADK5.0_staging/classvficpl_1_1_api.md) | | | | | ---------------- | ------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | Data Fields | | | | string | currency | alphabetic currency code (ISO 4217) | | string | errorDescription | description of error | | string | gratuityAmount | tip value | | string | invoice | invoice or bill number this transaction relates to | | bool | manualEntry | true permits the payment application to obtain card data via manual card entry. false indicates that the manual card entry is not an option. | | vector< string > | manualPromptOption |

Only filled if manualEntry is true.

Possible values are

ZIP prompts to enter zipcode

NOCVV disables prompt for CVV

If ZIP is specified, the result of the AVS is returned in AVS\_Code

| | string | panHandle | reference of payment application ehich refers to the PAN in question. | | string | result | result of transaction | | string | transactionAmount | amount of transaction | | string | transactionId | transaction id provided by the payment gateway, which is a client specific transaction identifier. | | string | transactionType | type of transaction executed by the payment application | --- # 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://sandbox-docs.verifone.com/adk-5.0-programmers-guide/readme/files/dir_2002fcb36e937be08e088f9ab4e81de8/dir_fad52422ca9a0153aca9cfe879bff259/dir_613e11e510006a27889deef70cf7d9b4/_api_8h.md?ask=&goal= ``` `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.