Online REST API Home

Authentication

Authentication Headers

Primary Transactions

Authorization

Sale

Refund

Token Transactions

Token-Based Authorization

Token-Based Sale

Token-Based Refund

Secondary Transactions

Capture

Linked Refund

Reversal

Void

Incremental

Resources

Request Format

Response Format

Transaction Management

Payment Methods

Test Cards

Response Codes

Default

Online Rest API

apiKey

secret

Sandbox

<div class="table-container" style="width:100%;min-width:100%"><table class="slate-table" style="min-width:100%"><div class="published-table-header" style="width:100%;min-width:100%;min-height:initial;visibility: hidden;border:initial"><div style="width:100px;">Title</div></div><colgroup ><col style="width:initial"></colgroup><tbody class="slate-TableElement-tbody"><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " ></p><h2 class="slate-h2 " >Primary Transactions</h2><p class="slate-p " ></p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " ><a href="https://developer.doc.pay.tnsi.com/online-rest-api/primary-transactions/authorization" target="_self">Authorization Transaction</a></p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p slate-indent-0" style="0px"><a href="https://developer.doc.pay.tnsi.com/online-rest-api/primary-transactions/sale" target="_self">Sale Transaction</a></p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " ><a href="https://developer.doc.pay.tnsi.com/online-rest-api/primary-transactions/refund" target="_self">Refund Transaction</a></p></td></div></tr></tbody></table></div><div class="table-container" style="width:100%;min-width:100%"><table class="slate-table" style="min-width:100%"><div class="published-table-header" style="width:100%;min-width:100%;min-height:initial;visibility: hidden;border:initial"><div style="width:100px;">Title</div></div><colgroup ><col style="width:initial"></colgroup><tbody class="slate-TableElement-tbody"><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " ></p><h2 class="slate-h2 " >Token Transactions</h2><p class="slate-p " ></p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " ><a href="https://app.theneo.io/tnsi/online-rest-api/token-transactions/token-based-authorization" target="_self">Authorization Transaction</a></p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " ><a href="https://app.theneo.io/tnsi/online-rest-api/token-transactions/token-based-sale" target="_self">Sale Transaction</a></p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " ><a href="https://app.theneo.io/tnsi/online-rest-api/token-transactions/token-based-refund" target="_self">Refund Transaction</a></p></td></div></tr></tbody></table></div><div class="table-container" style="width:100%;min-width:100%"><table class="slate-table" style="min-width:100%"><div class="published-table-header" style="width:100%;min-width:100%;min-height:initial;visibility: hidden;border:initial"><div style="width:100px;">Title</div></div><colgroup ><col style="width:initial"></colgroup><tbody class="slate-TableElement-tbody"><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " ></p><h2 class="slate-h2 " >Secondary Transactions</h2><p class="slate-p " ></p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " ><a href="https://app.theneo.io/tnsi/online-rest-api/secondary-transactions/capture" target="_self">Capture</a></p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " ><a href="https://app.theneo.io/tnsi/online-rest-api/secondary-transactions/linked-refund" target="_self">Linked Refund</a></p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " ><a href="https://app.theneo.io/tnsi/online-rest-api/secondary-transactions/reversal" target="_self">Reversal</a></p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " ><a href="https://app.theneo.io/tnsi/online-rest-api/secondary-transactions/void" target="_self">Void</a></p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " ><a href="https://app.theneo.io/tnsi/online-rest-api/secondary-transactions/incremental" target="_self">Incremental</a></p></td></div></tr></tbody></table></div><p class="slate-p " ></p><p class="slate-p " ></p>

Title

<p class="slate-p " ><span style="color:rgb(0, 0, 0)">Every request to TNS Gateway API is to be authenticated by HMAC by creating a signature of the request payload using API Key and Secret provided by TNS. </span></p><h2 class="slate-h2 " ><span style="color:rgb(0, 0, 0)">How to generate hmac</span></h2><p class="slate-p " ></p><ol class="slate-ol " ><li class="slate-li " ><div style="position:relative"><code class="slate-code">APIKey</code> (Provided by TNS)</div></li><li class="slate-li " ><div style="position:relative"><code class="slate-code">Secret</code> (Provided by TNS)</div></li><li class="slate-li " ><div style="position:relative"><span style="color:rgb(0, 0, 0)">Take the </span><span style="color:rgb(0, 0, 0)"><code class="slate-code">timestamp</code></span><span style="color:rgb(0, 0, 0)"> at the time of signing</span></div></li><li class="slate-li " ><div style="position:relative"><span style="color:rgb(0, 0, 0)">Get data/</span><span style="color:rgb(0, 0, 0)"><code class="slate-code">payload</code></span><span style="color:rgb(0, 0, 0)"> (which will be sent as request body) as string</span></div></li><li class="slate-li " ><div style="position:relative"><span style="color:rgb(0, 0, 0)">Concatenate </span><span style="color:rgb(0, 0, 0)"><code class="slate-code">APIKey</code></span><span style="color:rgb(0, 0, 0)"> </span><span style="color:rgb(0, 0, 0)"><u class="slate-underline"><code class="slate-code">“:” </code></u></span><span style="color:rgb(0, 0, 0)"><code class="slate-code">timestamp</code></span><span style="color:rgb(0, 0, 0)"> </span><span style="color:rgb(0, 0, 0)"><u class="slate-underline"><code class="slate-code">“:”</code></u></span><span style="color:rgb(0, 0, 0)"><u class="slate-underline"> </u></span><span style="color:rgb(0, 0, 0)"><code class="slate-code">payload</code></span></div></li><li class="slate-li " ><div style="position:relative"><span style="color:rgb(0, 0, 0)">Generate HMAC by using </span><span style="color:rgb(0, 0, 0)"><code class="slate-code">Secret</code></span><span style="color:rgb(0, 0, 0)"> provided by TNS</span></div></li></ol><p class="slate-p " ><span style="color:rgb(0, 0, 0)">HMAC should be generated by using SHA512 algorithm.</span></p><p class="slate-p " ><span style="color:rgb(0, 0, 0)">Here&apos;s a simple example of HMAC calculation using JavaScript</span></p><p class="slate-p slate-indent-0" style="0px"><span style="background-color:rgb(255, 255, 255);color:rgb(18, 21, 18)">To use </span><code class="slate-code">CryptoJS.HmacSHA512</code><span style="background-color:rgb(255, 255, 255);color:rgb(18, 21, 18)">, you need to ensure that you have the necessary prerequisites set up, including the proper installation and importation of the </span><code class="slate-code">crypto-js</code><span style="background-color:rgb(255, 255, 255);color:rgb(18, 21, 18)"> library.</span>

Include the CryptoJS library in your HTML file: Add the following &lt;script&gt; tag to your HTML file to load CryptoJS from a CDN.</p><div class="code-block-wrapper"  style="width:100%;min-width:100%" ><div class="code-block-header">Plain text</div><pre class="slate-CodeBlockElement slate-code_block"><textarea id="publishedPageCodeblock" style="display:none !important; visibility: hidden; opacity: 0; width: 1px; height: 1px;" type="hidden"> </textarea><code class="language-javascript keep-markup drop-tokens"><div class="slate-code_line">&lt;script src=&quot;https://cdnjs.cloudflare.com/ajax/libs/crypto-js/4.2.0/crypto-js.min.js&quot;&gt;&lt;/script&gt;</div></code></pre></div><div class="code-block-wrapper"  style="width:100%;min-width:100%" ><div class="code-block-header">Plain text</div><pre class="slate-CodeBlockElement slate-code_block"><textarea id="publishedPageCodeblock" style="display:none !important; visibility: hidden; opacity: 0; width: 1px; height: 1px;" type="hidden"> </textarea><code class="language-javascript keep-markup drop-tokens"><div class="slate-code_line">function generateHMAC(apiKey, secret, requestBody)</div><div class="slate-code_line">{</div><div class="slate-code_line">    var time = new Date().getTime();</div><div class="slate-code_line">    var rawSignature = apiKey + &quot;:&quot; + time + &quot;:&quot; + requestBody;</div><div class="slate-code_line">    var signature = signHMAC(rawSignature, secret);</div><div class="slate-code_line">    return signature;</div><div class="slate-code_line">}</div><div class="slate-code_line">function signHMAC(rawSignature, secret) {</div><div class="slate-code_line">    const signature = CryptoJS.HmacSHA512(rawSignature, secret);</div><div class="slate-code_line">    const hexSignature = CryptoJS.enc.Hex.stringify(signature);</div><div class="slate-code_line">    return hexSignature;</div><div class="slate-code_line">}</div><div class="slate-code_line"></div></code></pre></div><p class="slate-p " >After generating the HMAC hash, the following headers need to be included in the REST API Request.</p><div class="table-container" style="width:100%;min-width:100%"><table class="slate-table" style="min-width:100%"><div class="published-table-header" style="width:100%;min-width:100%;min-height:initial;visibility: hidden;border:initial"><div style="width:270px;">Title</div><div style="width:470px;">Description</div><div style="width:0px;">Title</div></div><colgroup ><col style="width:270px"><col style="width:470px"><col style="width:initial"></colgroup><tbody class="slate-TableElement-tbody"><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p slate-indent-0" style="0px"><strong class="slate-bold">Field</strong></p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p slate-indent-0" style="0px"><strong class="slate-bold">Description</strong></p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p slate-indent-0" style="0px"><strong class="slate-bold">Example </strong>Value</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p slate-indent-0" style="0px">apikey</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p slate-indent-0" style="0px">The API Key provided by TNS.</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >f9e59e9a72c4322d1f952c803d495f5a5d75ef69e6134947b45513d894935b14</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p slate-indent-0" style="0px">timestamp</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p slate-indent-0" style="0px">The time stamp taken at the time of signing.</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >1715322040</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p slate-indent-0" style="0px">hmac</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Generated HMAC Hash value.</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >e24e1bfe76b1c846c10c3079ea47202913ad04d66a1434b26470010427dda2d9</p></td></div></tr></tbody></table></div><p class="slate-p slate-indent-0" style="0px"></p><p class="slate-p " ></p>

Every request to TNS Gateway API is to be authenticated by HMAC by creating a signature of the request payload using API Key and Secret provided by TNS. 

HMAC should be generated by using SHA512 algorithm.

Here's a simple example of HMAC calculation using JavaScript

, you need to ensure that you have the necessary prerequisites set up, including the proper installation and importation of the 



Include the CryptoJS library in your HTML file: Add the following <script> tag to your HTML file to load CryptoJS from a CDN.

After generating the HMAC hash, the following headers need to be included in the REST API Request.

Description

<p class="slate-p " >An authorization transaction is conducted to validate a card with the cardholder&apos;s issuing bank and confirm the card&apos;s validity and available funds. This process does not instantly transfer funds but temporarily reserves the funds in the cardholder&apos;s account if sufficient fund is available. To complete the transfer from the cardholder&apos;s account to the merchant&apos;s account, the authorized transaction must be captured. The captured amount may be lower than the authorized sum, and merchants can choose to capture portions of the authorized amount on multiple occasions.</p><p class="slate-p " >Also, if the merchant wishes to capture an amount higher than the authorized sum, they have the option to conduct an incremental transaction using the authorized amount as a base and then proceed to capture the total amount comprising the authorized sum and the incremental value.</p><p class="slate-p " >

Authorization transactions are commonly employed by merchants in situations where goods are dispatched post-purchase.</p><p class="slate-p " >

<span style="background-color:rgb(255, 255, 255);color:rgb(23, 43, 77)">The provided transaction sample outlines the necessary mandatory fields for approval.</span></p><p class="slate-p " ></p><p class="slate-p " >For more information on additional functionality and optional fields, see <a href="https://app.theneo.io/tnsi/online-rest-api/resources/request-format" target="_self">Request Format</a>.</p><p class="slate-p " ></p><p class="slate-p " >For more information on all possible responses, success and error codes, see <a href="https://app.theneo.io/tnsi/online-rest-api/resources/response-format" target="_self">Response Format</a>.</p><p class="slate-p " ></p><p class="slate-p slate-indent-0" style="0px">All REST API calls are authenticated using HMAC. See <a href="https://app.theneo.io/tnsi/online-rest-api/authentication/authentication-headers" target="_self">Authentication Headers</a> section to learn how to sign the payload using HMAC and the mandatory headers required for each request.</p><p class="slate-p slate-indent-0" style="0px"></p><div class="slate-div"></div><p class="slate-p " ></p><div class="slate-div"></div><p class="slate-p " ></p><p class="slate-p " ></p><p class="slate-p " ></p>

