Get institution transaction
Requires transaction_id and institution_name.
Endpoint​
GET /institution/transaction
Query Parameters​
version(string, required) - API contract version. Use exactly 2024-10-01.diagnostics(boolean, optional) - Non-production docs only. Set true to include extra diagnostic metadata (for example observed_client_ip).transaction_id(string, required)institution_name(string, required)
Header Parameters​
PW-subscription-key(string, required)PW-origin-country(string, required)PW-request-date(string, required) - UTC request timestamp formatted asYYYY-MM-DD HH:mm:ss.PW-ip-address(string, required)User-Agent(string, required)
Header Constraints​
| Key | Description | Example | Data type | Requirement | Field Length |
|---|---|---|---|---|---|
PW-subscription-key | Developer key available after portal registration. Production key is shared on request. | eed0d85c530c4b26a91d09b783d8fab3 | string | mandatory | 32 |
PW-origin-country | ISO Alpha-2 country code where the transaction is created. | TT | string | mandatory | 2 |
PW-request-date | Current request timestamp. Format: YYYY-MM-DD HH:mm:ss (UTC). | 2014-10-08 16:01:31 | string | mandatory | 19 |
PW-ip-address | Fixed institution IP used for PayWise network-level validation. | 255.255.255.255 | string | conditional | 8-16 |
User-Agent | In programmable environments, this avoids running into Cloudflare issues. | Mozilla/5.0 (Windows NT 10.0; Win64; x64) | string | mandatory | 255 |
Request Body​
No JSON request body.
Before You Implement​
- Read Transactions Overview
- Read Token Encryption Guide
Responses​
200 - Wrapper-normalized response envelope (success cases).​
Example: success​
{
"status": "success",
"code": 200,
"message": "Transaction status fetched successfully",
"request_id": "46813808-66cb-49c6-9cda-5a8bddf62362",
"timestamp": "2026-02-11T03:59:45.928Z",
"transaction_id": "tx_demo_20260326_0001",
"transaction_type": "p2p",
"transaction_status": "completed",
"currency": "TTD",
"amount": "25.00",
"institution_name": "ExampleInstitution",
"observed_client_ip": {
"request_ip": "172.64.80.1",
"socket_remote_address": "172.64.80.1"
}
}
400 - Wrapper-normalized response envelope (400)​
Example: error​
{
"status": "error",
"code": 400,
"message": "Missing required query params",
"request_id": "826f8895-f11e-4d6e-9cad-557d88bf43ee",
"timestamp": "2026-02-11T03:59:45.931Z",
"observed_client_ip": {
"request_ip": "172.64.80.1",
"socket_remote_address": "172.64.80.1"
},
"missing": [
"transaction_id"
]
}
Notes​
This endpoint page is generated from openapi/pw-wrappers.2024-10-01.yaml.