How to view transactions

Overview

Transactions represent payment activity associated with orders: authorizations, captures, sales, refunds, and adjustments. The Transaction API is a read-only REST API under v2 (this differs from the other Commerce REST endpoints which use v1).

Prerequisites

The following prerequisites are required before you view transactions:

• a GoDaddy account with an active commerce store
• a Personal Access Token (PAT) with the commerce.transaction:read scope
• your storeId
  Find your store ID

  Go to Your stores to find your store ID.

List transactions

GET /v2/commerce/stores/{storeId}/transactions retrieves all transactions for a store. The following optional query parameters narrow the results:

The following procedure lists the most recent 20 transactions.

1. Retrieve a page of transactions:

   curlNodePythonGo

   curl -s "https://api.godaddy.com/v2/commerce/stores/${STORE_ID}/transactions?pageSize=20&sortOrder=DESC" \
     -H "Authorization: Bearer $GODADDY_PAT"

2. Review the response including the paginated list of transactions:

   {
     "items": [
       {
         "id": "<TRANSACTION_ID>",
         "orderId": "<ORDER_ID>",
         "type": "<TRANSACTION_TYPE>",
         "status": "<TRANSACTION_STATUS>",
         "amount": {
           "value": "<TRANSACTION_AMOUNT>",
           "currency": "<ISO_4217_CURRENCY_CODE>"
         },
         "createdAt": "<ISO8601_CREATED_TIMESTAMP>",
         "updatedAt": "<ISO8601_UPDATED_TIMESTAMP>"
       }
     ],
     "page": 1,
     "pageSize": 20
   }

Get a transaction

GET /v2/commerce/stores/{storeId}/transactions/{transactionId} retrieves a single transaction by ID.

The following procedure reads a single transaction by ID.

• Retrieve a single transaction by its id:

  curlNodePythonGo

  TRANSACTION_ID="<TRANSACTION_ID>"
  
  curl -s "https://api.godaddy.com/v2/commerce/stores/${STORE_ID}/transactions/${TRANSACTION_ID}" \
    -H "Authorization: Bearer $GODADDY_PAT"

Common errors

The following table lists common errors when viewing transactions, the most likely cause, and additional notes:

Last updated on