An authorization transaction is conducted to validate a card with the cardholder's issuing bank and confirm the card's validity and available funds. This process does not instantly transfer funds but temporarily reserves the funds in the cardholder's account if sufficient fund is available. To complete the transfer from the cardholder's account to the merchant's account, the authorized transaction must be captured. The captured amount may be lower than the authorized sum, and merchants can choose to capture portions of the authorized amount on multiple occasions.

Also, if the merchant wishes to capture an amount higher than the authorized sum, they have the option to conduct an incremental transaction using the authorized amount as a base and then proceed to capture the total amount comprising the authorized sum and the incremental value.



Authorization transactions are commonly employed by merchants in situations where goods are dispatched post-purchase.

The provided transaction sample outlines the necessary mandatory fields for approval.

For more information on additional functionality and optional fields, see 

For more information on all possible responses, success and error codes, see 

All REST API calls are authenticated using HMAC. See 

 section to learn how to sign the payload using HMAC and the mandatory headers required for each request.

The identifier for the transaction in your system formatted as a string.

clientTransactionId

This is the effective date of the transaction in UTC formatted as YYYYMMDDHHmmss.

transactionDate

This allows you to specify whether this a credit or debit transaction. This is formatted as string and always in uppercase.

tenderType

This is used to specify from which channel the this transaction originated. We'll do a credit card request for now.

paymentChannel

orderInformation

paymentInformation

merchant

Transaction authorized date time in UTC format. This is when the transaction was approved by the acquirer

authorizedDate

An unique identifier for the transaction generated by TNS. Use this transactionId for all follow-up transactions.

transactionId

6 digit System Trace Audit Number which was passed in the request.

stan

This is an unique transaction Identifier which was provided in the transaction request.

This is the effective date of the transaction in UTC formatted as string.

Transaction Tender type. Same value is returned which was passed during the request.

TNS generated response code for the transaction. For list of all response code please refer the Response Code section.

tnsResponseCode

TNS generated response text. For all the response text please refer the Response Code section in the document.

tnsResponseText

hostResponseCode

hostResponseText

The id of the network processed the transaction.

networkId

Transaction settlement date generated by TNS.

settlementDate

This is the unique identifier assigned to this transaction request once it is received by the TNS system.

x_request_id

amount

card

Transaction receipt number generated by TNS.

receiptData

Transaction Authorization Code provided by the acquirer

authCode

The token value generated for the account number provided in this transaction can be used in place of the real account number to process transactions within our system for the same merchant associated with this transaction.

token

This is the response code from our system for the failure of the transaction. Response code and response text can be viewed in our Response Codes section of this documentation.

This is the response text from our system for the failure of the transaction. Response code and response text can be viewed in our Response Codes section of this documentation.

Array of invalid fields and reason for failure.

fieldErrors

The server is temporarily unavailable. Please try again later. 

<p class="slate-p " >A sale transaction can be explained as authorization and capture of funds at the same time. The sale transactions are usually used by merchants who deliver the goods almost immediately like retail stores where the customer receives the goods immediately.</p><p class="slate-p " >In ecommerce scenario, the user or the cardholder directly enters the card data during the checkout process. In the payment information section of the request, the card details are provided in the respective fields. The sample transaction here lists the required mandatory fields to get the transaction approved. </p><p class="slate-p " ><span style="background-color:rgb(255, 255, 255);color:rgb(23, 43, 77)">The provided transaction sample outlines the necessary mandatory fields for approval.</span></p><p class="slate-p " ></p><p class="slate-p " >For more info on additional functionality and optional fields, see <a href="https://app.theneo.io/tnsi/online-rest-api/resources/request-format" target="_self">Request Format</a>.</p><p class="slate-p " ></p><p class="slate-p " >For more information on all possible responses, success and error codes, see <a href="https://app.theneo.io/tnsi/online-rest-api/resources/response-format" target="_self">Response Format</a>.</p><p class="slate-p slate-indent-0" style="0px"></p><p class="slate-p slate-indent-0" style="0px">All REST API calls are authenticated using HMAC. See the <a href="https://app.theneo.io/tnsi/online-rest-api/authentication/authentication-headers" target="_self">Authentication Headers</a> section to learn how to sign the payload using HMAC and the mandatory headers required for each request.</p><p class="slate-p slate-indent-0" style="0px"></p><div class="slate-div"></div><p class="slate-p " ></p><div class="slate-div"></div><p class="slate-p " ></p><p class="slate-p " ></p><p class="slate-p " ></p>

A sale transaction can be explained as authorization and capture of funds at the same time. The sale transactions are usually used by merchants who deliver the goods almost immediately like retail stores where the customer receives the goods immediately.

In ecommerce scenario, the user or the cardholder directly enters the card data during the checkout process. In the payment information section of the request, the card details are provided in the respective fields. The sample transaction here lists the required mandatory fields to get the transaction approved. 

For more info on additional functionality and optional fields, see 

All REST API calls are authenticated using HMAC. See the 

<p class="slate-p " >A refund transaction is where the merchant has to return the money to the customer. <span style="color:rgb(0, 0, 0)">It allows merchants to reimburse customers for returned merchandise, canceled services, or other situations where a refund is warranted.</span></p><p class="slate-p " ><span style="color:rgb(0, 0, 0)">An unlinked refund, also known as a standalone refund or independent refund or credit transaction, is a type of refund transaction where the refund amount is not directly associated with a specific previous transaction. Instead, it is processed as a separate, standalone refund transaction without any direct reference to a previous purchase.</span></p><p class="slate-p " ><span style="color:rgb(0, 0, 0)">Unlinked refunds are commonly used in situations where the refund amount is not tied to a specific previous transaction or where the merchant prefers to process refunds independently of the original transaction. For example, if a customer requests a refund for a subscription fee or membership dues, the merchant may issue an unlinked refund without referencing a specific purchase transaction.</span></p><p class="slate-p " ><span style="background-color:rgb(255, 255, 255);color:rgb(23, 43, 77)">The provided transaction sample outlines the necessary mandatory fields for approval.</span></p><p class="slate-p " ></p><p class="slate-p " >For more info on additional functionality and optional fields, see <a href="https://app.theneo.io/tnsi/online-rest-api/resources/request-format" target="_self">Request Format</a>.</p><p class="slate-p " ></p><p class="slate-p " >For more information on all possible responses, success and error codes, see <a href="https://app.theneo.io/tnsi/online-rest-api/resources/response-format" target="_self">Response Format</a>.</p><p class="slate-p " ></p><p class="slate-p slate-indent-0" style="0px">All REST API calls are authenticated using HMAC. See the <a href="https://app.theneo.io/tnsi/online-rest-api/authentication/authentication-headers" target="_self">Authentication Headers</a> section to learn how to sign the payload using HMAC and the mandatory headers required for each request.</p><p class="slate-p slate-indent-0" style="0px"></p><div class="slate-div"></div><p class="slate-p " ></p><div class="slate-div"></div><p class="slate-p " ></p><p class="slate-p " ></p><p class="slate-p " ></p>

A refund transaction is where the merchant has to return the money to the customer. 

It allows merchants to reimburse customers for returned merchandise, canceled services, or other situations where a refund is warranted.

An unlinked refund, also known as a standalone refund or independent refund or credit transaction, is a type of refund transaction where the refund amount is not directly associated with a specific previous transaction. Instead, it is processed as a separate, standalone refund transaction without any direct reference to a previous purchase.

Unlinked refunds are commonly used in situations where the refund amount is not tied to a specific previous transaction or where the merchant prefers to process refunds independently of the original transaction. For example, if a customer requests a refund for a subscription fee or membership dues, the merchant may issue an unlinked refund without referencing a specific purchase transaction.

The identifier for the transaction in your system formatted as a string

<p class="slate-p " >An authorization transaction is conducted to validate a card with the cardholder&apos;s issuing bank and confirm the card&apos;s validity and available funds. This process does not instantly transfer funds but temporarily reserves the funds in the cardholder&apos;s account if sufficient fund is available. To complete the transfer from the cardholder&apos;s account to the merchant&apos;s account, the authorized transaction must be captured. The captured amount may be lower than the authorized sum, and merchants can choose to capture portions of the authorized amount on multiple occasions.</p><p class="slate-p " >Also, if the merchant wishes to capture an amount higher than the authorized sum, they have the option to conduct an incremental transaction using the authorized amount as a base and then proceed to capture the total amount comprising the authorized sum and the incremental value.</p><p class="slate-p " >

Authorization transactions are commonly employed by merchants in situations where goods are dispatched post-purchase.</p><p class="slate-p " >
In token-based authorization, card information is not required. <span style="background-color:rgb(255, 255, 255);color:rgb(23, 43, 77)">Instead, a token value must be provided, which can be acquired from any previous transactions.</span></p><p class="slate-p " ><span style="background-color:rgb(255, 255, 255);color:rgb(23, 43, 77)">The provided transaction sample outlines the necessary mandatory fields for approval.</span></p><p class="slate-p " ></p><p class="slate-p " >For more information on additional functionality and optional fields, see <a href="https://app.theneo.io/tnsi/online-rest-api/resources/request-format" target="_self">Request Format</a>.</p><p class="slate-p " ></p><p class="slate-p " >For more information on all possible responses, success and error codes, see <a href="https://app.theneo.io/tnsi/online-rest-api/resources/response-format" target="_self">Response Format</a>.</p><p class="slate-p " ></p><p class="slate-p slate-indent-0" style="0px">All REST API calls are authenticated using HMAC. See <a href="https://app.theneo.io/tnsi/online-rest-api/authentication/authentication-headers" target="_self">Authentication Headers</a> section to learn how to sign the payload using HMAC and the mandatory headers required for each request.</p><p class="slate-p slate-indent-0" style="0px"></p><div class="slate-div"></div><p class="slate-p " ></p><div class="slate-div"></div><p class="slate-p " ></p><p class="slate-p " ></p><p class="slate-p " ></p>


In token-based authorization, card information is not required. 

Instead, a token value must be provided, which can be acquired from any previous transactions.

<p class="slate-p " >A sale transaction can be explained as authorization and capture of funds at the same time. The sale transactions are usually used by merchants who deliver the goods almost immediately like retail stores where the customer receives the goods immediately.</p><p class="slate-p " >In token-based sale transactions, card information is not required. <span style="background-color:rgb(255, 255, 255);color:rgb(23, 43, 77)">Instead, a token value must be provided, which can be acquired from any previous transactions.</span></p><p class="slate-p " ><span style="background-color:rgb(255, 255, 255);color:rgb(23, 43, 77)">The provided transaction sample outlines the necessary mandatory fields for approval.</span></p><p class="slate-p " ></p><p class="slate-p " >For more info on additional functionality and optional fields, see <a href="https://app.theneo.io/tnsi/online-rest-api/resources/request-format" target="_self">Request Format</a>.</p><p class="slate-p " ></p><p class="slate-p " >For more information on all possible responses, success and error codes, see <a href="https://app.theneo.io/tnsi/online-rest-api/resources/response-format" target="_self">Response Format</a>.</p><p class="slate-p " ></p><p class="slate-p slate-indent-0" style="0px">All REST API calls are authenticated using HMAC. See the <a href="https://app.theneo.io/tnsi/online-rest-api/authentication/authentication-headers" target="_self">Authentication Headers</a> section to learn how to sign the payload using HMAC and the mandatory headers required for each request.</p><p class="slate-p slate-indent-0" style="0px"></p><div class="slate-div"></div><p class="slate-p " ></p><div class="slate-div"></div><p class="slate-p " ></p><p class="slate-p " ></p><p class="slate-p " ></p>

In token-based sale transactions, card information is not required. 

responseSource

