Dejavoo

API Docs

Sample Request – Alternate Payment (Wallet/ACH)

Sample Error Response – Invalid Transaction Reference

Blank

Transaction Status Check

Production

Sandbox

<h3 class="slate-h3 " >Version History</h3><div class="published-table"><div class="table-container" style="padding-left: 0px;"><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:208px;">Title</div><div style="width:212px;">Description</div><div style="width:400px;">Title</div></div><colgroup ><col style="width:208px"><col style="width:212px"></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">End Points</strong></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"><strong class="slate-bold">05/08/25</strong></p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p slate-indent-0" style="0px">Initial release of Transaction Status Check API (v1)</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p slate-indent-0" style="0px">iposTransactStatus v1</p></td></div></tr></tbody></table></div></div><h3 class="slate-h3 " >Prerequisites</h3><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">For Sandbox (UAT)</strong></div></li></ul><p class="slate-p " >Users should be onboarded on the iPOSpays sandbox (UAT) environment as a merchant and have a valid TPN.</p><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">For Production (Live)</strong></div></li></ul><p class="slate-p " >Users should be onboarded on the iPOSpays production environment as a merchant and have a valid TPN.</p><div style="width:100%;
	min-width:100%;" class="callout-widget" data-type=warning ><div class="callout-icon"><svg width="18" height="16" viewBox="0 0 18 16" fill="none" xmlns="http://www.w3.org/2000/svg"><path d="M0.916637 15.5009C0.791637 15.5009 0.683998 15.4732 0.59372 15.4176C0.503443 15.362 0.430526 15.2857 0.37497 15.1884C0.319415 15.0912 0.288165 14.9905 0.28122 14.8864C0.274276 14.7822 0.305526 14.6745 0.37497 14.5634L8.4583 0.605103C8.52775 0.493991 8.60761 0.41413 8.69789 0.365519C8.78816 0.316908 8.88886 0.292603 8.99997 0.292603C9.11108 0.292603 9.21178 0.316908 9.30205 0.365519C9.39233 0.41413 9.47219 0.493991 9.54164 0.605103L17.625 14.5634C17.6944 14.6745 17.7257 14.7822 17.7187 14.8864C17.7118 14.9905 17.6805 15.0912 17.625 15.1884C17.5694 15.2857 17.4965 15.362 17.4062 15.4176C17.3159 15.4732 17.2083 15.5009 17.0833 15.5009H0.916637ZM1.99997 14.2509H16L8.99997 2.1676L1.99997 14.2509ZM9.0833 13.0634C9.26386 13.0634 9.41316 13.0044 9.53122 12.8864C9.64928 12.7683 9.7083 12.619 9.7083 12.4384C9.7083 12.2579 9.64928 12.1086 9.53122 11.9905C9.41316 11.8725 9.26386 11.8134 9.0833 11.8134C8.90275 11.8134 8.75344 11.8725 8.63539 11.9905C8.51733 12.1086 8.4583 12.2579 8.4583 12.4384C8.4583 12.619 8.51733 12.7683 8.63539 12.8864C8.75344 13.0044 8.90275 13.0634 9.0833 13.0634ZM9.0833 10.7509C9.26386 10.7509 9.41316 10.6919 9.53122 10.5739C9.64928 10.4558 9.7083 10.3065 9.7083 10.1259V6.70927C9.7083 6.52871 9.64928 6.37941 9.53122 6.26135C9.41316 6.1433 9.26386 6.08427 9.0833 6.08427C8.90275 6.08427 8.75344 6.1433 8.63539 6.26135C8.51733 6.37941 8.4583 6.52871 8.4583 6.70927V10.1259C8.4583 10.3065 8.51733 10.4558 8.63539 10.5739C8.75344 10.6919 8.90275 10.7509 9.0833 10.7509Z" fill="#F1C21B"></path></svg></div><div ><p class="slate-p slate-indent-0" style="0px">If you do not have a TPN, contact your ISO or <a href="https://mailto:devsupport@dejavoo.io" target="_blank">devsupport@dejavoo.io</a></p></div></div><div class="slate-hr"><hr contenteditable="false" class="slate-HrElement-hr"/></div><h3 class="slate-h3 " >Generate an Authentication Token</h3><p class="slate-p " >To authenticate your API requests, you must include a valid token in the request header. This token is generated directly from the merchant portal.</p><p class="slate-p " ><strong class="slate-bold">Steps to Generate a Token:</strong></p><p class="slate-p " ><strong class="slate-bold">Step 1</strong>: Log in to your merchant account via the iPOSpays Portal and go to the Settings section.</p><p class="slate-p " ><strong class="slate-bold">Step 2</strong>: Under the <strong class="slate-bold">Generate Ecom/TOP Merchant Keys</strong> section:</p><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative">Select the appropriate <strong class="slate-bold">TPN</strong> (Terminal Profile Number) from the dropdown list.</div></li><li class="slate-li " ><div style="position:relative">Click <strong class="slate-bold">Generate Token</strong> to create a new authentication token.</div></li><li class="slate-li " ><div style="position:relative">The generated token will be displayed and must be used in your API request headers.</div></li></ul><p class="slate-p " ><em class="slate-italic">Need help?</em> <em class="slate-italic"><strong class="slate-bold">Watch this video tutorial for a guided walkthrough of the token generation process.</strong></em></p><div class="iframe-embed"><iframe
                        title="embed"
                        frameBorder="0"
                        allowFullScreen=""
                        src="https://s3.us-east-1.amazonaws.com/assets.ipospays.com/How+to+get+Auth+Token+on+iPOSpays.mp4"
                        id=""
                        provider=""
                        class="slate-MediaEmbedElement-iframe"
                        width="100%"
                    ></iframe></div><div class="slate-hr"><hr contenteditable="false" class="slate-HrElement-hr"/></div><h3 class="slate-h3 " >Endpoints and Request Method</h3><h3 class="slate-h3 " >Sample Request – Standard Card Transaction</h3><p class="slate-p " ></p>

