REST API Endpoints for Transactions

Overview

Order transactions allow merchants to process, audit, and communicate payment details internally and externally for their store.  This area of the API allows you to manage how that is done.

Requirements

The following pre-requisites will be necessary to accomplish the goals of this article:

  • General understanding of REST and API’s
  • Understanding of C# and/or JavaScript

Getting Started

If you haven’t already done so, you should probably have a development environment ready to development against, complete with Hotcakes installed and configured.

REST API endpoints for Order Transactions

There are a handful of REST API endpoints that allow you to display or manage various aspects of transactions.  Those endpoints are detailed below.

Endpoint Return Type Description
OrderTransactionsCreate OrderTransactionDTO Creates a new transaction for an order in the store.
OrderTransactionsDelete Boolean Permanently deletes the specified transaction from the store.
OrderTransactionsFind OrderTransactionDTO Allows you to look for and return a specific transaction from the store.
OrderTransactionsFindForOrder List of OrderTransactionDTO Returns all transactions for the specified order.
OrderTransactionsUpdate OrderTransactionDTO Updates an existing transaction with the changes in the given transaction.

 

Have more questions? Submit a request

Need More Help?

Do you need more assistance with this article? Please review your support options.