<p class="slate-p " >A refund transaction is where the merchant has to return the money to the customer. <span style="color:rgb(0, 0, 0)">It allows merchants to reimburse customers for returned merchandise, canceled services, or other situations where a refund is warranted.</span></p><p class="slate-p " ><span style="color:rgb(0, 0, 0)">An unlinked refund, also known as a standalone refund or independent refund or credit transaction, is a type of refund transaction where the refund amount is not directly associated with a specific previous transaction. Instead, it is processed as a separate, standalone refund transaction without any direct reference to a previous purchase.</span></p><p class="slate-p " ><span style="color:rgb(0, 0, 0)">Unlinked refunds are commonly used in situations where the refund amount is not tied to a specific previous transaction or where the merchant prefers to process refunds independently of the original transaction. For example, if a customer requests a refund for a subscription fee or membership dues, the merchant may issue an unlinked refund without referencing a specific purchase transaction.</span></p><p class="slate-p " >In token-based refund transactions, card information is not required. <span style="background-color:rgb(255, 255, 255);color:rgb(23, 43, 77)">Instead, a token value must be provided, which can be acquired from any previous transactions.</span></p><p class="slate-p " ><span style="background-color:rgb(255, 255, 255);color:rgb(23, 43, 77)">The provided transaction sample outlines the necessary mandatory fields for approval.</span></p><p class="slate-p " ></p><p class="slate-p " >For more info on additional functionality and optional fields, see <a href="https://app.theneo.io/tnsi/online-rest-api/resources/request-format" target="_self">Request Format</a>.</p><p class="slate-p " ></p><p class="slate-p " >For more information on all possible responses, success and error codes, see <a href="https://app.theneo.io/tnsi/online-rest-api/resources/response-format" target="_self">Response Format</a>.</p><p class="slate-p " ></p><p class="slate-p slate-indent-0" style="0px">All REST API calls are authenticated using HMAC. See the <a href="https://app.theneo.io/tnsi/online-rest-api/authentication/authentication-headers" target="_self">Authentication Headers</a> section to learn how to sign the payload using HMAC and the mandatory headers required for each request.</p><p class="slate-p slate-indent-0" style="0px"></p><div class="slate-div"></div><p class="slate-p " ></p><div class="slate-div"></div><p class="slate-p " ></p><p class="slate-p " ></p><p class="slate-p " ></p>

In token-based refund transactions, card information is not required. 

The server is temporarily unavailable. Please try again later.

<p class="slate-p " >A capture or otherwise known as completion transaction, is to finalize the original authorization transaction. The original authorization transaction identifier and the authorized amount are mandatory to process a capture transaction.</p><p class="slate-p " ></p><p class="slate-p " >For more info on additional functionality and optional fields, see <a href="https://app.theneo.io/tnsi/online-rest-api/resources/request-format" target="_self">Request Format</a>.</p><p class="slate-p " ></p><p class="slate-p " >For more information on all possible responses, success and error codes, see <a href="https://app.theneo.io/tnsi/online-rest-api/resources/response-format" target="_self">Response Format</a>.</p><p class="slate-p " ></p><p class="slate-p slate-indent-0" style="0px">All REST API calls are authenticated using HMAC. See <a href="https://app.theneo.io/tnsi/online-rest-api/authentication/authentication-headers" target="_self">Authentication Headers</a> section to learn how to sign the payload using HMAC and the mandatory headers required for each request.</p><p class="slate-p slate-indent-0" style="0px"></p><p class="slate-p slate-indent-0" style="0px"><span style="background-color:rgb(255, 255, 255);color:rgb(56, 67, 91)">To test this sample capture request, start by initiating an </span><a href="https://app.theneo.io/tnsi/point-of-sale/authorization-transactions/authorization-using-emv-chip" target="_self">authorize</a><span style="background-color:rgb(255, 255, 255);color:rgb(56, 67, 91)"> transaction. Upon approval of the authorize transaction, retrieve the </span><span style="color:rgb(56, 67, 91)"><code class="slate-code">transactionId</code></span><span style="color:rgb(56, 67, 91)"> </span><span style="background-color:rgb(255, 255, 255);color:rgb(56, 67, 91)">&amp; </span><span style="color:rgb(56, 67, 91)"><code class="slate-code">approvedAmount</code></span><span style="color:rgb(56, 67, 91)"> </span><span style="background-color:rgb(255, 255, 255);color:rgb(56, 67, 91)">from the response. Use the </span><span style="color:rgb(56, 67, 91)"><code class="slate-code">transactionId</code></span><span style="color:rgb(56, 67, 91)"> </span><span style="background-color:rgb(255, 255, 255);color:rgb(56, 67, 91)">as the </span><span style="color:rgb(56, 67, 91)"><code class="slate-code">originalTransactionId</code></span><span style="color:rgb(56, 67, 91)"> </span><span style="background-color:rgb(255, 255, 255);color:rgb(56, 67, 91)">and </span><span style="color:rgb(56, 67, 91)"><code class="slate-code">approvedAmount</code></span><span style="color:rgb(56, 67, 91)"> </span><span style="background-color:rgb(255, 255, 255);color:rgb(56, 67, 91)">as the </span><span style="color:rgb(56, 67, 91)"><code class="slate-code">originalTransactionAmount</code></span><span style="color:rgb(56, 67, 91)"> </span><span style="background-color:rgb(255, 255, 255);color:rgb(56, 67, 91)">before proceeding with the transaction. Use </span><code class="slate-code">transactionAmount</code> to capture the desired transaction value.
</p><div style="width:100%;
	min-width:100%;" class="callout-widget" data-type=info ><div class="callout-icon"><svg width="20" height="20" viewBox="0 0 20 20" fill="none" xmlns="http://www.w3.org/2000/svg"><path d="M10.0628 14.1676C10.2434 14.1676 10.3927 14.1086 10.5107 13.9905C10.6288 13.8725 10.6878 13.7232 10.6878 13.5426V9.77177C10.6878 9.6051 10.6253 9.46274 10.5003 9.34469C10.3753 9.22663 10.2295 9.1676 10.0628 9.1676C9.88227 9.1676 9.73296 9.22663 9.61491 9.34469C9.49685 9.46274 9.43783 9.61205 9.43783 9.7926V13.5634C9.43783 13.7301 9.50033 13.8725 9.62533 13.9905C9.75033 14.1086 9.89616 14.1676 10.0628 14.1676ZM10.0003 7.62594C10.1948 7.62594 10.358 7.56344 10.4899 7.43844C10.6219 7.31344 10.6878 7.15371 10.6878 6.95927C10.6878 6.76482 10.6219 6.59816 10.4899 6.45927C10.358 6.32038 10.1948 6.25094 10.0003 6.25094C9.80588 6.25094 9.64269 6.32038 9.51074 6.45927C9.3788 6.59816 9.31283 6.76482 9.31283 6.95927C9.31283 7.15371 9.3788 7.31344 9.51074 7.43844C9.64269 7.56344 9.80588 7.62594 10.0003 7.62594ZM10.0003 18.3343C8.81977 18.3343 7.72255 18.1225 6.70866 17.6989C5.69477 17.2752 4.81283 16.6884 4.06283 15.9384C3.31283 15.1884 2.72602 14.3065 2.30241 13.2926C1.8788 12.2787 1.66699 11.1815 1.66699 10.0009C1.66699 8.83427 1.8788 7.74399 2.30241 6.7301C2.72602 5.71621 3.31283 4.83427 4.06283 4.08427C4.81283 3.33427 5.69477 2.74399 6.70866 2.31344C7.72255 1.88288 8.81977 1.6676 10.0003 1.6676C11.167 1.6676 12.2573 1.88288 13.2712 2.31344C14.285 2.74399 15.167 3.33427 15.917 4.08427C16.667 4.83427 17.2573 5.71621 17.6878 6.7301C18.1184 7.74399 18.3337 8.83427 18.3337 10.0009C18.3337 11.1815 18.1184 12.2787 17.6878 13.2926C17.2573 14.3065 16.667 15.1884 15.917 15.9384C15.167 16.6884 14.285 17.2752 13.2712 17.6989C12.2573 18.1225 11.167 18.3343 10.0003 18.3343ZM10.0003 17.0843C11.9448 17.0843 13.6114 16.3898 15.0003 15.0009C16.3892 13.612 17.0837 11.9454 17.0837 10.0009C17.0837 8.05649 16.3892 6.38982 15.0003 5.00094C13.6114 3.61205 11.9448 2.9176 10.0003 2.9176C8.05588 2.9176 6.38921 3.61205 5.00033 5.00094C3.61144 6.38982 2.91699 8.05649 2.91699 10.0009C2.91699 11.9454 3.61144 13.612 5.00033 15.0009C6.38921 16.3898 8.05588 17.0843 10.0003 17.0843Z" fill="#3960B4"></path></svg></div><div ><p class="slate-p " >Entry mode is optional for capture transactions. The system will utilize the entry mode of the original transaction unless specifically overwritten in the request.</p></div></div><div class="slate-div"></div><p class="slate-p " ></p><div class="slate-div"></div><p class="slate-p " ></p><p class="slate-p " ></p><p class="slate-p " ></p>

A capture or otherwise known as completion transaction, is to finalize the original authorization transaction. The original authorization transaction identifier and the authorized amount are mandatory to process a capture transaction.

To test this sample capture request, start by initiating an 

 transaction. Upon approval of the authorize transaction, retrieve the 

before proceeding with the transaction. Use 

 to capture the desired transaction value.


originalTransaction

<p class="slate-p " >A refund transaction is where the merchant has to return the money to the customer. <span style="color:rgb(0, 0, 0)">It allows merchants to reimburse customers for returned merchandise, canceled services, or other situations where a refund is warranted. In the linked refund original transaction identifier has to be provided. A linked refund can be a partial or full amount of the original transaction. There can be multiple partially linked refunds for a single transaction.</span></p><p class="slate-p " ></p><p class="slate-p " >For more info on additional functionality and optional fields, see <a href="https://app.theneo.io/tnsi/online-rest-api/resources/request-format" target="_self">Request Format</a>.</p><p class="slate-p " ></p><p class="slate-p " >For more information on all possible responses, success and error codes, see <a href="https://app.theneo.io/tnsi/online-rest-api/resources/response-format" target="_self">Response Format</a>.</p><p class="slate-p " ></p><p class="slate-p slate-indent-0" style="0px">All REST API calls are authenticated using HMAC. Please refer to the <a href="https://app.theneo.io/tnsi/online-rest-api/authentication/authentication-headers" target="_self">Authentication Headers</a> section to learn how to sign the payload using HMAC and the mandatory headers required for each request.</p><p class="slate-p slate-indent-0" style="0px"></p><p class="slate-p slate-indent-0" style="0px"><span style="background-color:rgb(255, 255, 255);color:rgb(56, 67, 91)">To test this sample linked refund request, start by initiating a </span><a href="https://app.theneo.io/tnsi/point-of-sale/sale-transactions/sale-using-emv-chip" target="_self">sale</a><span style="background-color:rgb(255, 255, 255);color:rgb(56, 67, 91)"> transaction. Upon approval of the sale transaction, retrieve the </span><span style="color:rgb(56, 67, 91)"><code class="slate-code">transactionId </code></span><span style="background-color:rgb(255, 255, 255);color:rgb(56, 67, 91)">&amp; </span><span style="color:rgb(56, 67, 91)"><code class="slate-code">approvedAmount </code></span><span style="background-color:rgb(255, 255, 255);color:rgb(56, 67, 91)">from the response. Use the </span><span style="color:rgb(56, 67, 91)"><code class="slate-code">transactionId </code></span><span style="background-color:rgb(255, 255, 255);color:rgb(56, 67, 91)">as the </span><span style="color:rgb(56, 67, 91)"><code class="slate-code">originalTransactionId </code></span><span style="background-color:rgb(255, 255, 255);color:rgb(56, 67, 91)">and </span><span style="color:rgb(56, 67, 91)"><code class="slate-code">approvedAmount </code></span><span style="background-color:rgb(255, 255, 255);color:rgb(56, 67, 91)">as the </span><span style="color:rgb(56, 67, 91)"><code class="slate-code">originalTransactionAmount </code></span><span style="background-color:rgb(255, 255, 255);color:rgb(56, 67, 91)">before proceeding with the transaction.</span></p><p class="slate-p " ></p><div style="width:100%;
	min-width:100%;" class="callout-widget" data-type=info ><div class="callout-icon"><svg width="20" height="20" viewBox="0 0 20 20" fill="none" xmlns="http://www.w3.org/2000/svg"><path d="M10.0628 14.1676C10.2434 14.1676 10.3927 14.1086 10.5107 13.9905C10.6288 13.8725 10.6878 13.7232 10.6878 13.5426V9.77177C10.6878 9.6051 10.6253 9.46274 10.5003 9.34469C10.3753 9.22663 10.2295 9.1676 10.0628 9.1676C9.88227 9.1676 9.73296 9.22663 9.61491 9.34469C9.49685 9.46274 9.43783 9.61205 9.43783 9.7926V13.5634C9.43783 13.7301 9.50033 13.8725 9.62533 13.9905C9.75033 14.1086 9.89616 14.1676 10.0628 14.1676ZM10.0003 7.62594C10.1948 7.62594 10.358 7.56344 10.4899 7.43844C10.6219 7.31344 10.6878 7.15371 10.6878 6.95927C10.6878 6.76482 10.6219 6.59816 10.4899 6.45927C10.358 6.32038 10.1948 6.25094 10.0003 6.25094C9.80588 6.25094 9.64269 6.32038 9.51074 6.45927C9.3788 6.59816 9.31283 6.76482 9.31283 6.95927C9.31283 7.15371 9.3788 7.31344 9.51074 7.43844C9.64269 7.56344 9.80588 7.62594 10.0003 7.62594ZM10.0003 18.3343C8.81977 18.3343 7.72255 18.1225 6.70866 17.6989C5.69477 17.2752 4.81283 16.6884 4.06283 15.9384C3.31283 15.1884 2.72602 14.3065 2.30241 13.2926C1.8788 12.2787 1.66699 11.1815 1.66699 10.0009C1.66699 8.83427 1.8788 7.74399 2.30241 6.7301C2.72602 5.71621 3.31283 4.83427 4.06283 4.08427C4.81283 3.33427 5.69477 2.74399 6.70866 2.31344C7.72255 1.88288 8.81977 1.6676 10.0003 1.6676C11.167 1.6676 12.2573 1.88288 13.2712 2.31344C14.285 2.74399 15.167 3.33427 15.917 4.08427C16.667 4.83427 17.2573 5.71621 17.6878 6.7301C18.1184 7.74399 18.3337 8.83427 18.3337 10.0009C18.3337 11.1815 18.1184 12.2787 17.6878 13.2926C17.2573 14.3065 16.667 15.1884 15.917 15.9384C15.167 16.6884 14.285 17.2752 13.2712 17.6989C12.2573 18.1225 11.167 18.3343 10.0003 18.3343ZM10.0003 17.0843C11.9448 17.0843 13.6114 16.3898 15.0003 15.0009C16.3892 13.612 17.0837 11.9454 17.0837 10.0009C17.0837 8.05649 16.3892 6.38982 15.0003 5.00094C13.6114 3.61205 11.9448 2.9176 10.0003 2.9176C8.05588 2.9176 6.38921 3.61205 5.00033 5.00094C3.61144 6.38982 2.91699 8.05649 2.91699 10.0009C2.91699 11.9454 3.61144 13.612 5.00033 15.0009C6.38921 16.3898 8.05588 17.0843 10.0003 17.0843Z" fill="#3960B4"></path></svg></div><div ><p class="slate-p " >Entry mode is optional for linked-refund transactions. The system will utilize the entry mode of the original transaction unless specifically overwritten in the request.</p></div></div><div class="slate-div"></div><p class="slate-p " ></p><div class="slate-div"></div><p class="slate-p " ></p><p class="slate-p " ></p><p class="slate-p " ></p>

