Agency Wallet Balance Query API
Modified on: 2026-10-13 10:54
TABLE OF CONTENTS
It is the endpoint responsible for querying wallet balances, wallet statuses, and account details for the authenticated Agency. The API supports querying a specific Agency Code or all Agency Codes owned by the authenticated Agency under a specified Supplier, with an optional currency filter.
| Version | Date | Description of Edit |
|---|---|---|
| V2.0 | 2026/07/28 | Initial Commit |
| Request Details | ||
|---|---|---|
| Path | v2.0 | /api/flight/connectivity/order/V2.0/walletBalance |
Request Payload Example
{
"agencyCode": "AG001",
"supplierName": "China Eastern Airlines",
"currency": "USD"
}
Request Payload Structure
| Key | Parent | Type | Mandatory/Optional | Description |
|---|---|---|---|---|
| agencyCode | root | String | O | Agency Code to query. One Agency may have multiple Agency Codes under one Supplier. If omitted, the API queries all Agency Codes owned by the authenticated Agency under the specified Supplier. |
| supplierName | root | String | M | Supplier Name. The value must identify a Supplier available to the agency. |
| currency | root | String | O | Three-letter currency code. If omitted, the API queries wallets in all currencies. |
Response
| Key | Parent | Type | Mandatory/Optional | Description |
|---|---|---|---|---|
| error | root | String | M | |
| walletBalanceResult | root | Array | M | |
| agencyCode | walletBalanceResult | String | M | |
| supplierName | walletBalanceResult | String | M | |
| wallets | walletBalanceResult | Array | M | Wallets matching the query. |
| currency | wallets | String | M | |
| status | wallets | String | M | Wallet status:ACTIVE or INACTIVE. |
| updatedTime | wallets | String | M | |
| accounts | wallets | Array | M | Accounts that have actually been created under the wallet. |
| accountType | accounts | String | M | |
| status | accounts | String | M | Account status:ACTIVE or INACTIVE. |
| balance | accounts | String | M | Current account balance |
| limitAmount | accounts | String / Null | M | The limit of credit account. The value is null for a Cash Account. |
| expirationTime | accounts | String / Null | M | Temporary Credit expiration time. Only for temp credit account. |
| updatedTime | accounts | String | M |
Did you find it helpful? Yes No
Send feedbackSorry we couldn't be helpful. Help us improve this article with your feedback.