Retrieve Transaction

Retrieve the current status and full details of a specific transaction.

The response fields depend on the transaction's state. Incomplete transactions return a subset of fields. Completed transactions (whether successful or failed) include the full set — card details, customer information, hash, gateway message, and credited amounts.

Endpoint

GET /transactions/{transaction_id}

Access	Requirement
Authenticated	Yes
Required Scope	`wapi-transactions-retrieve`, or `wapi-transactions-all`
Rate Limit	60 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.

Path Parameters

Parameter	Type	Required	Description
`transaction_id`	string	Yes	The WiPay transaction ID to retrieve

Responses

200 OK

The response shape depends on the transaction status.

Incomplete

{
  "message": "OK",
  "data": {
    "currency": "USD",
    "data": "{\"extra\":\"data\"}",
    "date": "2026-03-10T08:50:22+00:00",
    "fee_structure": "Customer Pay",
    "order_id": "yu70fTApIY",
    "status": "incomplete",
    "status_desc": "Transaction Incomplete",
    "total": "1.00",
    "transaction_id": "SB-1-10-yu70fTApIY-20260310045020"
  }
}

Failed

{
  "message": "OK",
  "data": {
    "card": "(MASTERCARD) ... 0031",
    "currency": "USD",
    "currency_credited": "USD",
    "customer_address": null,
    "customer_email": "wapi@test.com",
    "customer_name": "TEST CUSTOMER",
    "customer_phone": null,
    "data": "{\"extra\":\"data\"}",
    "date": "2026-03-10T08:53:32+00:00",
    "fee_structure": "Customer Pay",
    "hash": "3e2ce314d4ee7683d534d2a590f41a79b7c4c6f2b838d0881299eb810d1df23a",
    "message": "[3-RA9]: 3DS authentication failed.",
    "order_id": "yu70fTApIY",
    "origin": "Card payment via Wapi Example plugin",
    "receiver": "TEST MERCHANT",
    "status": "failed",
    "status_desc": "Normal",
    "total": "1.29",
    "total_credited": "1.00",
    "transaction_id": "SB-1-10-yu70fTApIY-20260310045020"
  }
}

Successful

{
  "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"
  }
}

Transaction Data Object (Completed)

Field	Type	Description
`transaction_id`	string	Unique transaction identifier
`order_id`	string	Your order/reference ID
`status`	string	`"success"`, `"failed"`, or `"incomplete"`
`status_desc`	string	Status description: `"Normal"`, `"Refund Requested"`, `"Refunded"`, `"WAPI - Transferred to MMA"`, or `"Transaction Incomplete"`
`total`	string	Transaction amount charged
`total_credited`	string	Amount credited to the merchant
`currency`	string	Currency of the transaction
`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
`fee_structure`	string	Fee arrangement display name
`hash`	string	Transaction verification hash
`message`	string	Gateway result code and message
`data`	string \| null	Custom data passed during payment initiation

Transaction Data 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

400 Bad Request

{
  "message": "The selected transaction id 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/SB-32-55179-oId_123-Abc1-20260202232018" \
  -H "Accept: application/json" \
  -H "Authorization: Bearer <access_token>"

Retrieve Transaction

On this page