curl --get "${BASE_URL}/api/v2/trans/list" \
  -H "Authorization: Bearer ${ACCESS_TOKEN}" \
  -H "Accept: application/json" \
  --data-urlencode page=1 \
  --data-urlencode size=20

{
  "code": 0,
  "message": "ok",
  "data": {
    "list": [
      {
        "business_id": "7294815",
        "merchant_id": "48290713",
        "order_number": "b1893452400000741",
        "merchant_order_no": "ORDER-20300101-001",
        "trans_type": 1,
        "trans_type_text": "Payment",
        "original_order_number": null,
        "status": 1,
        "status_text": "Successful",
        "amount": "10.00",
        "currency": "AUD",
        "surcharge_amount": "0.50",
        "surcharge_currency": "AUD",
        "payment_amount": "10.50",
        "payment_currency": "AUD",
        "created_at": "15/01/2030 10:32:41",
        "complete_date": "15/01/2030 10:32:43",
        "process_date": null,
        "cancelled_at": null,
        "expired_at": null,
        "payment_method": {
          "type": 2,
          "type_text": "Credit",
          "card_brand": "Visa",
          "wallet_type": null
        },
        "result": "Successful"
      }
    ],
    "page": 1,
    "size": 20,
    "total": 1
  }
}

Transactions

List transactions

Retrieve transactions for the authenticated merchant, paginated with the newest records first. This is a read-only lookup and does not execute payments again.

Optional Mid is a case-sensitive business identifier. Supply it to query that business, or omit it to query all businesses belonging to the authenticated merchant. Other merchants’ businesses are inaccessible. This endpoint uses Mid rather than merchant_id.

Supply both start_date and end_date, or omit both. Dates use YYYY-MM-DD and filter transaction creation dates inclusively in Australia/Sydney, including daylight saving time. The default is today and the preceding six days, a total of seven calendar days. end_date must be on or after start_date. The window must not exceed three calendar months: midnight after end_date must be no later than midnight on start_date plus three months; if that day does not exist in the target month, use the last day of that month. For example, 2026-01-31 through 2026-04-29 is valid; an end date of 2026-04-30 exceeds the limit.

Optional order_number and merchant_order_no are exact-match filters. If both are supplied, both must match the same transaction. Order filters still respect the date and business filters. page defaults to 1; size defaults to 20 and has a maximum of 50. No matches or an out-of-range page returns list=[]; total remains the number of transactions matching all filters.

GET

/

api

/

v2

/

trans

/

list

curl --get "${BASE_URL}/api/v2/trans/list" \
  -H "Authorization: Bearer ${ACCESS_TOKEN}" \
  -H "Accept: application/json" \
  --data-urlencode page=1 \
  --data-urlencode size=20

{
  "code": 0,
  "message": "ok",
  "data": {
    "list": [
      {
        "business_id": "7294815",
        "merchant_id": "48290713",
        "order_number": "b1893452400000741",
        "merchant_order_no": "ORDER-20300101-001",
        "trans_type": 1,
        "trans_type_text": "Payment",
        "original_order_number": null,
        "status": 1,
        "status_text": "Successful",
        "amount": "10.00",
        "currency": "AUD",
        "surcharge_amount": "0.50",
        "surcharge_currency": "AUD",
        "payment_amount": "10.50",
        "payment_currency": "AUD",
        "created_at": "15/01/2030 10:32:41",
        "complete_date": "15/01/2030 10:32:43",
        "process_date": null,
        "cancelled_at": null,
        "expired_at": null,
        "payment_method": {
          "type": 2,
          "type_text": "Credit",
          "card_brand": "Visa",
          "wallet_type": null
        },
        "result": "Successful"
      }
    ],
    "page": 1,
    "size": 20,
    "total": 1
  }
}

Authorizations

Authorization

string

header

required

OAuth2 client_credentials authorization. Obtain a new access_token when it expires.

Query Parameters

Mid

string | null

Optional business identifier belonging to the authenticated merchant; omit for all its businesses.

Maximum string length: 20

order_number

string | null

BillBuddy transaction number; exact match combined with other filters.

Maximum string length: 60

merchant_order_no

string | null

Caller order number; exact match combined with other filters.

Maximum string length: 64

start_date

string<date> | null

Inclusive creation start date; supply together with end_date. If both are omitted, starts six days before today. See the endpoint description for window boundaries.

end_date

string<date> | null

Inclusive creation end date; required with start_date and must not precede it. Maximum window is three calendar months as defined in the endpoint description.

page

integer | null

default:1

Page number, starting at 1; default 1.

Required range: x >= 1

size

integer | null

default:20

Page size; default 20, maximum 50.

Required range: 1 <= x <= 50

Response

HTTP 200; code=0 success, code=400 invalid parameters, code=1 business or authentication failure.

Option 1
Option 2

Successful transaction list lookup.

code

enum<integer>

required

Request succeeded; see list for individual transaction states.

Available options:

0

message

string

required

Result message; ok on success.

data

object

required

Filtered results and pagination.

Show child attributes