Dejavoo

Introduction

API for managing IposTransact Card operations including Sale,Void,Ticket,Refund,PreAuth,IncrementalAuth,OpenBatch,SettleBatch

iposTransact

Sale

Void

PreAuth

Refunds a transaction made with a Sale or PreAuth, or adds funds back to the card.

Refund

Ticket

IncrementalAuth for the PreAuthorized Transaction

IncrementalAuth

TipAdjust

OpenBatch Request for Non Settled Batch Request

OpenBatch

SettleBatch Request to process for Merchant

SettleBatch

Gift

Error Code & Messages

Default

IPOSPays API

Endpoint: v1

Production

Sandbox

The iPOSPays API is organized around <a href="http://en.wikipedia.org/wiki/Representational_State_Transfer" target="_blank">REST</a>. Our API has predictable resource-oriented URLs, accepts form-encoded request bodies, returns <a href="http://www.json.org/" target="_blank">JSON-encoded</a> responses, and uses standard HTTP response codes, authentication, and verbs.You can use the iPOSPays API in test mode, which doesn’t affect your live data. All API requests must be made over <a href="http://en.wikipedia.org/wiki/HTTP_Secure" target="_blank">HTTPS</a>. Calls made over plain HTTP will fail. API requests without authentication/token will also fail.<div class=card-group-box style="width:100%; min-width:540px;"><div class="card-box without-icon"><div ><h3 class="slate-h3 " >Authenication</h3>The iPOSPays API uses API keys or token to authenticate requests. To Generate an access token using your API and secret key (Which will be provided to you via email through your Dejavoo representative). This token authorizes your system to interact with the iPOSpays APIs.</div></div><div class="card-box without-icon"><div ><h3 class="slate-h3 " >iPOS Transact</h3>The iPOS Transact API empowers merchants to streamline their payment processes by enabling void, full or partial refunds, and sale transactions using card tokens directly from their own CRM or billing software. With this API, merchants can bypass the need to log in to the iPOSpays portal for many transaction types, improving efficiency and integration with third-party applications.</div></div></div>

. Our API has predictable resource-oriented URLs, accepts form-encoded request bodies, returns 

 responses, and uses standard HTTP response codes, authentication, and verbs.

You can use the iPOSPays API in test mode, which doesn’t affect your live data. 

. Calls made over plain HTTP will fail. API requests without authentication/token will also fail.

The iposTransact section of the API allows users to manage various operations related to IposTransact Card transactions, such as sales, voids, refunds, pre-authorizations, and batch settlements. With this functionality, users can efficiently handle card transactions and maintain accurate records of their financial activities.API for managing IposTransact Card operations including Sale, Void, Ticket, Refund, PreAuth, IncrementalAuth, OpenBatch, SettleBatch

The iposTransact section of the API allows users to manage various operations related to IposTransact Card transactions, such as sales, voids, refunds, pre-authorizations, and batch settlements. With this functionality, users can efficiently handle card transactions and maintain accurate records of their financial activities.

API for managing IposTransact Card operations including Sale, Void, Ticket, Refund, PreAuth, IncrementalAuth, OpenBatch, SettleBatch

A sale transaction is a regular transaction where the entered amount is processed and sent to the processor after the batch has been settled.

A sale transaction is a regular transaction where the entered amount is processed and sent to the processor after the batch has been settled.

The Sale with CardToken section of the API allows users to process transactions for sales using cardToken.CardToken - Tokenized card value used to capture the specified amount for the tokenized card

The Sale with CardToken section of the API allows users to process transactions for sales using cardToken.

Tokenized card value used to capture the specified amount for the tokenized card

Sale-CardToken

Includes merchant authentication details, such as the TPN number and unique transaction reference ID.

merchantAuthentication

Specifies whether AVS (Address Verification Service) verification is needed or if an e-receipt should be sent via SMS/email to the end user.

preferences

Contains details such as transaction type, card token, amount, fee calculation, etc.

transactionRequest

Provides AVS details, including street number and ZIP code.

Token generated from the Authentication System

token

iposhpresponse

errors

Bad Request - Invalid input for Authorized operation

The Sale with PaymentTokenId section of the API allows users to process transactions for sales using PaymentTokenId.PaymentTokenId - Tokenized payment value used to capture the specified amount for the tokenized card

section of the API allows users to process transactions for sales using 

Tokenized payment value used to capture the specified amount for the tokenized card

Sale-PaymentTokenId

The Sale with ACH section of the iPOS Transact API enables users to process bank-to-bank transactions via the ACH (Automated Clearing House) network.

The Sale with ACH section of the iPOS Transact API enables users to process bank-to-bank transactions via the ACH (Automated Clearing House) network.

Sale-ACH

Sale-HSA

A Void transaction is used to cancel a previously authorized transaction before the batch is closed and sent to the processor.

A Void transaction is used to cancel a previously authorized transaction before the batch is closed and sent to the processor.

A Pre Auth transaction allows the user to temporarily reserve a specific amount of money for a transaction.

A Pre Auth transaction allows the user to temporarily reserve a specific amount of money for a transaction.

A Refund transaction is used to refund the amount back to the customer after the batch has been settled. The refund amount is then sent to the processor.

A Refund transaction is used to refund the amount back to the customer after the batch has been settled. The refund amount is then sent to the processor.

Token generated from the Authentication System.

Bad Request - Invalid input for refund operation

A list of detailed error messages related to the refund transaction.

A Ticket transaction is used to retrieve and process the amount that was temporarily held in the Pre Auth transaction.

A Ticket transaction is used to retrieve and process the amount that was temporarily held in the Pre Auth transaction.

Bad Request - Invalid input for ticket operation

Incremental Authorization allows merchants to easily adjust a Pre Auth transaction when a customer exceeds the initial amount, without having to void and reprocess the transaction.

Incremental Authorization allows merchants to easily adjust a Pre Auth transaction when a customer exceeds the initial amount, without having to void and reprocess the transaction.

Token generated from the Authentication System--------

Collection of error details for the transaction

Bad Request - Invalid input for IncrementalAuth operation

Tip Adjust enables users to modify the tip amount on a transaction before the batch is settled and sent to the processor.

Tip Adjust enables users to modify the tip amount on a transaction before the batch is settled and sent to the processor.

Bad Request - Invalid input for tipAdjust operation

A detailed list of error messages and their corresponding details.

An Open Batch allows merchants to view all transactions, review the batch summary, and void transactions before they are settled and sent to the processor.

An Open Batch allows merchants to view all transactions, review the batch summary, and void transactions before they are settled and sent to the processor.

Bad Request - Invalid input for OpenBatch operation

Batch settlement is the process of consolidating and submitting all authorized transactions at the end of the business day to the payment processor. This ensures timely reconciliation and transfer of funds to the merchant’s bank account.

Batch settlement is the process of consolidating and submitting all authorized transactions at the end of the business day to the payment processor. This ensures timely reconciliation and transfer of funds to the merchant’s bank account.

Bad Request - Invalid input for SettleBatch operation

A Gift Transaction is a payment that uses the available balance on a customer’s gift card.

 is a payment that uses the available balance on a customer’s gift card.

Sections