To model your transactions, you create transactions. Vertex provides a number of requests to help you with this.

Typically, transactions are created by the requests that you integrate the API with. However, you can also upload bulk transactions. See Bulk Transaction Uploads.

Transaction Modelling

To create a transaction, you use a Store Transaction request. See Store transaction.

You model the transaction in the JSON that is attached to the request:

$ curl -X 'POST' -H "Content-Type: application/json" -d \
 '{
      "transaction": {
          "transaction_lines": [
              {
                  "custom_id": "line1",
                  "amount": 100
              }
          ],
          "buyer_ip": "109.121.15.46",
          "currency_code": "EUR",
          "billing_country_code": "BE",
          "buyer_credit_card_prefix": "424242424"
      },
      "private_token": "priv_***********"
  }' \
 'https://services.taxamo.com/api/v2/transactions'

The Store Transaction request returns a Transaction Key in the key field. When you are ready to conclude the transaction, you send this Key in the URL of the Confirm Transaction request and this completes the transaction. This triggers the invoice. See Confirm transaction.

Transaction Creation

To model your transactions, you create transactions. Vertex provides a number of requests to help you with this:

Request	Use
Store transaction	Use this request to provide more detailed tax information and to store a transaction. The stored transaction can then be adjusted, cancelled or confirmed.
Confirm transaction	Use this request to confirm a transaction. You can configure exactly when to suit your needs. It might be after the payment is finalized, for example.
Create a refund	Use this request to facilitate refunds.

Transactions are modelled in the JSON that is attached to these requests. See Fields.

Transaction lines can be modelled in the Transaction object.

Cancelling Transactions

The following requests are provided to facilitate the cancellation of transactions and refunds:

Requests	Description
Cancel transaction	Use this request to cancel transactions.
Cancel refund	Use this request to cancel a refund.
Cancel refund by subnumber	Use this request to cancel a refund that is specified by the refund subnumber. This cannot be used for transactions where Taxamo is liable that is, for Taxamo Assure customers.

Retrieving Transactions

The following table lists the requests that are provided to help you to retrieve transaction and refund data:

Requests	Description
Get transaction refunds	Use this request to retrieve the refunds that are associated with the specified transaction.
Browse transactions	Use this request to browse transaction data.
Retrieve transaction	Use this request to retrieve the transaction record for a specified Transaction Key.
Retrieve full transaction	Use this request to retrieve the full record that is associated with the specified Transaction Key.
Get event data	Use this request to retrieve data for the specified Event ID.