Transaction History

Retrieve a paginated list of your transactions, filterable by environment.

Each object in the data array contains the details of one transaction. Completed transactions include the full set of fields. Incomplete transactions contain a subset — fields such as card, customer_email, hash, message, origin, receiver, and total_credited are only present once a payment attempt has been made.

Endpoint

GET /transactions

Access	Requirement
Authenticated	Yes
Required Scope	`wapi-transactions-retrieve`, or `wapi-transactions-all`
Rate Limit	15 requests per minute

Request

Headers

Header	Value
`Accept`	`application/json`
`Authorization`	`Bearer <access_token>`
`X-WAPI-Key`	`wapi_live_<kid>_<secret>` or `wapi_test_<kid>_<secret>`

Send exactly one of Authorization or X-WAPI-Key.

Query Parameters

Parameter	Type	Required	Default	Description
`environment`	string	Yes	—	`"sandbox"` or `"live"`
`page_size`	integer	No	`15`	Number of results per page
`page`	integer	No	`1`	Page number for pagination

Responses

200 OK

{
  "message": "OK",
  "data": [
    {
      "card": "(MASTERCARD) ... 0031",
      "currency": "USD",
      "currency_credited": "TTD",
      "customer_address": null,
      "customer_email": "wapi@test.com",
      "customer_name": "TEST CUSTOMER",
      "customer_phone": null,
      "data": "{\"extra\":\"data\"}",
      "date": "2026-02-03T03:24:53+00:00",
      "fee_structure": "Customer Pay",
      "hash": "59492afa9b7dc901a71b4abc4f2a37e2e83da25e46417bb977a5b03cab022b66",
      "message": "[1-R00]: Transaction is approved.",
      "order_id": "oId_123-Abc1",
      "origin": "Card payment via Example Origin plugin",
      "receiver": "TEST MERCHANT",
      "status": "success",
      "status_desc": "Normal",
      "total": "23.84",
      "total_credited": "155.00",
      "transaction_id": "SB-32-55179-oId_123-Abc1-20260202232018"
    },
    {
      "currency": "TTD",
      "data": "{\"extra\":\"data\"}",
      "date": "2026-02-01T01:33:24+00:00",
      "fee_structure": "Customer Pay",
      "order_id": "oId_123-Abc1",
      "status": "incomplete",
      "status_desc": "Transaction Incomplete",
      "total": "155.00",
      "transaction_id": "SB-60-55179-oId_123-Abc1-20260131213323"
    }
  ],
  "links": {
    "first": "https://...",
    "last": "https://...",
    "prev": null,
    "next": "https://..."
  },
  "meta": {
    "current_page": 1,
    "from": 1,
    "last_page": 6,
    "path": "https://...",
    "per_page": "5",
    "to": 5,
    "total": 26
  }
}

Transaction Object (Completed)

Field	Type	Description
`transaction_id`	string	Unique transaction identifier
`order_id`	string	Your order/reference ID
`status`	string	`"success"`, `"failed"`, `"incomplete"`
`status_desc`	string	Human-readable status description (e.g., `"Normal"`, `"WAPI - Transferred to MMA"`, `"Transaction Incomplete"`)
`total`	string	Transaction amount charged
`total_credited`	string	Amount credited to the merchant
`currency`	string	Currency of the transaction (e.g., `"USD"`, `"TTD"`)
`currency_credited`	string	Currency credited to the merchant
`date`	string	ISO 8601 timestamp
`card`	string	Masked card details (e.g., `"(MASTERCARD) ... 0031"`)
`customer_name`	string	Name of the payer
`customer_email`	string	Payer's email address
`customer_phone`	string \| null	Payer's phone number
`customer_address`	string \| null	Payer's address
`receiver`	string	Name of the receiving merchant
`origin`	string	Source of the transaction (e.g., plugin or integration identifier)
`fee_structure`	string	Fee arrangement display name (e.g., `"Customer Pay"`)
`hash`	string	Transaction verification hash
`message`	string	Gateway result code and message (e.g., `"[1-R00]: Transaction is approved."`)
`data`	string \| null	Custom data passed during payment initiation

Transaction Object (Incomplete)

Incomplete transactions have not yet received a payment attempt. Only these fields are present:

transaction_id, order_id, status, status_desc, total, currency, date, fee_structure, data

Pagination

Field	Type	Description
`meta.current_page`	integer	Current page number
`meta.last_page`	integer	Total number of pages
`meta.per_page`	string	Items per page
`meta.total`	integer	Total number of transactions
`meta.from`	integer	Starting record index
`meta.to`	integer	Ending record index
`links.first`	string	URL to first page
`links.last`	string	URL to last page
`links.prev`	string \| null	URL to previous page
`links.next`	string \| null	URL to next page

400 Bad Request

{
  "message": "The selected environment is invalid."
}

401 Unauthorized

{
  "message": "Unauthorized"
}

403 Forbidden

Insufficient permissions

{
  "message": "Forbidden"
}

Invalid scopes

{
  "message": "Invalid scope(s) provided."
}

Example

curl -X GET "https://ttsb.wipayfinancial.com/wapi/transactions?environment=sandbox&page_size=5&page=1" \
  -H "Accept: application/json" \
  -H "Authorization: Bearer <access_token>"

On this page