Query a transaction

Look up the current status of an existing payment, refund or dispute. Use an OAuth2 Bearer token; no request signature is required. Supply at least one of order_number and merchant_order_no. If both are provided, they must identify the same transaction. If a third-party reference matches multiple transactions, code=1 is returned; provide the BillBuddy transaction number.

code=0 means the lookup succeeded; use data.status to assess the payment outcome. For a cancelled transaction, result is Cancelled while status is still returned separately. Amounts are two-decimal strings in major currency units. Times use Australia/Sydney, including daylight saving; field descriptions specify formats. This lookup does not initiate or repeat a payment. If no transaction is found, verify the order and processing status before considering another payment.

merchant_id is an optional business filter. Omit it or leave it empty to search all businesses of the authenticated merchant; supply it to restrict the lookup to that business. If a reference is reused across businesses, use merchant_id to narrow the search or provide order_number to identify the transaction uniquely.

GET /api/v2/trans/queryTrans

cURL

Look up by BillBuddy transaction number

curl --get "${BASE_URL}/api/v2/trans/queryTrans" \ -H "Authorization: Bearer ${ACCESS_TOKEN}" \ -H "Accept: application/json" \ --data-urlencode merchant_id=48290713 \ --data-urlencode order_number=b1893452400000741

200

successful

{ "code": 0, "message": "ok", "data": { "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": "01/01/2030 10:00:00", "complete_date": "01/01/2030 10:00:05", "process_date": null, "cancelled_at": null, "expired_at": null, "payment_method": { "type": 2, "type_text": "Credit", "card_brand": "Visa", "wallet_type": null }, "result": "Successful" } }

Authorizations

Authorization · string · header · required

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

Query Parameters

merchant_id · string | null

Optional business identifier, up to 20 characters. When supplied, it must belong to the authenticated merchant. Omit it or leave it empty to locate a transaction across all businesses of that merchant.

Maximum string length: 20

order_number · string | null

BillBuddy transaction number; supply this or merchant_order_no. Both must match the same transaction when supplied together.

Maximum string length: 60

merchant_order_no · string | null

Third-party order reference; supply this or order_number. If multiple transactions match, provide order_number.

Maximum string length: 64

Response

200

application/json

HTTP 200. code=0 means the lookup succeeded; code=1 indicates a business or authentication error; code=400 indicates invalid query parameters.

Option 1

Option 2

code · enum<integer> · required

Lookup succeeded; this does not confirm payment success.

Available options: 0

message · string · required

Result message; ok on success.

Example:

"ok"

data · object · required

Response data.

Show child attributes