Booking | GetBalance
Retrieve the balance in shop’s account.
Notice:
Product Scope : TechHub, FareMarket
POST
/flight/booking
Parameter
Field | Mandatory | Type | Scope | Description |
---|---|---|---|---|
action | required |
String | GetBalance | |
key | required |
String | API security key applied from AeroHub | |
signature | required |
String | Refer to Guideline to generate. | |
timestamp | required |
Int | The ‘timestamp’ field should be a 10-digit Unix timestamp in seconds, used for encryption and data verification. | |
version | optional |
String | API version information, e.g. 3.2.0 | |
request | required |
Object | ||
timeout | optional |
String | Maximum response time setting, by seconds. e.g. 10 |
Request_Example:
{ "request": {}, "key": "3MIMwqeqQQDjZNaVQWd", "timestamp": "1685116516", "signature": "sBdG0b69wqeqAAAAsihpcGHnkTHsIaHTRwOJFc=", "version": "3.2.0", "action": "GetBalance" }
Response
Field | Type | Description |
---|---|---|
status | int | 0 for success, others for failure, please refer to status error appendix for detail |
msg | String | Return message, maximum 64 char |
contentStatus | int | Return the original code from airlines or suppliers. |
contentMsg | String | Return the original message from airlines or suppliers, maximum 64 char |
balanceList | Object[] | Account list |
accountType | int | Account type. 1: Client’s account in Aerohub, 2: Client’s account in airlines |
accountRef | String | For FareMarket, accountRef returns merchant code, i.e. AreoHub. For TechHub data, accountRef returns Carrier IATA 2_letter code. i.e. AK , VJ, Others |
agencyAccountID | String | Agency accountID. For TechHub, agencyAccountID is the registered agent account at the Airline. For FareMarket, agencyAccountID is indicated to a supplier |
currency | String | Currency information, 3_letter code e.g. USD |
balance | Float | Remain balance |
Success-Response:
{ "status": 0, "msg": "success", "contentResponse": [ { "accountType": "1", "detail":[ { "content": "AreoHub|XXXXX_USD", "status": "0", "msg": "success", }] }, { "accountType": "2", "detail":[ { "content": "AK|APICNLFLYH", "status": "0", "msg": "success", }, { "content": "AK|APICNLFLYH", "status": "0", "msg": "success", }] } ], "balanceList": [ { "accountType": "1", "accountRef": "AreoHub", "account": "Hopper_USD", "currency": "JPY", "balance": 930188.65 }, { "accountType": "2", "accountRef": "AK", "account": "APICNLFLYH", "currency": "JPY", "balance": 930188.65 } ] }
Status Code
Name | Description |
---|---|
1000 | General system error |
1001 | Request parameters or part of parameters missing |
1002 | Invalid Action |
1003 | API request timeout, please request again |
1004 | Invalid request parameter |
1005 | Service system error |
1006 | System busy, please try again |
1101 | Authentication fail, wrong signature |
1102 | Account disabled, please contact with account administrator |
Error-Response
{ "status": 1000, "msg": "Letslfy flight internal error" }
Author:admin Create time:2023-05-24 16:14
Last editor:AeroHub Update time:2024-09-10 16:26
Last editor:AeroHub Update time:2024-09-10 16:26