Title

Description

Users should be onboarded on the iPOSpays sandbox (UAT) environment as a merchant and have a valid TPN.

Users should be onboarded on the iPOSpays production environment as a merchant and have a valid TPN.

To authenticate your API requests, you must include a valid token in the request header. This token is generated directly from the merchant portal.

: Log in to your merchant account via the iPOSpays Portal and go to the Settings section.

Watch this video tutorial for a guided walkthrough of the token generation process.

Sample Request – Standard Card Transaction

merchantAuthentication

The authentication token required for all API requests. This token is generated from the iPOSpays Merchant Portal under the Settings > Generate Ecom/TOP Merchant Keys section. It authorizes the request and links it to a specific TPN (Terminal Profile Number).

Token

iposhpresponse

Sample Response – Standard Card Transaction




<p class="slate-p slate-indent-0" style="0px">Used to check the status of non-card transactions like ACH or digital wallets, by passing the same <span style="background-color:rgba(0, 0, 0, 0.03);color:rgb(51, 65, 85)"><code class="slate-code">merchantId</code></span> and <span style="background-color:rgba(0, 0, 0, 0.03);color:rgb(51, 65, 85)"><code class="slate-code">transactionReferenceId</code></span>.</p>

Used to check the status of non-card transactions like ACH or digital wallets, by passing the same 

merchantId

Unique reference ID of the original transaction for which the status inquiry is being made. This value must match the one used in the original payment request.

transactionReferenceId

The authentication token required for all API requests. This token is generated from the iPOSpays Merchant Portal under the Settings > Generate Ecom/TOP Merchant Keys section. It authorizes the request and links it to a specific TPN (Terminal Profile Number)

Response

TxDetail

Sample Response – Alternate Payment





Sections

Sample Request – Alternate Payment (Wallet/ACH)

Header Parameters

Body Parameters

Response

Response Attributes

What made this section helpful for you?

What made this section unhelpful for you?

Response

What made this section helpful for you?

What made this section unhelpful for you?

Sections

Sample Request – Alternate Payment (Wallet/ACH)

Header Parameters

Body ParametersExpand all

ResponseExpand all

Response Attributes

What made this section helpful for you?

What made this section unhelpful for you?

Response

What made this section helpful for you?

What made this section unhelpful for you?

Ask an AI

Code with AI

Body Parameters

Response