QDI

COPY

localhost:3000/api/null/v3/transaction

Create a new transaction (sale or auth). Transactions can also be scheduled using this endpoint by simply passing in a schedule object.

{
  "credit_card": {
    "number": "4000100011112224",
    "exp": "0932",
    "cvv": "123"
  },
  "amount": 1.04,
  "type": "sale"
}

COPY

localhost:3000/api/null/v3/transaction/search

Get a collection of transactions matching the supplied criteria. At least one parameter is required. Specify the search in the URL query string. Possible query keys are below Example: GET [base_url]transaction/search?date=2022-03-22&amount=1.02 will get all transactions run on the 22nd of march 2022 for $1.02.

COPY

localhost:3000/api/null/v3/transaction/{transaction_id}

Get a single transaction by its ID.

COPY

localhost:3000/api/null/v3/transaction/{refund_transaction_id}

A refund should be used once the transaction you are refunding has settled. If you are trying to cancel a transaction that is still in the currenly open batch, you should use the void command instead. To refund a transaction that has been settled, you will pass in the transaction object with the type of 'refund', the original transaction id, and the amount you would like to refund. Most merchant accounts do not allow you to refund more than the original amount of the transaction. However, depending on the Credit Policy, a refund can be processed for larger than the original transaction amount.

{
  "type": "refund",
  "transaction_id": "{original_transaction_id}",
  "amount": 1.04
}

COPY

localhost:3000/api/null/v3/transaction/{capture_transaction_id}

The capture command moves an authorized transaction into the current batch for settlement. It is possible to capture an amount other than the one originally authorized, however, you must follow the guidelines established by the merchant service bank. Capturing a higher or lower dollar amount could result in additional penalties and fees. Most banks typically allow no more than 10 days to pass between the authorization/capture and settlement of a transaction.

{
  "type": "capture",
  "amount": 1.04
}

COPY

localhost:3000/api/null/v3/transaction/{void_transaction_id}

Once a transaction has been voided, it will not show up on the customer's credit card statement. Customers who have online banking that allows them to see 'Pending' transactions may see the voided transaction for a few days before it disappears. You can only void a transaction that hasn't been settled yet. A transaction is settled when the batch that it is in has been closed. If the transaction has been settled, you must run a refund instead using a void transaction. If you run a credit, both the credit and the initial charge will show up on the customer's credit card statement. You can void a transaction by putting the original transaction with a type of 'void'. For a Lodging transaction, you can increment it by posting it with a type of 'incremental' and the additional amount as the amount. For check-out, post the original transaction with a type of 'sale'.

{
  "type": "void"
}