Dejavoo

Merchant Onboarding API

Merchant

Store

Error Code & Messages

Default

Management API

Production

Sandbox

PROD

<p class="slate-p slate-indent-0" style="0px">Merchant Onboarding API   enable ISOs to programmatically onboard and manage merchants, stores, and TPNs directly from external systems (CRM/portal), eliminating manual portal interaction.</p><p class="slate-p slate-indent-0" style="0px">With this API, all data entered in your CRM or portal is automatically synced with the iPOSpays portal, enabling you to onboard merchants conveniently and efficiently.</p><div class="slate-hr"><hr contenteditable="false" class="slate-HrElement-hr"/></div><h1 class="slate-h1 " >Supported Operations</h1><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:135px;">Title</div><div style="width:199px;">Description</div></div><colgroup ><col style="width:135px"><col style="width:199px"></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">Entity</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p slate-indent-0" style="0px">Operations</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">Merchant</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p slate-indent-0" style="0px">Onboard, Edit</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">Store</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p slate-indent-0" style="0px">Add, Edit</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">TPN</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p slate-indent-0" style="0px">Add, Edit, Get Details</p></td></div></tr></tbody></table></div></div><div class="slate-hr"><hr contenteditable="false" class="slate-HrElement-hr"/></div><h1 class="slate-h1 " >Key Capabilities</h1><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative">Onboard a completely new merchant along with their first store and TPN.</div></li><li class="slate-li " ><div style="position:relative">Enable merchant-level add-on features (e.g., Whitelisting)</div></li><li class="slate-li " ><div style="position:relative">Expand an existing merchant’s setup by adding a new store and TPN.</div></li><li class="slate-li " ><div style="position:relative">Request and retrieve required TPN parameter information like OTP, AUTH-TOKEN, SPIN details (i.e., Registered Id, AUTH-KEY)</div></li><li class="slate-li " ><div style="position:relative">Enable or disable specific TPN parameters like SPIn</div></li><li class="slate-li " ><div style="position:relative">Enable store-level add-on features (e.g., ACH)</div></li></ul><div class="slate-hr"><hr contenteditable="false" class="slate-HrElement-hr"/></div><h1 class="slate-h1 " >Prerequisites</h1><p class="slate-p slate-indent-0" style="0px">Before invoking any API in this document, the following conditions must be satisfied:</p><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative">The ISO (Independent Sales Organization) must already be onboarded in the iPOSpays portal.</div></li><li class="slate-li " ><div style="position:relative">The following entities must be created and active, except the onboard API call:</div><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative">Merchant</div></li><li class="slate-li " ><div style="position:relative">Store</div></li><li class="slate-li " ><div style="position:relative">TPN (Terminal Profile Number)</div></li></ul></li><li class="slate-li " ><div style="position:relative">The integrator must possess:</div><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative">API Key</div></li><li class="slate-li " ><div style="position:relative">Secret Key</div></li></ul></li></ul><p class="slate-p slate-indent-0" style="0px">These are required to generate an <a href="https://app.theneo.io/dejavoo/authentication-token/authentication" target="_blank">Access Token</a>, which must be included in all subsequent API calls. </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 slate-indent-0" style="0px">Contact <a href="https://support@dejavoo.io" target="">support@dejavoo.io</a> and CC your sales executive to get the API and Secret Key</p></div></div><p class="slate-p " ></p><p class="slate-p " ></p>

Merchant Onboarding API   enable ISOs to programmatically onboard and manage merchants, stores, and TPNs directly from external systems (CRM/portal), eliminating manual portal interaction.

With this API, all data entered in your CRM or portal is automatically synced with the iPOSpays portal, enabling you to onboard merchants conveniently and efficiently.

Title

Description

Before invoking any API in this document, the following conditions must be satisfied:

, which must be included in all subsequent API calls. 

Templates allow you to preconfigure parameters tailored to specific merchant verticals, making the onboarding process faster and more consistent.

The onboardmerchant API request contains 3 primary objects:

Header Authorization – Request Parameters

manufacturer. Refer to the table below for supported device models and their respective manufacturers.

Each processor has a unique set of required and optional fields. Below is a breakdown of the input structure for each processor.

This section provides a detailed overview of the API process for onboarding merchants, stores, and TPNs. It covers the request methods, required parameters, and expected responses for different onboarding scenarios. You'll find structured guidelines on API request formatting, including headers, request body parameters, and sample JSON request and response structures for both successful and failed attempts.

Pre-defined Input Field – Values and Description

Routing Type details ( Field & Descriptions )

Onboarding / Creation of Merchant, Store, and TPN

merchantData

storeData

tpnData

Authorization

message

data

errors