It allows merchants to reimburse customers for returned merchandise, canceled services, or other situations where a refund is warranted. In the linked refund original transaction identifier has to be provided. A linked refund can be a partial or full amount of the original transaction. There can be multiple partially linked refunds for a single transaction.

All REST API calls are authenticated using HMAC. Please refer to the 

To test this sample linked refund request, start by initiating a 

 transaction. Upon approval of the sale transaction, retrieve the 

<p class="slate-p slate-indent-0" style="0px">Reversal, also known as authorization reversal, occurs when an authorization is initially granted but subsequently reversed, either in full or in part, due to factors such as product/service unavailability, fraudulent transactions, or customer change of mind.</p><p class="slate-p slate-indent-0" style="0px"></p><p class="slate-p " >For more info on additional functionality and optional fields, see our full request functionality at <a href="https://app.theneo.io/tnsi/online-rest-api/resources/request-format" target="_self">Request Format</a>.</p><p class="slate-p " ></p><p class="slate-p " >For more information on all possible responses, success and error codes, see <a href="https://app.theneo.io/tnsi/online-rest-api/resources/response-format" target="_self">Response Format</a>.</p><p class="slate-p " ></p><p class="slate-p slate-indent-0" style="0px">All REST API calls are authenticated using HMAC. Please refer to the <a href="https://app.theneo.io/tnsi/online-rest-api/authentication/authentication-headers" target="_self">Authentication Headers</a> section to learn how to sign the payload using HMAC and the mandatory headers required for each request.</p><p class="slate-p slate-indent-0" style="0px"></p><p class="slate-p slate-indent-0" style="0px"><span style="background-color:rgb(255, 255, 255);color:rgb(56, 67, 91)">To test this sample reversal request, start by initiating an </span><a href="https://app.theneo.io/tnsi/point-of-sale/authorization-transactions/authorization-using-emv-chip" target="_self">authorize</a><span style="background-color:rgb(255, 255, 255);color:rgb(56, 67, 91)"> transaction. Upon approval of the authorize transaction, retrieve the </span><span style="color:rgb(56, 67, 91)"><code class="slate-code">transactionId </code></span><span style="background-color:rgb(255, 255, 255);color:rgb(56, 67, 91)">&amp; </span><span style="color:rgb(56, 67, 91)"><code class="slate-code">approvedAmount </code></span><span style="background-color:rgb(255, 255, 255);color:rgb(56, 67, 91)">from the response. Use the </span><span style="color:rgb(56, 67, 91)"><code class="slate-code">transactionId </code></span><span style="background-color:rgb(255, 255, 255);color:rgb(56, 67, 91)">as the </span><span style="color:rgb(56, 67, 91)"><code class="slate-code">originalTransactionId </code></span><span style="background-color:rgb(255, 255, 255);color:rgb(56, 67, 91)">and </span><span style="color:rgb(56, 67, 91)"><code class="slate-code">approvedAmount </code></span><span style="background-color:rgb(255, 255, 255);color:rgb(56, 67, 91)">as the </span><span style="color:rgb(56, 67, 91)"><code class="slate-code">originalTransactionAmount </code></span><span style="background-color:rgb(255, 255, 255);color:rgb(56, 67, 91)">before proceeding with the transaction.</span></p><p class="slate-p " ></p><div style="width:100%;
	min-width:100%;" class="callout-widget" data-type=info ><div class="callout-icon"><svg width="20" height="20" viewBox="0 0 20 20" fill="none" xmlns="http://www.w3.org/2000/svg"><path d="M10.0628 14.1676C10.2434 14.1676 10.3927 14.1086 10.5107 13.9905C10.6288 13.8725 10.6878 13.7232 10.6878 13.5426V9.77177C10.6878 9.6051 10.6253 9.46274 10.5003 9.34469C10.3753 9.22663 10.2295 9.1676 10.0628 9.1676C9.88227 9.1676 9.73296 9.22663 9.61491 9.34469C9.49685 9.46274 9.43783 9.61205 9.43783 9.7926V13.5634C9.43783 13.7301 9.50033 13.8725 9.62533 13.9905C9.75033 14.1086 9.89616 14.1676 10.0628 14.1676ZM10.0003 7.62594C10.1948 7.62594 10.358 7.56344 10.4899 7.43844C10.6219 7.31344 10.6878 7.15371 10.6878 6.95927C10.6878 6.76482 10.6219 6.59816 10.4899 6.45927C10.358 6.32038 10.1948 6.25094 10.0003 6.25094C9.80588 6.25094 9.64269 6.32038 9.51074 6.45927C9.3788 6.59816 9.31283 6.76482 9.31283 6.95927C9.31283 7.15371 9.3788 7.31344 9.51074 7.43844C9.64269 7.56344 9.80588 7.62594 10.0003 7.62594ZM10.0003 18.3343C8.81977 18.3343 7.72255 18.1225 6.70866 17.6989C5.69477 17.2752 4.81283 16.6884 4.06283 15.9384C3.31283 15.1884 2.72602 14.3065 2.30241 13.2926C1.8788 12.2787 1.66699 11.1815 1.66699 10.0009C1.66699 8.83427 1.8788 7.74399 2.30241 6.7301C2.72602 5.71621 3.31283 4.83427 4.06283 4.08427C4.81283 3.33427 5.69477 2.74399 6.70866 2.31344C7.72255 1.88288 8.81977 1.6676 10.0003 1.6676C11.167 1.6676 12.2573 1.88288 13.2712 2.31344C14.285 2.74399 15.167 3.33427 15.917 4.08427C16.667 4.83427 17.2573 5.71621 17.6878 6.7301C18.1184 7.74399 18.3337 8.83427 18.3337 10.0009C18.3337 11.1815 18.1184 12.2787 17.6878 13.2926C17.2573 14.3065 16.667 15.1884 15.917 15.9384C15.167 16.6884 14.285 17.2752 13.2712 17.6989C12.2573 18.1225 11.167 18.3343 10.0003 18.3343ZM10.0003 17.0843C11.9448 17.0843 13.6114 16.3898 15.0003 15.0009C16.3892 13.612 17.0837 11.9454 17.0837 10.0009C17.0837 8.05649 16.3892 6.38982 15.0003 5.00094C13.6114 3.61205 11.9448 2.9176 10.0003 2.9176C8.05588 2.9176 6.38921 3.61205 5.00033 5.00094C3.61144 6.38982 2.91699 8.05649 2.91699 10.0009C2.91699 11.9454 3.61144 13.612 5.00033 15.0009C6.38921 16.3898 8.05588 17.0843 10.0003 17.0843Z" fill="#3960B4"></path></svg></div><div ><p class="slate-p " >Entry mode is optional for reversal transactions. The system will utilize the entry mode of the original transaction unless specifically overwritten in the request.</p></div></div><div class="slate-div"></div><p class="slate-p " ></p><div class="slate-div"></div><p class="slate-p " ></p><p class="slate-p " ></p><p class="slate-p " ></p>

Reversal, also known as authorization reversal, occurs when an authorization is initially granted but subsequently reversed, either in full or in part, due to factors such as product/service unavailability, fraudulent transactions, or customer change of mind.

For more info on additional functionality and optional fields, see our full request functionality at 

To test this sample reversal request, start by initiating an 

