IPOSPays API

## Sections
• [Introduction](https://app.theneo.io/dejavoo/ipospays-api/introduction.md): The iPOSPays API is organized around REST . Our API has predictable resource-oriented URLs, accepts form-encoded request bodies, returns JSON-encoded 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 HTTPS . Calls made over plain HTTP will fail. API requests without authentication/token will also fail. Authenication 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. iPOS Transact 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.
• [iposTransact](https://app.theneo.io/dejavoo/ipospays-api/ipostransact.md): 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
  • [Sale](https://app.theneo.io/dejavoo/ipospays-api/ipostransact/sale.md): A sale transaction is a regular transaction where the entered amount is processed and sent to the processor after the batch has been settled.
    • [Sale-CardToken](https://app.theneo.io/dejavoo/ipospays-api/ipostransact/sale/cardtoken.md): 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
    • [Sale-PaymentTokenId](https://app.theneo.io/dejavoo/ipospays-api/ipostransact/sale/paymenttokenid.md): 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
    • [Sale-ACH](https://app.theneo.io/dejavoo/ipospays-api/ipostransact/sale/ach.md): 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.
    • [HSA with TotalAmount](https://app.theneo.io/dejavoo/ipospays-api/ipostransact/sale/sale-hsa/totalamount.md): To process healthcare transactions—such as accepting Health Savings Account (HSA) and Flexible Spending Account (FSA) cards—use the Sale with HSA section of the iPOS Transact API by sending the following request.
    • [HSA with VisionAmount](https://app.theneo.io/dejavoo/ipospays-api/ipostransact/sale/sale-hsa/visionamount.md): To process healthcare transactions—such as accepting Health Savings Account (HSA) and Flexible Spending Account (FSA) cards—use the Sale with HSA section of the iPOS Transact API by sending the following request.
  • [Void](https://app.theneo.io/dejavoo/ipospays-api/ipostransact/void1.md): A Void transaction is used to cancel a previously authorized transaction before the batch is closed and sent to the processor.
    • [Void](https://app.theneo.io/dejavoo/ipospays-api/ipostransact/void1/void.md): A Void transaction is used to cancel a previously authorized transaction before the batch is closed and sent to the processor.
    • [Void with ACH](https://app.theneo.io/dejavoo/ipospays-api/ipostransact/void1/void-ach.md): The Void with ACH section in the IPOSPays Payment Services API allows users to process ACH void for merchant transactions. This functionality used to void the original transactions.
  • [PreAuth](https://app.theneo.io/dejavoo/ipospays-api/ipostransact/preauth.md): A Pre Auth transaction allows the user to temporarily reserve a specific amount of money for a transaction.
    • [PreAuth-CardToken](https://app.theneo.io/dejavoo/ipospays-api/ipostransact/preauth/cardtoken.md): The PreAuth with CardToken section of the API allows users to process transactions for PreAuth using cardToken. CardToken - Tokenized card value used to capture the specified amount for the tokenized card
    • [PreAuth-PaymentTokenId](https://app.theneo.io/dejavoo/ipospays-api/ipostransact/preauth/paymenttokenid.md): The Sale with PaymentTokenId section of the API allows users to process transactions for sales using PaymentTokenId . PaymentTokenId - Tokenized payment value/string used to capture the specified amount for the tokenized card
    • [HSA with TotalAmount](https://app.theneo.io/dejavoo/ipospays-api/ipostransact/preauth/preauth-hsa/hsa-with-totalamount.md): To process healthcare transactions—such as accepting Health Savings Account (HSA) and Flexible Spending Account (FSA) cards—use the PreAuth with HSA section of the iPOS Transact API by sending the following request.
    • [HSA with VisionAmount](https://app.theneo.io/dejavoo/ipospays-api/ipostransact/preauth/preauth-hsa/hsa-with-visionamount.md): To process healthcare transactions—such as accepting Health Savings Account (HSA) and Flexible Spending Account (FSA) cards—use the PreAuth with HSA section of the iPOS Transact API by sending the following request.
  • [Refund](https://app.theneo.io/dejavoo/ipospays-api/ipostransact/refund.md): 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.
  • [Ticket](https://app.theneo.io/dejavoo/ipospays-api/ipostransact/ticket.md): A Ticket transaction is used to retrieve and process the amount that was temporarily held in the Pre Auth transaction.
  • [IncrementalAuth](https://app.theneo.io/dejavoo/ipospays-api/ipostransact/incrementalauth.md): 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.
  • [TipAdjust](https://app.theneo.io/dejavoo/ipospays-api/ipostransact/tipadjust.md): Tip Adjust enables users to modify the tip amount on a transaction before the batch is settled and sent to the processor.
  • [OpenBatch](https://app.theneo.io/dejavoo/ipospays-api/ipostransact/openbatch.md): 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.
  • [SettleBatch](https://app.theneo.io/dejavoo/ipospays-api/ipostransact/settlebatch.md): 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.
  • [Gift](https://app.theneo.io/dejavoo/ipospays-api/ipostransact/gift.md): A Gift Transaction is a payment that uses the available balance on a customer’s gift card.
• [iposTransact-Spin](https://app.theneo.io/dejavoo/ipospays-api/ipostransact-spin.md): 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
  • [Sale](https://app.theneo.io/dejavoo/ipospays-api/ipostransact-spin/spin-sale.md): A sale transaction is a regular transaction where the entered amount is processed and sent to the processor after the batch has been settled.
    • [Sale-CardToken](https://app.theneo.io/dejavoo/ipospays-api/ipostransact-spin/spin-sale/cardtoken.md): 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
    • [Sale-PaymentTokenId](https://app.theneo.io/dejavoo/ipospays-api/ipostransact-spin/spin-sale/paymenttokenid.md): 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
  • [Void](https://app.theneo.io/dejavoo/ipospays-api/ipostransact-spin/void.md): A Void transaction is used to cancel a previously authorized transaction before the batch is closed and sent to the processor.
  • [PreAuth](https://app.theneo.io/dejavoo/ipospays-api/ipostransact-spin/preauth.md): A Pre Auth transaction allows the user to temporarily reserve a specific amount of money for a transaction.
    • [PreAuth-CardToken](https://app.theneo.io/dejavoo/ipospays-api/ipostransact-spin/preauth/preauth-cardtoken.md): The PreAuth with CardToken section of the API allows users to process transactions for PreAuth using cardToken. CardToken - Tokenized card value used to capture the specified amount for the tokenized card
    • [PreAuth-PaymentTokenId](https://app.theneo.io/dejavoo/ipospays-api/ipostransact-spin/preauth/preauth-paymenttokenid.md): The Sale with PaymentTokenId section of the API allows users to process transactions for sales using PaymentTokenId . PaymentTokenId - Tokenized payment value/string used to capture the specified amount for the tokenized card
  • [Refund](https://app.theneo.io/dejavoo/ipospays-api/ipostransact-spin/refund.md): 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.
  • [Ticket](https://app.theneo.io/dejavoo/ipospays-api/ipostransact-spin/ticket.md): A Ticket transaction is used to retrieve and process the amount that was temporarily held in the Pre Auth transaction.
  • [TipAdjust](https://app.theneo.io/dejavoo/ipospays-api/ipostransact-spin/tipadjust.md): Tip Adjust enables users to modify the tip amount on a transaction before the batch is settled and sent to the processor.
  • [SettleBatch](https://app.theneo.io/dejavoo/ipospays-api/ipostransact-spin/settlebatch.md): 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.