<p class="slate-p " >This API allows you to enable, disable, or configure merchant-level features.</p><p class="slate-p " >Currently supported:</p><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">Domain Whitelisting</strong> — Restricts access to specific, approved domains to enhance security and prevent unauthorized usage.</div></li></ul><div class="slate-hr"><hr contenteditable="false" class="slate-HrElement-hr"/></div><h2 class="slate-h2 " >Authentication</h2><p class="slate-p " >To use this API, you must first generate an authentication token using your API Key and Secret Key.</p><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative">Retrieve the token from the <strong class="slate-bold">Auth-Token</strong> endpoint</div></li><li class="slate-li " ><div style="position:relative">Include the token in the <code class="slate-code">Authorization</code> header for all requests</div></li></ul><div class="slate-hr"><hr contenteditable="false" class="slate-HrElement-hr"/></div><h2 class="slate-h2 " >Domain Whitelisting</h2><p class="slate-p " >This feature allows you to control which domains are permitted to interact with merchant services by explicitly defining allowed origin URLs.</p><div class="slate-hr"><hr contenteditable="false" class="slate-HrElement-hr"/></div><h2 class="slate-h2 " >Enable / Configure Domain Whitelisting</h2><div class="code-block-wrapper"  style="width:100%" ><div class="code-block-header">JSON</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 class="slate-code_line">{
  &quot;merchantId&quot;: &quot;merchId-12-chars&quot;,
  &quot;whitelistDomains&quot;: {
    &quot;originUrls&quot;: [
      &quot;https://example.com&quot;,
      &quot;https://store.example.com&quot;
    ]
  }
}</div></div></code></pre></div><p class="slate-p " ></p>

This API allows you to enable, disable, or configure merchant-level features.

To use this API, you must first generate an authentication token using your API Key and Secret Key.

This feature allows you to control which domains are permitted to interact with merchant services by explicitly defining allowed origin URLs.

Edit Merchant

Unique identifier of the merchant for whom the add-on is being configured or modified

merchantId

Configuration object for domain whitelisting

whitelistDomains

List of allowed domain URLs. Only these domains will be permitted access

originUrls

Token used to authenticate the API request and grant access to protected merchant resources

A descriptive message providing additional context about the API response status or result

statusCode

A unique identifier for the API request, useful for tracing and debugging purposes

request_id

The exact time when the API response was generated, expressed in ISO 8601 format

timestamp

Numeric HTTP status code indicating the result of the API request

status_code

Failure Response (422 - Validation Error)

Failure Response (404 - Merchant Not Found)

responseCode

<p class="slate-p " >The following APIs allow you to manage store-level operations:</p><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">Onboard Store and TPN (Terminal Processing Number)</strong></div></li><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">Enable or Disable ACH Payments</strong></div></li></ul><p class="slate-p " >If you require additional functionality or custom parameters, please contact your Dejavoo representative.</p><div class="slate-hr"><hr contenteditable="false" class="slate-HrElement-hr"/></div><h2 class="slate-h2 " >Device Compatibility</h2><p class="slate-p " >Device model and manufacturer must match supported combinations:</p><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:183px;">Title</div><div style="width:245px;">Description</div></div><colgroup ><col style="width:183px"><col style="width:245px"></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">Device Manufacturer</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p slate-indent-0" style="0px">Supported Models</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">Kozen</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p slate-indent-0" style="0px">P1, P3, P5, P8, P12</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">Wizer POS</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p slate-indent-0" style="0px">Q2, QD2, QD3, QD4, QD5, QD6</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">Cloud POS</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p slate-indent-0" style="0px">Cloud POS</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">Android Phone</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p slate-indent-0" style="0px">Tap on Phone</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">Apple</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p slate-indent-0" style="0px">Apple Pay</p></td></div></tr></tbody></table></div></div><div class="slate-hr"><hr contenteditable="false" class="slate-HrElement-hr"/></div><h2 class="slate-h2 " >TPN Processor</h2><p class="slate-p " >Each processor requires a specific payload structure.</p><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative">Example shown above: <strong class="slate-bold">TSYS Processor</strong></div></li><li class="slate-li " ><div style="position:relative">For other processors (PNWX, CKNX, ZCRD, FDRC, WPAY, ELVN), use their respective predefined payload formats.</div></li></ul><div class="slate-hr"><hr contenteditable="false" class="slate-HrElement-hr"/></div><h2 class="slate-h2 " >Error Responses</h2><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:137px;">Title</div><div style="width:194px;">Description</div></div><colgroup ><col style="width:137px"><col style="width:194px"></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">Status Code</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p slate-indent-0" style="0px">Description</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">400</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p slate-indent-0" style="0px">Bad Request</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">401</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p slate-indent-0" style="0px">Unauthorized</p></td></div></tr></tbody></table></div></div><div class="slate-hr"><hr contenteditable="false" class="slate-HrElement-hr"/></div><p class="slate-p " ></p><p class="slate-p " ></p><p class="slate-p " ></p>

The following APIs allow you to manage store-level operations:

If you require additional functionality or custom parameters, please contact your Dejavoo representative.

Device model and manufacturer must match supported combinations:

Each processor requires a specific payload structure.

<p class="slate-p " >This API allows you to add a TPN under an existing merchant and store, update TPN parameters required for device onboarding and integration, and retrieve TPN details.</p><p class="slate-p " >If you require additional parameters or custom configurations, contact your Dejavoo representative.</p><p class="slate-p " ></p>

This API allows you to add a TPN under an existing merchant and store, update TPN parameters required for device onboarding and integration, and retrieve TPN details.

If you require additional parameters or custom configurations, contact your Dejavoo representative.

Sections