<p class="slate-p " >Void transactions are conducted on a sale transaction. To reverse a sale transaction before settlement takes place, the merchant must initiate a void transaction, referencing the original sale transaction. The void transaction amount should exactly match the original transaction amount. Partial void is not supported by the system.</p><p class="slate-p " ></p><p class="slate-p " >For more info on additional functionality and optional fields, see <a href="https://app.theneo.io/tnsi/point-of-sale/resources/request-format" target="_self">Request Format</a>.</p><p class="slate-p " ></p><p class="slate-p " >For more information on all possible responses, success and error codes, see <a href="https://app.theneo.io/tnsi/point-of-sale/resources/response-format" target="_self">Response Format</a>.</p><p class="slate-p " ></p><p class="slate-p slate-indent-0" style="0px">All REST API calls are authenticated using HMAC. See the <a href="https://app.theneo.io/tnsi/point-of-sale/authentication/authentication-headers" target="_self">Authentication Headers</a> section to learn how to sign the payload using HMAC and the mandatory headers required for each request.</p><p class="slate-p slate-indent-0" style="0px"></p><p class="slate-p slate-indent-0" style="0px"><span style="background-color:rgb(255, 255, 255);color:rgb(56, 67, 91)">To test this sample void request, start by initiating a </span><a href="https://app.theneo.io/tnsi/point-of-sale/sale-transactions/sale-using-emv-chip" target="_self">sale</a><span style="background-color:rgb(255, 255, 255);color:rgb(56, 67, 91)"> transaction. Upon approval of the sale transaction, retrieve the </span><span style="color:rgb(56, 67, 91)"><code class="slate-code">transactionId </code></span><span style="background-color:rgb(255, 255, 255);color:rgb(56, 67, 91)">&amp; </span><span style="color:rgb(56, 67, 91)"><code class="slate-code">approvedAmount </code></span><span style="background-color:rgb(255, 255, 255);color:rgb(56, 67, 91)">from the response. Use the </span><span style="color:rgb(56, 67, 91)"><code class="slate-code">transactionId </code></span><span style="background-color:rgb(255, 255, 255);color:rgb(56, 67, 91)">as the </span><span style="color:rgb(56, 67, 91)"><code class="slate-code">originalTransactionId </code></span><span style="background-color:rgb(255, 255, 255);color:rgb(56, 67, 91)">and </span><span style="color:rgb(56, 67, 91)"><code class="slate-code">approvedAmount </code></span><span style="background-color:rgb(255, 255, 255);color:rgb(56, 67, 91)">as the </span><span style="color:rgb(56, 67, 91)"><code class="slate-code">originalTransactionAmount </code></span><span style="background-color:rgb(255, 255, 255);color:rgb(56, 67, 91)">before proceeding with the transaction.</span>
</p><div style="width:100%;
	min-width:100%;" class="callout-widget" data-type=info ><div class="callout-icon"><svg width="20" height="20" viewBox="0 0 20 20" fill="none" xmlns="http://www.w3.org/2000/svg"><path d="M10.0628 14.1676C10.2434 14.1676 10.3927 14.1086 10.5107 13.9905C10.6288 13.8725 10.6878 13.7232 10.6878 13.5426V9.77177C10.6878 9.6051 10.6253 9.46274 10.5003 9.34469C10.3753 9.22663 10.2295 9.1676 10.0628 9.1676C9.88227 9.1676 9.73296 9.22663 9.61491 9.34469C9.49685 9.46274 9.43783 9.61205 9.43783 9.7926V13.5634C9.43783 13.7301 9.50033 13.8725 9.62533 13.9905C9.75033 14.1086 9.89616 14.1676 10.0628 14.1676ZM10.0003 7.62594C10.1948 7.62594 10.358 7.56344 10.4899 7.43844C10.6219 7.31344 10.6878 7.15371 10.6878 6.95927C10.6878 6.76482 10.6219 6.59816 10.4899 6.45927C10.358 6.32038 10.1948 6.25094 10.0003 6.25094C9.80588 6.25094 9.64269 6.32038 9.51074 6.45927C9.3788 6.59816 9.31283 6.76482 9.31283 6.95927C9.31283 7.15371 9.3788 7.31344 9.51074 7.43844C9.64269 7.56344 9.80588 7.62594 10.0003 7.62594ZM10.0003 18.3343C8.81977 18.3343 7.72255 18.1225 6.70866 17.6989C5.69477 17.2752 4.81283 16.6884 4.06283 15.9384C3.31283 15.1884 2.72602 14.3065 2.30241 13.2926C1.8788 12.2787 1.66699 11.1815 1.66699 10.0009C1.66699 8.83427 1.8788 7.74399 2.30241 6.7301C2.72602 5.71621 3.31283 4.83427 4.06283 4.08427C4.81283 3.33427 5.69477 2.74399 6.70866 2.31344C7.72255 1.88288 8.81977 1.6676 10.0003 1.6676C11.167 1.6676 12.2573 1.88288 13.2712 2.31344C14.285 2.74399 15.167 3.33427 15.917 4.08427C16.667 4.83427 17.2573 5.71621 17.6878 6.7301C18.1184 7.74399 18.3337 8.83427 18.3337 10.0009C18.3337 11.1815 18.1184 12.2787 17.6878 13.2926C17.2573 14.3065 16.667 15.1884 15.917 15.9384C15.167 16.6884 14.285 17.2752 13.2712 17.6989C12.2573 18.1225 11.167 18.3343 10.0003 18.3343ZM10.0003 17.0843C11.9448 17.0843 13.6114 16.3898 15.0003 15.0009C16.3892 13.612 17.0837 11.9454 17.0837 10.0009C17.0837 8.05649 16.3892 6.38982 15.0003 5.00094C13.6114 3.61205 11.9448 2.9176 10.0003 2.9176C8.05588 2.9176 6.38921 3.61205 5.00033 5.00094C3.61144 6.38982 2.91699 8.05649 2.91699 10.0009C2.91699 11.9454 3.61144 13.612 5.00033 15.0009C6.38921 16.3898 8.05588 17.0843 10.0003 17.0843Z" fill="#3960B4"></path></svg></div><div ><p class="slate-p " >Entry mode is optional for void transactions. The system will utilize the entry mode of the original transaction unless specifically overwritten in the request.</p></div></div><div class="slate-div"></div><p class="slate-p " ></p><div class="slate-div"></div><p class="slate-p " ></p><p class="slate-p " ></p><p class="slate-p " ></p>

Void transactions are conducted on a sale transaction. To reverse a sale transaction before settlement takes place, the merchant must initiate a void transaction, referencing the original sale transaction. The void transaction amount should exactly match the original transaction amount. Partial void is not supported by the system.

To test this sample void request, start by initiating a 

<p class="slate-p " >An Incremental transaction adjusts the original authorization amount when there is a change in the total transaction amount. This type of transaction is typically used in scenarios where the final cost of goods or services cannot be accurately predicted at the time of the initial authorization.</p><p class="slate-p " ></p><p class="slate-p " >For more info on additional functionality and optional fields, see our full request functionality at <a href="https://app.theneo.io/tnsi/online-rest-api/resources/request-format" target="_self">Request Format</a>.</p><p class="slate-p " ></p><p class="slate-p " >For more information on all possible responses, success and error codes, see <a href="https://app.theneo.io/tnsi/online-rest-api/resources/response-format" target="_self">Response Format</a>.</p><p class="slate-p " ></p><p class="slate-p slate-indent-0" style="0px">All REST API calls are authenticated using HMAC. See the <a href="https://app.theneo.io/tnsi/online-rest-api/authentication/authentication-headers" target="_self">Authentication Headers</a> section to learn how to sign the payload using HMAC and the mandatory headers required for each request.</p><p class="slate-p slate-indent-0" style="0px"></p><p class="slate-p slate-indent-0" style="0px"><span style="background-color:rgb(255, 255, 255);color:rgb(56, 67, 91)">To test this sample incremental request, start by initiating an </span><a href="https://app.theneo.io/tnsi/point-of-sale/authorization-transactions/authorization-using-emv-chip" target="_self">authorize</a><span style="background-color:rgb(255, 255, 255);color:rgb(56, 67, 91)"> transaction. Upon approval of the authorize transaction, retrieve the </span><span style="color:rgb(56, 67, 91)"><code class="slate-code">transactionId </code></span><span style="background-color:rgb(255, 255, 255);color:rgb(56, 67, 91)">&amp; </span><span style="color:rgb(56, 67, 91)"><code class="slate-code">approvedAmount </code></span><span style="background-color:rgb(255, 255, 255);color:rgb(56, 67, 91)">from the response. Use the </span><span style="color:rgb(56, 67, 91)"><code class="slate-code">transactionId </code></span><span style="background-color:rgb(255, 255, 255);color:rgb(56, 67, 91)">as the </span><span style="color:rgb(56, 67, 91)"><code class="slate-code">originalTransactionId </code></span><span style="background-color:rgb(255, 255, 255);color:rgb(56, 67, 91)">and </span><span style="color:rgb(56, 67, 91)"><code class="slate-code">approvedAmount </code></span><span style="background-color:rgb(255, 255, 255);color:rgb(56, 67, 91)">as the </span><span style="color:rgb(56, 67, 91)"><code class="slate-code">originalTransactionAmount </code></span><span style="background-color:rgb(255, 255, 255);color:rgb(56, 67, 91)">before proceeding with the transaction. </span><span style="color:rgb(56, 67, 91)"><code class="slate-code">transactionAmount </code></span><span style="background-color:rgb(255, 255, 255);color:rgb(56, 67, 91)">should be used as the incremented amount.</span>
</p><div style="width:100%;
	min-width:100%;" class="callout-widget" data-type=info ><div class="callout-icon"><svg width="20" height="20" viewBox="0 0 20 20" fill="none" xmlns="http://www.w3.org/2000/svg"><path d="M10.0628 14.1676C10.2434 14.1676 10.3927 14.1086 10.5107 13.9905C10.6288 13.8725 10.6878 13.7232 10.6878 13.5426V9.77177C10.6878 9.6051 10.6253 9.46274 10.5003 9.34469C10.3753 9.22663 10.2295 9.1676 10.0628 9.1676C9.88227 9.1676 9.73296 9.22663 9.61491 9.34469C9.49685 9.46274 9.43783 9.61205 9.43783 9.7926V13.5634C9.43783 13.7301 9.50033 13.8725 9.62533 13.9905C9.75033 14.1086 9.89616 14.1676 10.0628 14.1676ZM10.0003 7.62594C10.1948 7.62594 10.358 7.56344 10.4899 7.43844C10.6219 7.31344 10.6878 7.15371 10.6878 6.95927C10.6878 6.76482 10.6219 6.59816 10.4899 6.45927C10.358 6.32038 10.1948 6.25094 10.0003 6.25094C9.80588 6.25094 9.64269 6.32038 9.51074 6.45927C9.3788 6.59816 9.31283 6.76482 9.31283 6.95927C9.31283 7.15371 9.3788 7.31344 9.51074 7.43844C9.64269 7.56344 9.80588 7.62594 10.0003 7.62594ZM10.0003 18.3343C8.81977 18.3343 7.72255 18.1225 6.70866 17.6989C5.69477 17.2752 4.81283 16.6884 4.06283 15.9384C3.31283 15.1884 2.72602 14.3065 2.30241 13.2926C1.8788 12.2787 1.66699 11.1815 1.66699 10.0009C1.66699 8.83427 1.8788 7.74399 2.30241 6.7301C2.72602 5.71621 3.31283 4.83427 4.06283 4.08427C4.81283 3.33427 5.69477 2.74399 6.70866 2.31344C7.72255 1.88288 8.81977 1.6676 10.0003 1.6676C11.167 1.6676 12.2573 1.88288 13.2712 2.31344C14.285 2.74399 15.167 3.33427 15.917 4.08427C16.667 4.83427 17.2573 5.71621 17.6878 6.7301C18.1184 7.74399 18.3337 8.83427 18.3337 10.0009C18.3337 11.1815 18.1184 12.2787 17.6878 13.2926C17.2573 14.3065 16.667 15.1884 15.917 15.9384C15.167 16.6884 14.285 17.2752 13.2712 17.6989C12.2573 18.1225 11.167 18.3343 10.0003 18.3343ZM10.0003 17.0843C11.9448 17.0843 13.6114 16.3898 15.0003 15.0009C16.3892 13.612 17.0837 11.9454 17.0837 10.0009C17.0837 8.05649 16.3892 6.38982 15.0003 5.00094C13.6114 3.61205 11.9448 2.9176 10.0003 2.9176C8.05588 2.9176 6.38921 3.61205 5.00033 5.00094C3.61144 6.38982 2.91699 8.05649 2.91699 10.0009C2.91699 11.9454 3.61144 13.612 5.00033 15.0009C6.38921 16.3898 8.05588 17.0843 10.0003 17.0843Z" fill="#3960B4"></path></svg></div><div ><p class="slate-p " >Entry mode is optional for void transactions. The system will utilize the entry mode of the original transaction unless specifically overwritten in the request.</p></div></div><div class="slate-div"></div><p class="slate-p " ></p><div class="slate-div"></div><p class="slate-p " ></p><p class="slate-p " ></p><p class="slate-p " ></p>

An Incremental transaction adjusts the original authorization amount when there is a change in the total transaction amount. This type of transaction is typically used in scenarios where the final cost of goods or services cannot be accurately predicted at the time of the initial authorization.

To test this sample incremental request, start by initiating an 

before proceeding with the transaction. 

should be used as the incremented amount.

