Skip to main content
GET
/
transactions
Retrieve Transactions
curl --request GET \
  --url https://api.nuwebgroup.com/v1/transactions \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "type": "transactions",
      "id": 1,
      "attributes": {
        "total": 100,
        "externalFee": 10,
        "orderId": 1,
        "metadata": null,
        "externalApplicationFeeId": null,
        "createdAt": "2021-11-22T11:59:00.000000Z",
        "updatedAt": "2021-11-22T11:59:00.000000Z",
        "status": "Success",
        "type": "card-not-present-online",
        "typeName": "Card (online)"
      },
      "relationships": {
        "currencies": {
          "data": {
            "type": "currencies",
            "id": 1
          }
        },
        "transactionItems": {
          "data": {
            "type": "transactionItems",
            "id": 1891
          }
        }
      }
    }
  ],
  "links": {
    "first": "http://api.upton.com/v1/transactions?page=1",
    "last": "http://api.upton.com/v1/transactions?page=1",
    "prev": null,
    "next": null,
    "self": "http://api.upton.com/v1/transactions?page="
  },
  "meta": {
    "total": 1
  },
  "included": [
    {
      "type": "currencies",
      "id": 1,
      "attributes": {
        "name": "Pounds",
        "code": "GBP",
        "symbol": "Ā£"
      }
    },
    {
      "type": "transactionItems",
      "id": 1891,
      "attributes": {
        "amount": null,
        "metadata": null,
        "createdAt": "2021-03-25T17:05:49.000000Z",
        "updatedAt": "2021-03-25T17:05:49.000000Z"
      }
    }
  ]
}

Authorizations

ā€‹
Authorization
string
header
required

The 'Bearer' token can be obtained from the token management interface or via the login endpoint using your admin user credentials.

Query Parameters

ā€‹
offset
integer

The offset - e.g 100 for listing transactions starting with the 100th transaction. Offset will always take precedence over page.

ā€‹
page
integer

The page you wish to retrieve transactions. You can only paginate by page if no offset is given.

ā€‹
limit
integer

The number of transactions to retrieve per page. The maximum (and default) is 100 per page.

ā€‹
type
enum<string>[]

The types of transactions you wish to retrieve. Can be an array, or comma separated list. If this is empty it will include all transaction types.

Available options:
card-not-present-online,
card-present-online,
card-not-present-offline,
card-present-offline,
cash,
bank,
complimentary,
refund-online,
refund-offline,
offline,
rebooking,
payment-link,
reserve-to-pay-onsite,
invoice,
gift-card
ā€‹
startDate
string

Filter transactions where they were created on or after this 'startDate'. Accepted formats:

  • YYYY-MM-DD HH:MM:SS e.g. 2021-01-01 00:00:00
  • YYYY-MM-DDTHH:mm:ss.SSSSSSZ e.g. 2021-01-01T00:00:00.000000Z
Date formats that do not include the timezone must be in UTC.

ā€‹
endDate
string

Filter transactions where they were created on or before this 'endDate'. Accepted formats:

  • YYYY-MM-DD HH:MM:SS e.g. 2021-01-01 00:00:00
  • YYYY-MM-DDTHH:mm:ss.SSSSSSZ e.g. 2021-01-01T00:00:00.000000Z
Date formats that do not include the timezone must be in UTC.

ā€‹
lastUpdated
string

Date/Time for retrieving transactions who's associated database records (transaction, transaction items) have been updated after the given lastUpdated time. Accepted formats:

  • YYYY-MM-DD HH:MM:SS e.g. 2021-01-01 00:00:00
  • YYYY-MM-DDTHH:mm:ss.SSSSSSZ e.g. 2021-01-01T00:00:00.000000Z
Date formats that do not include the timezone must be in UTC.

ā€‹
include
enum<string>[]

A list of related resources you wish to include in the response. Values can be a url encoded array, or comma separated string.

Available options:
items,
currencies
ā€‹
only
string

A list of attributes that you wish to be returned in the payload. When empty or omitted, all fields will be included by default. Use dot-notation for both top-level resources and child resources, i.e. transactions.total,currencies.name,orderItems.name. Can be used in conjunction with except providing both parameters don't reference the same resource.

ā€‹
except
string

A list of attributes that you wish to exclude from the payload. When empty or omitted, all fields will be included by default. Use dot-notation for both top-level resources and child resources, i.e. transactions.total,currencies.name,orderItems.name. Can be used in conjunction with only providing both parameters don't reference the same resource.

Response

Successfully retrieved the transactions.

ā€‹
data
object[]
ā€‹
links
object
ā€‹
meta
object
ā€‹
included
object[]