<p class="slate-p " ></p><div class="table-container" style="width:100%;min-width:100%"><table class="slate-table" style="min-width:100%"><div class="published-table-header" style="width:100%;min-width:100%;"><div style="width:292px;">Field Name</div><div style="width:202px;">Type</div><div style="width:319px;">Required(R), Optional(O), Conditional(C)</div><div style="width:0px;">Description</div></div><colgroup ><col style="width:292px"><col style="width:202px"><col style="width:319px"><col style="width:initial"></colgroup><tbody class="slate-TableElement-tbody"><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " ><strong class="slate-bold">stan</strong></p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >string</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >O</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >6 digit System Trace Audit Number.</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " ><strong class="slate-bold">clientTransactionId</strong></p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >string</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >R</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Client Unique Transaction Identifier. This is the unique identifier that you use to identify transaction in your system.</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " ><strong class="slate-bold">transactionDate</strong></p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >string</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >R</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >This is the effective date of the transaction in UTC formatted as YYYYMMDDHHmmss.</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " ><strong class="slate-bold">tenderType</strong></p><p class="slate-p slate-indent-0" style="0px">Enum values: <code class="slate-code">CREDIT, DEBIT </code></p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >string</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >R</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >This allows you to specify whether this a credit or debit transaction. This is formatted as string and always in uppercase.</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " ><strong class="slate-bold">paymentChannel</strong></p><p class="slate-p slate-indent-0" style="0px">Enum values: <code class="slate-code">CREDITCARD BATCHCREDIT BPAY BPOINT DIRECTDEBIT EFTPOS EFTPOS SWITCH NOPAYMENTS PAYPAL</code></p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >string</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >R</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Specifies the channel a transaction originates. We support credit card request for now.</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " ><strong class="slate-bold">partialAuthIndicator</strong></p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >boolean</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >O</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Flag that indicates whether the transaction is enabled for partial authorization. Default value is always set to true.</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " ><strong class="slate-bold">orderInformation- </strong>The order information contains the transaction amount details and the customer details, including billing address for AVS validation. The Amount section is mandatory for all the transactions.</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " ><strong class="slate-bold">amount</strong></p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >object</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " > </p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " > </p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " ><strong class="slate-bold">     currencyCode</strong></p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >string</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >R</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >This is the ISO 4217 currency code. Use &quot;036&quot; for Australian dollar, &quot;840&quot; for United States dollar, &quot;826&quot; for Pound sterling. Please refer <a href="https://en.wikipedia.org/wiki/ISO_4217" target="_blank">https://en.wikipedia.org/wiki/ISO_4217</a>   for list of all currency codes.</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " ><strong class="slate-bold">     transactionAmount</strong></p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >string</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >R</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >This is the total amount of the transaction converted to the lowest unit of currency formatted as a string. Amount can not be negative. Send the amount without a decimal in it. e.g. $10.25 should be sent as 1025.</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " ><strong class="slate-bold">     surchargeAmount</strong></p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >string</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >O</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >This is the additional amount that you add to the purchase amount. This amount is already included in the transaction amount. Amount can not be negative. Send the amount without a decimal in it. e.g. $1.22 should be sent as 122.</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " ><strong class="slate-bold">paymentInformation</strong></p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >object</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " > </p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " > </p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " ><strong class="slate-bold">card</strong></p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >object</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " > </p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " > </p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " ><strong class="slate-bold">     accountNumber</strong></p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >string</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >C</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >The customer&apos;s payment card number, also known as the Primary Account Number (PAN). The account number can be 14 to 19 digits long. </p><p class="slate-p slate-indent-0" style="0px">This value is mandatory when entry mode selected as <code class="slate-code">keyed</code>.</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " ><strong class="slate-bold">     expiryDate</strong></p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >string</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >C</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >This is the expiration date of the credit card formatted as MMYY.</p><p class="slate-p " >This value is mandatory when account number is provided.</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " ><strong class="slate-bold">     entryMode</strong></p><p class="slate-p slate-indent-0" style="0px">     Enum values:<code class="slate-code">KEYED </code></p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >string</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >C</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >This defines on how the card data is presented at the point-of-sale(POS).</p><p class="slate-p " >This value is optional for secondary transactions. Usually the entry mode of the primary transaction is used in secondary transaction unless user wants to overwrite this.</p><p class="slate-p " > </p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " ><strong class="slate-bold">     cvc</strong></p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >string</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >O</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Card Verification Code. This is the three or four-digit codes on the back of the payment card that are used to further authenticate the consumer during a card-not-present transaction. Use as CVV2 for Visa, CVC2 for Master Card, CVD for Discover and CID for Amex card.</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " ><strong class="slate-bold">     cardName</strong></p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >string</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >O</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Name of the card holder as printed on the card.</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " ><strong class="slate-bold">cardToken</strong> <strong class="slate-bold">- </strong></p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >object</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " > </p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " > </p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " ><strong class="slate-bold">     tokenValue</strong></p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >string</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >C</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >This the token that was issued for the card data by TNS.</p><p class="slate-p " >This field is mandatory when a transaction is performed using token.</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " ><strong class="slate-bold">originalTransaction - </strong>Original transaction group is required for follow-up transaction. Any of the available identification field is used to refer the original transaction stored in the TNS database</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >     <strong class="slate-bold">originalTransactionId</strong></p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >string</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >C</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >This is the transaction identifier of the primary transaction, as returned in the response of original primary transaction.</p><p class="slate-p " >This field is mandatory for secondary transactions like capture or void.</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >     <strong class="slate-bold">originalTransactionAmount</strong></p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >string</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >O</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >This is the total amount of the original transaction converted to the lowest unit of currency formatted as a string. Amount can not be negative. Send the amount without a decimal in it. e.g. $10.25 should be sent as 1025.</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " ><strong class="slate-bold">merchant - </strong>Merchant related information should be provided under this section</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " ><strong class="slate-bold">     id</strong></p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >string</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >R</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >TNS Merchant id associated with merchant account.</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " ><strong class="slate-bold">     countryCd</strong></p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >srting</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >O</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >This is the ISO 3166-2 country code. Use “036” for Australia, “840” for United States, “826” for United Kingdom. Please refer <a href="https://en.wikipedia.org/wiki/List_of_ISO_3166_country_codes" target="_blank">https://en.wikipedia.org/wiki/List_of_ISO_3166_country_codes</a>   for list of all country codes.</p></td></div></tr></tbody></table></div><div class="slate-div"></div><p class="slate-p " ></p><p class="slate-p " ></p><p class="slate-p " ></p><p class="slate-p " ></p><p class="slate-p " ></p>

Field Name

Type

Required(R), Optional(O), Conditional(C)

<div class="table-container" style="width:100%;
  min-width:100%;"><table class="slate-table" style="min-width:100%"><div class="published-table-header" style="width:100%;min-width:100%;"><div style="width:100px;">Field Name</div><div style="width:100px;">Type</div><div style="width:100px;">Description</div></div><colgroup ><col style="width:initial"><col style="width:initial"><col style="width:initial"><col style="width:initial"></colgroup><tbody class="slate-TableElement-tbody"><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >authorizedDate</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >string (dateTime)</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Timestamp when the transaction was authorized.</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >transactionId</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >string</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Unique identifier assigned by TNS for the transaction.</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >stan</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >string</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >System Trace Audit Number for tracking within TNS systems.</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >clientTransactionId</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >string</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Identifier supplied by the client system for internal tracking.</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >transactionDate</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >string (date)</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Date when the transaction was initiated.</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >tenderType</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >string</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Type of tender used (e.g., CREDIT, DEBIT).</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >tnsResponseCode</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >string</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >TNS internal response code for the transaction.</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >tnsResponseText</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >string</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Description corresponding to the tnsResponseCode.</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >hostResponseCode</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >string</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Response code from the host system.</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >hostResponseText</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >string</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Response message from the host system.</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >networkId</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >string</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Identifier for the card network used.</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >settlementDate</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >string (date)</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Date when the transaction is expected to settle.</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >x_request_id</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >string (UUID)</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Correlation ID for API request tracing.</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >amount.approvedAmount</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >string (currency minor units)</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Approved amount for the transaction, in minor units (e.g., cents).</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >amount.currencyCode</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >string</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >ISO 4217 currency code (e.g., &quot;840&quot; for USD).</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >card.accountFirst6</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >string</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >First 6 digits of the card number (BIN).</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >card.accountLast4</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >string</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Last 4 digits of the card number.</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >card.hostNetwork</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >string</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Network that processed the card (e.g., Visa, Mastercard).</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >card.expiryMonth</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >string</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Card expiry month in MM format.</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >card.expiryYear</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >string</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Card expiry year in YYYY format.</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >avs</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >object</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >AVS (Address Verification Service) result details (empty object if unused).</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >receiptData</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >string</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Encoded data used to generate a receipt.</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >responseSource</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >string</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Indicates where the response originated (e.g., TRANSACTION_APPROVED).</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >authCode</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >string</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Authorization code returned from the card issuer.</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >token</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >string</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Tokenized representation of the card number (used for future transactions).</p></td></div></tr></tbody></table></div><p class="slate-p " ></p>

<p class="slate-p " >Our PayOrch platform gives all the APIs to control the status of your transactions throughout its lifecycle allowing you to capture, adjust or cancel (void or reverse) transactions quickly and easily from your application.</p><p class="slate-p " >In the transaction lifecycle, the transactions authorization or sale is for goods purchased and they are termed as primary transactions. </p><h2 class="slate-h2 " >Step 1: Purchase</h2><p class="slate-p " >To charge a customer for the goods or services purchased, you can charge the customer&apos;s card through authorization or sale transactions. </p><p class="slate-p " ><strong class="slate-bold">Authorization</strong>: An authorization transaction is to get authorize the card with the cardholder&apos;s issuing bank and verify that the card is valid and there are enough funds in the cardholder&apos;s account to pay for the purchase. This step doesn&apos;t transfer the funds. To get the funds from the cardholder&apos;s account to the merchant&apos;s account, the approved transaction should be captured. The authorization transactions are usually used by merchants when the goods are delivered later after the purchase.</p><p class="slate-p " ><strong class="slate-bold">Sale</strong>: A sale transaction can be explained as authorization and capture of funds at the same time. The sale transactions are usually used by merchants who deliver the goods almost immediately like retail stores where the customer receives the goods immediately.</p><p class="slate-p " >For primary transactions, the card must be presented at the point-of-sale(POS) or the card details should be entered into the online website or application during checkout. When the card is physically presented and read by a card reader, they are called as card present transactions. When a card number is manually entered, it is termed as card not present transaction.</p><p class="slate-p " ></p><div style="width:100%;
	min-width:100%;" class="callout-widget" data-type=info ><div class="callout-icon"><svg width="20" height="20" viewBox="0 0 20 20" fill="none" xmlns="http://www.w3.org/2000/svg"><path d="M10.0628 14.1676C10.2434 14.1676 10.3927 14.1086 10.5107 13.9905C10.6288 13.8725 10.6878 13.7232 10.6878 13.5426V9.77177C10.6878 9.6051 10.6253 9.46274 10.5003 9.34469C10.3753 9.22663 10.2295 9.1676 10.0628 9.1676C9.88227 9.1676 9.73296 9.22663 9.61491 9.34469C9.49685 9.46274 9.43783 9.61205 9.43783 9.7926V13.5634C9.43783 13.7301 9.50033 13.8725 9.62533 13.9905C9.75033 14.1086 9.89616 14.1676 10.0628 14.1676ZM10.0003 7.62594C10.1948 7.62594 10.358 7.56344 10.4899 7.43844C10.6219 7.31344 10.6878 7.15371 10.6878 6.95927C10.6878 6.76482 10.6219 6.59816 10.4899 6.45927C10.358 6.32038 10.1948 6.25094 10.0003 6.25094C9.80588 6.25094 9.64269 6.32038 9.51074 6.45927C9.3788 6.59816 9.31283 6.76482 9.31283 6.95927C9.31283 7.15371 9.3788 7.31344 9.51074 7.43844C9.64269 7.56344 9.80588 7.62594 10.0003 7.62594ZM10.0003 18.3343C8.81977 18.3343 7.72255 18.1225 6.70866 17.6989C5.69477 17.2752 4.81283 16.6884 4.06283 15.9384C3.31283 15.1884 2.72602 14.3065 2.30241 13.2926C1.8788 12.2787 1.66699 11.1815 1.66699 10.0009C1.66699 8.83427 1.8788 7.74399 2.30241 6.7301C2.72602 5.71621 3.31283 4.83427 4.06283 4.08427C4.81283 3.33427 5.69477 2.74399 6.70866 2.31344C7.72255 1.88288 8.81977 1.6676 10.0003 1.6676C11.167 1.6676 12.2573 1.88288 13.2712 2.31344C14.285 2.74399 15.167 3.33427 15.917 4.08427C16.667 4.83427 17.2573 5.71621 17.6878 6.7301C18.1184 7.74399 18.3337 8.83427 18.3337 10.0009C18.3337 11.1815 18.1184 12.2787 17.6878 13.2926C17.2573 14.3065 16.667 15.1884 15.917 15.9384C15.167 16.6884 14.285 17.2752 13.2712 17.6989C12.2573 18.1225 11.167 18.3343 10.0003 18.3343ZM10.0003 17.0843C11.9448 17.0843 13.6114 16.3898 15.0003 15.0009C16.3892 13.612 17.0837 11.9454 17.0837 10.0009C17.0837 8.05649 16.3892 6.38982 15.0003 5.00094C13.6114 3.61205 11.9448 2.9176 10.0003 2.9176C8.05588 2.9176 6.38921 3.61205 5.00033 5.00094C3.61144 6.38982 2.91699 8.05649 2.91699 10.0009C2.91699 11.9454 3.61144 13.612 5.00033 15.0009C6.38921 16.3898 8.05588 17.0843 10.0003 17.0843Z" fill="#3960B4"></path></svg></div><div ><p class="slate-p " >For more information on how a card is presented at the point of sale, please refer to Entry Modes in API References.</p></div></div><div class="table-container" style="width:100%;min-width:100%"><table class="slate-table" style="min-width:100%"><div class="published-table-header" style="width:100%;min-width:100%;min-height:initial;visibility: hidden;border:initial"><div style="width:100px;">Title</div></div><colgroup ><col style="width:initial"></colgroup><tbody class="slate-TableElement-tbody"><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " ><em class="slate-italic">Sample card-present EMV chip insert transaction</em></p><p class="slate-p " ><a href="https://app.theneo.io/tnsi/online-rest-api/primary-transactions-1/sale" target="_self"><em class="slate-italic">Run a sample Sale transaction</em></a></p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><div class="code-block-wrapper"  style="width:60%" ><div class="code-block-header">Plain text</div><pre class="slate-CodeBlockElement slate-code_block"><textarea id="publishedPageCodeblock" style="display:none !important; visibility: hidden; opacity: 0; width: 1px; height: 1px;" type="hidden"> </textarea><code class="language-json keep-markup drop-tokens"><div class="slate-code_line">{</div><div class="slate-code_line">  &quot;stan&quot;: &quot;123456&quot;,</div><div class="slate-code_line">  &quot;clientTransactionId&quot;: &quot;12345678&quot;,</div><div class="slate-code_line">  &quot;transactionDate&quot;: &quot;20240401240000&quot;,</div><div class="slate-code_line">  &quot;tenderType&quot;: &quot;CREDIT&quot;,</div><div class="slate-code_line">  &quot;paymentChannel&quot;: &quot;CREDITCARD&quot;,</div><div class="slate-code_line">  &quot;orderInformation&quot;: {</div><div class="slate-code_line">    &quot;amount&quot;: {</div><div class="slate-code_line">      &quot;currencyCode&quot;: &quot;840&quot;,</div><div class="slate-code_line">      &quot;transactionAmount&quot;: &quot;1000&quot;</div><div class="slate-code_line">    }</div><div class="slate-code_line">  },</div><div class="slate-code_line">  &quot;paymentInformation&quot;: {</div><div class="slate-code_line">    &quot;card&quot;: {</div><div class="slate-code_line">      &quot;entryMode&quot;: &quot;KEYED&quot;,</div><div class="slate-code_line">      &quot;accountNumber&quot;: &quot;4005562231212123&quot;,</div><div class="slate-code_line">      &quot;expiryDate&quot;: &quot;1025&quot;,</div><div class="slate-code_line">      &quot;cvc&quot;: &quot;123&quot;</div><div class="slate-code_line">    }</div><div class="slate-code_line">  },</div><div class="slate-code_line">  &quot;merchant&quot;: {</div><div class="slate-code_line">    &quot;id&quot;: &quot;M1002&quot;</div><div class="slate-code_line">  }</div><div class="slate-code_line">}</div></code></pre></div></td></div></tr></tbody></table></div><h2 class="slate-h2 " >Step 2: Returns or Adjustments</h2><p class="slate-p " >Once merchant delivers the goods or services purchased, to realize the funds into merchant&apos;s bank, the approved authorizations has to be captured using capture transaction. Or when the customer cancels the order or returns the good, the merchant can cancel the approved primary transaction in its entirety or refund only partial funds using void or reversal or refund.</p><p class="slate-p " >All such transactions are made on a primary transaction, they are termed as secondary transactions or we can call it as follow-up transactions. For secondary transactions, the card need not be presented at the point-of-sale(POS) or to the merchant. We are running additional transactions based on an approved primary transaction. PayOrch platform provides simple APIs to perform secondary transactions. </p><p class="slate-p " >PayOrch platform returns a transaction identifier in the response of primary transaction. That transaction identifier is the important data used to run secondary or follow-up transactions. In a case where the transaction identifier of the primary transaction is lost, there are other parameters that can used to run the secondary transactions. Please refer API reference for more details.</p><p class="slate-p " ></p><div style="width:100%;
	min-width:100%;" class="callout-widget" data-type=info ><div class="callout-icon"><svg width="20" height="20" viewBox="0 0 20 20" fill="none" xmlns="http://www.w3.org/2000/svg"><path d="M10.0628 14.1676C10.2434 14.1676 10.3927 14.1086 10.5107 13.9905C10.6288 13.8725 10.6878 13.7232 10.6878 13.5426V9.77177C10.6878 9.6051 10.6253 9.46274 10.5003 9.34469C10.3753 9.22663 10.2295 9.1676 10.0628 9.1676C9.88227 9.1676 9.73296 9.22663 9.61491 9.34469C9.49685 9.46274 9.43783 9.61205 9.43783 9.7926V13.5634C9.43783 13.7301 9.50033 13.8725 9.62533 13.9905C9.75033 14.1086 9.89616 14.1676 10.0628 14.1676ZM10.0003 7.62594C10.1948 7.62594 10.358 7.56344 10.4899 7.43844C10.6219 7.31344 10.6878 7.15371 10.6878 6.95927C10.6878 6.76482 10.6219 6.59816 10.4899 6.45927C10.358 6.32038 10.1948 6.25094 10.0003 6.25094C9.80588 6.25094 9.64269 6.32038 9.51074 6.45927C9.3788 6.59816 9.31283 6.76482 9.31283 6.95927C9.31283 7.15371 9.3788 7.31344 9.51074 7.43844C9.64269 7.56344 9.80588 7.62594 10.0003 7.62594ZM10.0003 18.3343C8.81977 18.3343 7.72255 18.1225 6.70866 17.6989C5.69477 17.2752 4.81283 16.6884 4.06283 15.9384C3.31283 15.1884 2.72602 14.3065 2.30241 13.2926C1.8788 12.2787 1.66699 11.1815 1.66699 10.0009C1.66699 8.83427 1.8788 7.74399 2.30241 6.7301C2.72602 5.71621 3.31283 4.83427 4.06283 4.08427C4.81283 3.33427 5.69477 2.74399 6.70866 2.31344C7.72255 1.88288 8.81977 1.6676 10.0003 1.6676C11.167 1.6676 12.2573 1.88288 13.2712 2.31344C14.285 2.74399 15.167 3.33427 15.917 4.08427C16.667 4.83427 17.2573 5.71621 17.6878 6.7301C18.1184 7.74399 18.3337 8.83427 18.3337 10.0009C18.3337 11.1815 18.1184 12.2787 17.6878 13.2926C17.2573 14.3065 16.667 15.1884 15.917 15.9384C15.167 16.6884 14.285 17.2752 13.2712 17.6989C12.2573 18.1225 11.167 18.3343 10.0003 18.3343ZM10.0003 17.0843C11.9448 17.0843 13.6114 16.3898 15.0003 15.0009C16.3892 13.612 17.0837 11.9454 17.0837 10.0009C17.0837 8.05649 16.3892 6.38982 15.0003 5.00094C13.6114 3.61205 11.9448 2.9176 10.0003 2.9176C8.05588 2.9176 6.38921 3.61205 5.00033 5.00094C3.61144 6.38982 2.91699 8.05649 2.91699 10.0009C2.91699 11.9454 3.61144 13.612 5.00033 15.0009C6.38921 16.3898 8.05588 17.0843 10.0003 17.0843Z" fill="#3960B4"></path></svg></div><div ><p class="slate-p " >All secondary transactions use the same request format. </p></div></div><div class="table-container" style="width:100%;min-width:100%"><table class="slate-table" style="min-width:100%"><div class="published-table-header" style="width:100%;min-width:100%;min-height:initial;visibility: hidden;border:initial"><div style="width:100px;">Title</div></div><colgroup ><col style="width:initial"></colgroup><tbody class="slate-TableElement-tbody"><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " ><em class="slate-italic">Sample payload for a secondary transaction</em></p><p class="slate-p " ><a href="https://app.theneo.io/tnsi/online-rest-api/secondary-transactions/void-2" target="_self"><em class="slate-italic">Run a sample Void transaction</em></a></p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><div class="code-block-wrapper"  style="width:60%" ><div class="code-block-header">Plain text</div><pre class="slate-CodeBlockElement slate-code_block"><textarea id="publishedPageCodeblock" style="display:none !important; visibility: hidden; opacity: 0; width: 1px; height: 1px;" type="hidden"> </textarea><code class="language-json keep-markup drop-tokens"><div class="slate-code_line">{</div><div class="slate-code_line">  &quot;clientTransactionId&quot;: &quot;12345678&quot;,</div><div class="slate-code_line">  &quot;transactionDate&quot;: &quot;20240401240000&quot;,</div><div class="slate-code_line">  &quot;orderInformation&quot;: {</div><div class="slate-code_line">    &quot;amount&quot;: {</div><div class="slate-code_line">      &quot;currencyCode&quot;: &quot;840&quot;,</div><div class="slate-code_line">      &quot;transactionAmount&quot;: &quot;900&quot;</div><div class="slate-code_line">    }</div><div class="slate-code_line">  },</div><div class="slate-code_line">  &quot;originalTransaction&quot;: {</div><div class="slate-code_line">    &quot;originalTransactionId&quot;: &quot;0784fe39-2b54-4f9b-bb5c-71d9f262dbe7&quot;</div><div class="slate-code_line">  },</div><div class="slate-code_line">  &quot;merchant&quot;: {</div><div class="slate-code_line">    &quot;id&quot;: &quot;M1002&quot;</div><div class="slate-code_line">  }</div><div class="slate-code_line">}</div></code></pre></div></td></div></tr></tbody></table></div><h2 class="slate-h2 " >Step 3: Settlement</h2><p class="slate-p " >Settlement is a process of finalizing all the transactions for the merchant and send it to the acquirer for consolidation and initiate the funds transfer. All settlements are scheduled and automatically run by PayOrch platform.</p><p class="slate-p " ></p><p class="slate-p " ></p>

Our PayOrch platform gives all the APIs to control the status of your transactions throughout its lifecycle allowing you to capture, adjust or cancel (void or reverse) transactions quickly and easily from your application.

In the transaction lifecycle, the transactions authorization or sale is for goods purchased and they are termed as primary transactions. 

To charge a customer for the goods or services purchased, you can charge the customer's card through authorization or sale transactions. 

: An authorization transaction is to get authorize the card with the cardholder's issuing bank and verify that the card is valid and there are enough funds in the cardholder's account to pay for the purchase. This step doesn't transfer the funds. To get the funds from the cardholder's account to the merchant's account, the approved transaction should be captured. The authorization transactions are usually used by merchants when the goods are delivered later after the purchase.

: A sale transaction can be explained as authorization and capture of funds at the same time. The sale transactions are usually used by merchants who deliver the goods almost immediately like retail stores where the customer receives the goods immediately.

For primary transactions, the card must be presented at the point-of-sale(POS) or the card details should be entered into the online website or application during checkout. When the card is physically presented and read by a card reader, they are called as card present transactions. When a card number is manually entered, it is termed as card not present transaction.

Once merchant delivers the goods or services purchased, to realize the funds into merchant's bank, the approved authorizations has to be captured using capture transaction. Or when the customer cancels the order or returns the good, the merchant can cancel the approved primary transaction in its entirety or refund only partial funds using void or reversal or refund.

All such transactions are made on a primary transaction, they are termed as secondary transactions or we can call it as follow-up transactions. For secondary transactions, the card need not be presented at the point-of-sale(POS) or to the merchant. We are running additional transactions based on an approved primary transaction. PayOrch platform provides simple APIs to perform secondary transactions. 

PayOrch platform returns a transaction identifier in the response of primary transaction. That transaction identifier is the important data used to run secondary or follow-up transactions. In a case where the transaction identifier of the primary transaction is lost, there are other parameters that can used to run the secondary transactions. Please refer API reference for more details.

Settlement is a process of finalizing all the transactions for the merchant and send it to the acquirer for consolidation and initiate the funds transfer. All settlements are scheduled and automatically run by PayOrch platform.

<p class="slate-p " >Payment methods refer to the various ways customers can pay for goods and services. These methods can vary depending on factors such as location, technological advancements, and consumer preferences. Here are some common payment methods:</p><p class="slate-p " ></p><p class="slate-p " ></p><div style="text-align:center"><img src="https://theneo-prod-public.s3.us-east-1.amazonaws.com/4347efdc-e62f-4bc6-891b-a92605bb8b2b.png" style="
              width:1114px;
	            height:626px;
	            aspect-ratio:1114 / 626"
         /></div><p class="slate-p " ></p><ol class="slate-ol " ><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">Credit Cards</strong>: Credit cards allow customers to make purchases by borrowing funds from a credit card issuer, up to a predetermined credit limit. Credit cards offer convenience, security features, and the ability to make purchases online and in-person</div></li><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">Debit Cards</strong>: Debit cards deduct funds directly from the cardholder&apos;s bank account when used for purchases. Debit cards are widely accepted and offer similar conveniences to credit cards, but transactions are limited by the available funds in the linked account</div></li><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">Mobile Payments</strong>: Mobile payment methods, such as Apple Pay, Google Pay, Samsung Pay, and other digital wallets, enable customers to make payments using their smartphones or wearable devices. These methods typically use Near Field Communication (NFC) technology for contactless transactions</div></li><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">Online Payment Platforms</strong>: Online payment platforms, such as PayPal, Venmo, and Square Cash, allow customers to transfer funds electronically and make purchases online or through mobile apps. These platforms often offer additional features such as peer-to-peer payments, bill splitting, and integration with ecommerce websites</div></li></ol><p class="slate-p " ></p><h3 class="slate-h3 " >Digital Wallet Payment Methods</h3><p class="slate-p " >The transactions can be made using electronic wallet payments that securely store the payment card information either in a electronic device or in the cloud. These digital wallets enable users to make purchases online, in-app, or in-person without having to manually enter payment card details each time.</p><ol class="slate-ol " ><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">ApplePay</strong>: It allows users to make payments using their compatible Apple devices, such as iPhones, iPads, Apple Watches, and Mac computers. Apple Pay securely stores users&apos; credit card, debit card, and other payment card information, allowing for convenient and secure transactions both in-store and online</div></li><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">GooglePay</strong>: It allows users to make payments using their compatible Android devices, such as smartphones and smartwatches. Google Pay securely stores users&apos; credit card, debit card, and other payment card information, enabling convenient and secure transactions both in-store and online</div></li></ol><p class="slate-p " ></p><p class="slate-p " ></p>

Payment methods refer to the various ways customers can pay for goods and services. These methods can vary depending on factors such as location, technological advancements, and consumer preferences. Here are some common payment methods:

The transactions can be made using electronic wallet payments that securely store the payment card information either in a electronic device or in the cloud. These digital wallets enable users to make purchases online, in-app, or in-person without having to manually enter payment card details each time.

<p class="slate-p " ></p><h2 class="slate-h2 " >VISA</h2><div class="table-container" style="width:100%;min-width:100%"><table class="slate-table" style="min-width:100%"><div class="published-table-header" style="width:100%;min-width:100%;min-height:initial;visibility: hidden;border:initial"><div style="width:100px;">Title</div></div><colgroup ><col style="width:initial"><col style="width:initial"></colgroup><tbody class="slate-TableElement-tbody"><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " ><strong class="slate-bold">Card Number:</strong> 4111 1111 1111 1111</p><p class="slate-p " ><strong class="slate-bold">Expiration Date:</strong> Any future date</p><p class="slate-p " ><strong class="slate-bold">CVV:</strong> Any 3-digit number</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " ><strong class="slate-bold">Card Number:</strong> 4012 8888 8888 1881</p><p class="slate-p " ><strong class="slate-bold">Expiration Date:</strong> Any future date</p><p class="slate-p " ><strong class="slate-bold">CVV:</strong> Any 3-digit number</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " ><strong class="slate-bold">Card Number:</strong> 4222 2222 2222 2222</p><p class="slate-p " ><strong class="slate-bold">Expiration Date:</strong> Any future date</p><p class="slate-p " ><strong class="slate-bold">CVV:</strong> Any 3-digit number</p></td></div></tr></tbody></table></div><p class="slate-p slate-indent-0" style="0px"></p><h2 class="slate-h2 " >MASTERCARD</h2><div class="table-container" style="width:100%;min-width:100%"><table class="slate-table" style="min-width:100%"><div class="published-table-header" style="width:100%;min-width:100%;min-height:initial;visibility: hidden;border:initial"><div style="width:100px;">Title</div></div><colgroup ><col style="width:initial"><col style="width:initial"></colgroup><tbody class="slate-TableElement-tbody"><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " ><strong class="slate-bold">Card Number:</strong> 5555 5555 5555 4444</p><p class="slate-p " ><strong class="slate-bold">Expiration Date:</strong> Any future date</p><p class="slate-p " ><strong class="slate-bold">CVV:</strong> Any 3-digit number</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " ><strong class="slate-bold">Card Number:</strong> 5105 1051 0510 5100</p><p class="slate-p " ><strong class="slate-bold">Expiration Date:</strong> Any future date</p><p class="slate-p " ><strong class="slate-bold">CVV:</strong> Any 3-digit number</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " ><strong class="slate-bold">Card Number:</strong> 5432 1234 5678 9876</p><p class="slate-p " ><strong class="slate-bold">Expiration Date:</strong> Any future date</p><p class="slate-p " ><strong class="slate-bold">CVV:</strong> Any 3-digit number</p></td></div></tr></tbody></table></div><p class="slate-p slate-indent-0" style="0px"></p><h2 class="slate-h2 " >AMERICAN EXPRESS</h2><div class="table-container" style="width:100%;min-width:100%"><table class="slate-table" style="min-width:100%"><div class="published-table-header" style="width:100%;min-width:100%;min-height:initial;visibility: hidden;border:initial"><div style="width:100px;">Title</div></div><colgroup ><col style="width:initial"><col style="width:initial"></colgroup><tbody class="slate-TableElement-tbody"><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " ><strong class="slate-bold">Card Number:</strong> 3782 822463 10005</p><p class="slate-p " ><strong class="slate-bold">Expiration Date:</strong> Any future date</p><p class="slate-p " ><strong class="slate-bold">CID (Card Identification Number):</strong> Any 4-digit number</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " ><strong class="slate-bold">Card Number:</strong> 3714 496353 98431</p><p class="slate-p " ><strong class="slate-bold">Expiration Date:</strong> Any future date</p><p class="slate-p " ><strong class="slate-bold">CID (Card Identification Number):</strong> Any 4-digit number</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " ><strong class="slate-bold">Card Number:</strong> 3411 726629 87061</p><p class="slate-p " ><strong class="slate-bold">Expiration Date:</strong> Any future date</p><p class="slate-p " ><strong class="slate-bold">CID (Card Identification Number):</strong> Any 4-digit number</p></td></div></tr></tbody></table></div><p class="slate-p slate-indent-0" style="0px"></p><h2 class="slate-h2 " >DISCOVER</h2><div class="table-container" style="width:100%;min-width:100%"><table class="slate-table" style="min-width:100%"><div class="published-table-header" style="width:100%;min-width:100%;min-height:initial;visibility: hidden;border:initial"><div style="width:100px;">Title</div></div><colgroup ><col style="width:initial"><col style="width:initial"></colgroup><tbody class="slate-TableElement-tbody"><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " ><strong class="slate-bold">Card Number:</strong> 6011 0000 0000 0004</p><p class="slate-p " ><strong class="slate-bold">Expiration Date:</strong> Any future date</p><p class="slate-p " ><strong class="slate-bold">CVV:</strong> Any 3-digit number</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " ><strong class="slate-bold">Card Number:</strong> 6011 1111 1111 1117</p><p class="slate-p " ><strong class="slate-bold">Expiration Date:</strong> Any future date</p><p class="slate-p " ><strong class="slate-bold">CVV:</strong> Any 3-digit number</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " ><strong class="slate-bold">Card Number:</strong> 6011 0000 0000 0009</p><p class="slate-p " ><strong class="slate-bold">Expiration Date:</strong> Any future date</p><p class="slate-p " ><strong class="slate-bold">CVV:</strong> Any 3-digit number</p></td></div></tr></tbody></table></div><p class="slate-p slate-indent-0" style="0px"></p><h2 class="slate-h2 " >DINERS CLUB</h2><div class="table-container" style="width:100%;min-width:100%"><table class="slate-table" style="min-width:100%"><div class="published-table-header" style="width:100%;min-width:100%;min-height:initial;visibility: hidden;border:initial"><div style="width:100px;">Title</div></div><colgroup ><col style="width:initial"><col style="width:initial"></colgroup><tbody class="slate-TableElement-tbody"><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " ><strong class="slate-bold">Card Number:</strong> 3056 9309 0259 04</p><p class="slate-p " ><strong class="slate-bold">Expiration Date:</strong> Any future date</p><p class="slate-p " ><strong class="slate-bold">CVV:</strong> Any 3-digit number</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " ><strong class="slate-bold">Card Number:</strong> 3600 6666 3333 44</p><p class="slate-p " ><strong class="slate-bold">Expiration Date:</strong> Any future date</p><p class="slate-p " ><strong class="slate-bold">CVV:</strong> Any 3-digit number</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " ><strong class="slate-bold">Card Number:</strong> 3852 0000 0232 37</p><p class="slate-p " ><strong class="slate-bold">Expiration Date:</strong> Any future date</p><p class="slate-p " ><strong class="slate-bold">CVV:</strong> Any 3-digit number</p></td></div></tr></tbody></table></div><p class="slate-p slate-indent-0" style="0px"></p><h2 class="slate-h2 " >JCB</h2><div class="table-container" style="width:100%;min-width:100%"><table class="slate-table" style="min-width:100%"><div class="published-table-header" style="width:100%;min-width:100%;min-height:initial;visibility: hidden;border:initial"><div style="width:100px;">Title</div></div><colgroup ><col style="width:initial"><col style="width:initial"></colgroup><tbody class="slate-TableElement-tbody"><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " ><strong class="slate-bold">Card Number:</strong> 3530 1113 3330 0000</p><p class="slate-p " ><strong class="slate-bold">Expiration Date:</strong> Any future date</p><p class="slate-p " ><strong class="slate-bold">CVV:</strong> Any 3-digit number</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " ><strong class="slate-bold">Card Number:</strong> 3566 0020 2036 0505</p><p class="slate-p " ><strong class="slate-bold">Expiration Date:</strong> Any future date</p><p class="slate-p " ><strong class="slate-bold">CVV:</strong> Any 3-digit number</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " ><strong class="slate-bold">Card Number:</strong> 3530 1113 3330 0000</p><p class="slate-p " ><strong class="slate-bold">Expiration Date:</strong> Any future date</p><p class="slate-p " ><strong class="slate-bold">CVV:</strong> Any 3-digit number</p></td></div></tr></tbody></table></div><p class="slate-p slate-indent-0" style="0px"></p><h2 class="slate-h2 " >UNION PAY</h2><div class="table-container" style="width:100%;min-width:100%"><table class="slate-table" style="min-width:100%"><div class="published-table-header" style="width:100%;min-width:100%;min-height:initial;visibility: hidden;border:initial"><div style="width:100px;">Title</div></div><colgroup ><col style="width:initial"><col style="width:initial"></colgroup><tbody class="slate-TableElement-tbody"><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " ><strong class="slate-bold">Card Number:</strong> 6250 9460 0000 0016</p><p class="slate-p " ><strong class="slate-bold">Expiration Date:</strong> Any future date</p><p class="slate-p " ><strong class="slate-bold">CVV:</strong> Any 3-digit number</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " ><strong class="slate-bold">Card Number:</strong> 6250 9470 0000 0014</p><p class="slate-p " ><strong class="slate-bold">Expiration Date:</strong> Any future date</p><p class="slate-p " ><strong class="slate-bold">CVV:</strong> Any 3-digit number</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " ><strong class="slate-bold">Card Number:</strong> 6222 8212 3456 0017</p><p class="slate-p " ><strong class="slate-bold">Expiration Date:</strong> Any future date</p><p class="slate-p " ><strong class="slate-bold">CVV:</strong> Any 3-digit number</p></td></div></tr></tbody></table></div><p class="slate-p " ></p><p class="slate-p " ></p>

TNS response codes indicate validation errors within our system. These codes are generated before the transaction is forwarded to an acquirer. If you receive any of the response codes listed below, it signifies that the transaction has failed our validation checks.

Sections