API DOC for HERMEX
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"32500125","collectionId":"a4fe9749-07da-4b53-b50a-320914e6d38b","publishedId":"2sAYJ4j1om","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"publishDate":"2025-03-23T19:38:51.000Z"},"item":[{"name":"User Endpoints","item":[{"name":"Login/Register/Logout/Delete account","item":[{"name":"google-login","id":"28830ddc-e3cc-4c3d-a6d0-dd3067b88e8b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"http://127.0.0.1:5000/user/login/google","urlObject":{"protocol":"http","port":"5000","path":["user","login","google"],"host":["127","0","0","1"],"query":[],"variable":[]}},"response":[],"_postman_id":"28830ddc-e3cc-4c3d-a6d0-dd3067b88e8b"},{"name":"user/register","id":"47868ce9-d451-4db0-8dcc-067c46b1f988","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"username\": \"Rassy1\",\r\n \"password\": \"Password1234\",\r\n \"email\": \"boronicle@gmail.com\",\r\n \"first_name\": \"Praise\",\r\n \"last_name\": \"Ordu\",\r\n \"phone_number\": \"+1234567890\",\r\n \"country\": \"USA\",\r\n \"preferred_language\": \"English\",\r\n \"travel_preferences\": \"Beach, Adventure\",\r\n \"auth_provider\": \"local\"\r\n}\r\n","options":{"raw":{"language":"json"}}},"url":"{{baseUrl}}/user/register","description":"This endpoint allows users to register by submitting their user details via an HTTP POST request. The request should include the user's username, password, email, full name, phone number, country, preferred language, and travel preferences.
\nusername (string): The username of the user.
password (string): The password for the user account.
email (string): The email address of the user.
first_name (string): The first name of the user.
last_name (string): The last name of the user.
phone_number (string): The phone number of the user.
country (string): The country of the user.
preferred_language (string): The preferred language of the user.
travel_preferences (string): The travel preferences of the user.
The response to the request is a JSON object with a status code of 201 (Created) and a content type of application/json. The response includes a message field, which may contain a success message or any additional information related to the registration process.
\n{\n \"type\": \"object\",\n \"properties\": {\n \"message\": {\n \"type\": \"string\"\n }\n }\n}\n\nThis endpoint handles user authentication via multiple methods:
\nLocal authentication using a username/password or a 4-digit PIN (if configured).
\nOAuth 2.0 (Google/Apple) authentication (requires prior OAuth registration).
\nIf Multi-Factor Authentication (MFA) is enabled, a One-Time Password (OTP) is sent via email for verification.
\nPOST {{base_url}}/login
Type: None
\nSend a JSON object with the following fields:
\nExample Request Body (Local Auth):
\n{\n \"username\": \"john_doe\",\n \"password\": \"securePassword123\",\n \"auth_provider\": \"local\"\n}\n\nExample Request Body (OAuth):
\n{\n \"username\": \"jane_doe\",\n \"auth_provider\": \"google\"\n}\n\nDescription: OTP sent to the user's email.
Response:
{\n \"message\": \"OTP sent to your registered email. Validate OTP to complete login.\",\n \"access_token\": \"<temporary-jwt>\",\n \"refresh_token\": \"<refresh-jwt>\" // Only for local auth\n}\n\nDescription: Login successful with access/refresh tokens.
Response:
{\n \"message\": \"Login successful\",\n \"access_token\": \"<access-jwt>\",\n \"refresh_token\": \"<refresh-jwt>\",\n \"user\": {\n \"email\": \"john@example.com\",\n \"username\": \"john_doe\",\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"country\": \"US\",\n \"phone Number\": \"+1234567890\",\n \"profile_image\": \"https://example.com/profile.jpg\",\n \"role\": \"user\",\n \"id\": 123\n }\n}\n\nConditions:
\nusername or password (for local auth without pin).{\n \"error\": \"Missing required fields\"\n}\n\nConditions:
\nInvalid credentials (username/password/PIN).
\nUser exists but email is not verified.
Example Responses:
{\n \"error\": \"Invalid username or password\"\n}\n\n{\n \"error\": \"Invalid PIN\"\n}\n\n{\n \"error\": \"Invalid username or password, or email not verified\"\n}\n\n{\n \"error\": \"Failed to send OTP. Try again later.\"\n}\n\nLog entries are created in the audit_trail table for these actions:
This endpoint allows the user to log out and terminate their current session.
\nThis request does not require a request body.
\nUpon successful logout, the server will respond with a status code of 200 and a JSON object with a \"message\" key indicating the success of the logout operation.
\n","urlObject":{"path":["user","logout"],"host":["{{baseUrl}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"56721484-bf5c-488c-85a5-60d984207fb1"},{"name":"user/set-pin","id":"314fce7e-6cf9-4f77-9389-6a55873053ae","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"pin\": \"1739\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{baseUrl}}/user/set-pin","description":"This endpoint allows authenticated users to set or update their 4-digit PIN. The PIN is validated to ensure it contains exactly 4 numeric digits. An audit trail is recorded upon success.
\nPOST {{base_url}}/set-pin
Type: Bearer Token (JWT)
\nAuthorization: Bearer
\nAuthorization header.Send a JSON object with the following field:
\nExample Request Body:
\n{\n \"pin\": \"1234\"\n}\n\nDescription: PIN set successfully.
Example Response:
{\n \"message\": \"PIN set successfully\"\n}\n\nConditions:
\nMissing pin field.
pin is not exactly 4 digits.
pin contains non-numeric characters.
Example Response:
{\n \"error\": \"PIN must be exactly 4 digits and contain only numbers\"\n}\n\n{\n \"error\": \"Missing or invalid JWT\"\n}\n\n{\n \"error\": \"User not found\"\n}\n\n{\n \"error\": \"Internal server error\"\n}\n\nA log entry is created in the audit_trail table with the following details:
Action: \"PIN set successfully\"
\nPerformed By: User ID from JWT.
\nTarget Resource: \"PIN Details\".
\nDetails: Describes the action (e.g., \"User: 'john_doe' set their 4-digit PIN.\").
StartFragment
\n/check-userThis endpoint checks whether a given username and email are available for registration. Both inputs are converted to lowercase before checking to ensure the validation is case-insensitive.
\nGET
\nusername (string, required):
The desired username. It will be converted to lowercase before being checked.
email (string, required):
The desired email address. It will be converted to lowercase before being checked.
200 OK{ \n\"username_taken\": false, \n\"email_taken\": false, \n\"message\": \"Username and email are available.\"\n}\n\njsonCopyEdit
\nLogging:
An info log is recorded with the message:
Email and Username is available for use
400 Bad Request{ \n\"error\": \"Both username and email are required.\"\n}\n\nusername or email parameter is not provided.400 Bad Request{ \n\"error\": \"Username is already in use. Email is already in use.\"\n}\n\nDescription:
If the username or email (or both) is already associated with an existing user in the database, the endpoint returns an error message indicating which field is in use.
Logging:
\nIf the username is taken, an error log is recorded with:
Username chosen is already in use
If the email is taken, an error log is recorded with:
Email chosen is already in use
GET /check-user?username=TestUser&email=Test@Example.com\n\n{ \n\"username_taken\": false, \n\"email_taken\": false, \n\"message\": \"Username and email are available.\"\n}\n\n{ \n\"error\": \"Username is already in use.\"\n}\n\n{ \n\"error\": \"Email is already in use.\"\n}\n\n{ \n\"error\": \"Username is already in use. Email is already in use.\"\n}\n\nThe user logs in and receives an access token and a refresh token.
\nWhen the access token expires, the user sends a POST request to user/refresh/token with the refresh token in the Authorization header.
The user/refresh/token route verifies the refresh token and issues a new access token.
The user can continue using the application without re-entering credentials.
\nSend a POST request to user/refresh/token with the refresh token:
POST user/refresh/token\nAuthorization: Bearer <refresh_token>\n\n{\n \"access_token\": \"new_access_token_here\"\n}\n\nThis endpoint allows users to delete their account from the system. To successfully delete an account, the user must provide their account password for verification.
\nMethod: POST
\nURL: {{baseUrl}}/user/delete-account
Request Body:
\n{\n \"password\": \"your_password_here\"\n}\n\nStatus Code: 200 OK
\nContent-Type: application/json
\nResponse Body:
\n{\n \"message\": \"\"\n}\n\nEnsure that the password provided is correct, as it is required for the account deletion process.
\nThe response will not contain any error messages if the deletion is successful; however, it is important to handle any potential errors in your implementation.
\nEndpoints for login/register/logout user functions in hermex travels
\n","_postman_id":"3c9faca4-5a3f-4ced-81db-38993b80b27e"},{"name":"mfa","item":[{"name":"user/validate_otp","id":"73e6cf52-f17e-40d2-9556-1672e16a0606","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{vault:authorization-secret}}"}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"otp\": \"218759\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{baseUrl}}/user/validate_otp","description":"POST /validate_otp
This endpoint validates the One-Time Password (OTP) provided by the user for Multi-Factor Authentication (MFA) before completing the login process.
\nEnsure the request includes the following headers:
\nThe request body must include the following field in JSON format:
\n{\n \"otp\": \"123456\"\n}\n\nStatus Code: 200 OK
Response Body:
{\n \"message\": \"OTP validated and you are logged In Successfully\",\n \"access_token\": \"ACCESS_TOKEN_HERE\",\n \"refresh_token\": \"REFRESH_TOKEN_HERE\",\n \"user\": {\n \"email\": \"johndoe@example.com\",\n \"username\": \"johndoe\",\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"profile_image\": \"https://example.com/images/johndoe.jpg\",\n \"country\": \"USA\",\n \"phone Number\": \"+1234567890\",\n \"role\": \"user\"\n }\n}\n\nStatus Code: 400 Bad Request
Response Body:
{\n \"error\": \"OTP is required\"\n}\n\nStatus Code: 404 Not Found
Response Body:
{\n \"error\": \"User not found\"\n}\n\nStatus Code: 400 Bad Request
Response Body:
{\n \"error\": \"MFA is not enabled for this user\"\n}\n\nStatus Code: 400 Bad Request
Response Body:
{\n \"error\": \"Invalid OTP\"\n}\n\nStatus Code: 400 Bad Request
Response Body:
{\n \"error\": \"OTP has expired\"\n}\n\nRequest OTP Validation:
\naccess_token).Verify OTP:
\nCheck if the OTP is correct and not expired.
\nIf the OTP is valid, issue new access_token and refresh_token.
Clear OTP:
\nPOST /disable_mfa
This endpoint allows users to disable Multi-Factor Authentication (MFA) on their account.
\nEnsure the request includes the following headers:
\nThis endpoint does not require a request body.
\nStatus Code: 200 OK
Response Body:
{\n \"message\": \"MFA disabled successfully\"\n}\n\nStatus Code: 404 Not Found
Response Body:
{\n \"error\": \"User not found\"\n}\n\nJWT Authentication:
\naccess_token.Find User:
\nusername extracted from the JWT.Disable MFA:
\nmfa_enabled flag for the user to False.Commit Changes:
\nPOST /enable_mfa
This endpoint allows users to enable Multi-Factor Authentication (MFA) on their account for enhanced security.
\nEnsure the request includes the following headers:
\nThis endpoint does not require a request body.
\nStatus Code: 200 OK
Response Body:
{\n \"message\": \"MFA enabled successfully\"\n}\n\nStatus Code: 404 Not Found
Response Body:
{\n \"error\": \"User not found\"\n}\n\nJWT Authentication:
\naccess_token.Find User:
\nusername extracted from the JWT.Enable MFA:
\nmfa_enabled flag for the user to True.Commit Changes:
\nPOST /resend_otp
This endpoint allows users to request a new OTP (One-Time Password) for Multi-Factor Authentication (MFA).
\nEnsure the request includes the following headers:
\nThis endpoint is rate-limited to 1 request per minute per user.
If the rate limit is exceeded, a 429 Too Many Requests error is returned.
Status Code: 429 Too Many Requests
Response Body:
{\n \"error\": \"Rate limit exceeded\",\n \"message\": \"You have made too many requests. Please wait and try again after a minute.\",\n \"details\": \"Default error details for rate limit exceedance\"\n}\n\nStatus Code: 200 OK
Response Body:
{\n \"message\": \"OTP has been resent successfully. Please check your email.\"\n}\n\nStatus Code: 404 Not Found
Response Body:
{\n \"error\": \"User not found\"\n}\n\nStatus Code: 400 Bad Request
Response Body:
{\n \"error\": \"MFA is not enabled for this user\"\n}\n\nStatus Code: 500 Internal Server Error
Response Body:
{\n \"error\": \"Failed to send OTP. Please try again later.\"\n}\n\nStatus Code: 500 Internal Server Error
Response Body:
{\n \"error\": \"An unexpected error occurred. Please try again later.\"\n}\n\nJWT Authentication:
\nValidate User:
\nRetrieve the user based on the username from the JWT.
Return an error if the user does not exist.
\nCheck MFA Status:
\nSend OTP:
\nUse the send_otp_email function to resend the OTP.
Return a success message if the OTP is sent successfully.
\nError Handling:
\nHandle rate limit violations with a custom error response.
\nHandle other unexpected server errors gracefully.
\nGET /mfa_status
This endpoint allows users to check if Multi-Factor Authentication (MFA) is enabled on their account.
\nEnsure the request includes the following headers:
\nThis endpoint does not require a request body.
\nStatus Code: 200 OK
Response Body:
{\n \"mfa_enabled\": true\n}\n\nmfa_enabled field will be true if MFA is enabled and false otherwise.Status Code: 404 Not Found
Response Body:
{\n \"error\": \"User not found\"\n}\n\nJWT Authentication:
\naccess_token.Find User:
\nusername extracted from the JWT.Check MFA Status:
\nmfa_enabled) for the user.Endpoints for user MFA functions in hermex travels
\n","_postman_id":"cf4c2d26-6acb-49f5-a7d0-a6c2fc193040"},{"name":"profile","item":[{"name":"user/profile","event":[{"listen":"test","script":{"id":"687d9370-7d59-4cca-921c-7819e7efdca6","exec":[""],"type":"text/javascript","packages":{}}}],"id":"afa0a443-732d-41da-b7c1-cfe57301353d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{vault:authorization-secret}}"}]},"isInherited":false},"method":"GET","header":[],"url":"{{baseUrl}}/user/profile","description":"This endpoint is used to retrieve the profile information of a user.
\nThis is a GET request and does not require a request body.
\nThe response will be a JSON object with the following properties:
\ncountry (string): The country of the user.
email (string): The email address of the user.
email_verification_status (boolean): The verification status of the user's email.
first_name (string): The first name of the user.
last_name (string): The last name of the user.
phone_number (string): The phone number of the user.
points_balance (number): The points balance of the user.
preferred_language (string): The preferred language of the user.
profile_image (image): The profile image of the user.
role (string): The role of the user.
travel_preferences (string): The travel preferences of the user.
username (string): The username of the user.
wallet_address (string): The wallet address of the user.
wallet_qr_code (string): The wallet QR code of the user.
{\n \"country\": \"\",\n \"email\": \"\",\n \"email_verification_status\": true,\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"phone_number\": \"\",\n \"points_balance\": 0,\n \"preferred_language\": \"\",\n \"profile_image\":\"\",\n \"role\": \"\",\n \"travel_preferences\": \"\",\n \"username\": \"\",\n \"wallet_address\": \"\",\n \"wallet_qr_code\": \"\"\n}\n\n{\n \"type\": \"object\",\n \"properties\": {\n \"country\": {\"type\": \"string\"},\n \"email\": {\"type\": \"string\"},\n \"email_verification_status\": {\"type\": \"boolean\"},\n \"first_name\": {\"type\": \"string\"},\n \"last_name\": {\"type\": \"string\"},\n \"phone_number\": {\"type\": \"string\"},\n \"points_balance\": {\"type\": \"number\"},\n \"preferred_language\": {\"type\": \"string\"},\n \"profile_image\": {\"type\": \"ïmage\"},\n \"role\": {\"type\": \"string\"},\n \"travel_preferences\": {\"type\": \"string\"},\n \"username\": {\"type\": \"string\"},\n \"wallet_address\": {\"type\": \"string\"},\n \"wallet_qr_code\": {\"type\": \"string\"}\n }\n}\n\nThis endpoint allows the user to update their profile information via an HTTP PUT request. The request should include the user's email, password, full name, phone number, country, preferred language, travel preferences, and profile image.
\nemail : The user's email.
password : The user's password.
first_name : The user's full name.
last_name : The user's full name.
phone_number : The user's phone number.
country The user's country.
preferred_language : The user's preferred language.
travel_preferences : The user's travel preferences.
profile_image (base64encodedstring): The user's profile image.
The response to the request will be a JSON object with a status code of 200 and a content type of application/json. The response will contain a message indicating the result of the update operation.
\n{\n \"type\": \"object\",\n \"properties\": {\n \"message\": {\n \"type\": \"string\"\n }\n }\n}\n\nprofile image
\n","type":"file","src":"/C:/Users/StarmannRassy/Pictures/3D GLASS best Transparent Wallpapers [ MyShare ]/2009_nissan_qazana_concept_2-wallpaper-1920x1080.jpg"}]},"url":"{{baseUrl}}/user/profile/image","description":"POST /profile/image
This endpoint allows users to upload or update their profile picture.
\nEnsure the request includes the following headers:
\nThe request body must include the file upload for the profile image.
\npng
jpg
jpeg
gif
Status Code: 200 OK
Response Body:
{\n \"message\": \"New Profile image uploaded successfully\",\n \"profile_image\": \"path/to/uploaded/profile_image.jpg\"\n}\n\nStatus Code: 404 Not Found
Response Body:
{\n \"error\": \"User not found\"\n}\n\nStatus Code: 400 Bad Request
Response Body:
{\n \"error\": \"No profile image uploaded\"\n}\n\nStatus Code: 400 Bad Request
Response Body:
{\n \"error\": \"Invalid file type. Allowed: png, jpg, jpeg, gif\"\n}\n\nStatus Code: 500 Internal Server Error
Response Body:
{\n \"error\": \"Failed to upload profile image\"\n}\n\nJWT Authentication:
\naccess_token.Validate User:
\nRetrieve the user based on the username extracted from the JWT.
If the user does not exist, return a 404 error.
Validate File:
\nEnsure the request contains a profile_image file.
Check the file type against the allowed extensions (png, jpg, jpeg, gif).
Upload Image:
\nSave the image to the server's upload directory (UPLOAD_FOLDER).
If a previous profile image exists, delete it from the server.
\nUpdate the user's profile image path in the database.
\nError Handling:
\nThis endpoint is used to update the password for a user.
\nold_password (string) : The old password of the user.
\nnew_password (string) : The new password for the user.
\nconfirm_password (string) : Confirmation of the new password.
\nThe response for this request is a JSON object with the following schema:
\n{\n \"type\": \"object\",\n \"properties\": {\n \"message\": {\n \"type\": \"string\"\n }\n }\n}\n\nEndpoints for users profile functions in hermex travels
\n","_postman_id":"89e11493-1292-456c-8d2b-c1830d93c648"},{"name":"wallet","item":[{"name":"user/wallet/balance","id":"eade2a48-2397-488f-a81d-3a2097aab072","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{vault:authorization-secret}}"}]},"isInherited":false},"method":"GET","header":[],"url":"{{baseUrl}}/user/wallet/balance","description":"This endpoint is used to retrieve the wallet balance for the user.
\nMethod: GET
\nURL: {{baseUrl}}/user/wallet/balance
\nStatus: 200 OK
\nContent-Type: application/json
\n{\n \"HMEX balance\": 0,\n \"SOL balance\": 0\n}\n\nThis endpoint retrieves the transactions related to the user's wallet.
\nThis is a GET request to the {{baseUrl}}/user/wallet/transactions endpoint.
Upon a successful execution, the API returns a status code of 200 and a JSON object in the response body. The response contains an array of transactions, with each transaction object including the following properties:
action (string): Indicates the action related to the transaction.
change_amount (number): Represents the amount of change in the wallet balance.
from (string): Specifies the sender of the transaction.
signature (string): Represents the signature of the transaction.
time (number): Indicates the timestamp of the transaction.
to (string): Specifies the recipient of the transaction.
token (string): Represents the token associated with the transaction.
This endpoint allows the user to send tokens to another wallet.
\ndest_addr (string): The destination address to which the tokens will be sent.
tkn_amt (number): The amount of tokens to be sent.
send_max (boolean): Indicates whether to send the maximum available tokens.
show_details_yn (string): Indicates whether to show transaction details.
Upon successful execution, the API returns a JSON response with the following fields:
\nsolana_fm_url (string): The Solana transaction URL.
transaction_details (array): An array containing transaction details such as action, source, status, and timestamp.
txn_hash (string): The transaction hash for the sent tokens.
Endpoints for user crypto wallet functions in hermex travels
\n","_postman_id":"1107c703-3d3d-406a-85e8-a155dbf6c69a"},{"name":"Feedback/Trip-form","item":[{"name":"user/submit_feedback","id":"9ab5b2b9-ee30-4d24-aa5c-ca50b4192585","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{vault:authorization-secret}}"}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"content\": \"This is a sample feedback message.\"\r\n}\r\n","options":{"raw":{"language":"json"}}},"url":"https://praiseordu.pythonanywhere.com/user/submit_feedback","description":"This endpoint allows users to submit feedback by making an HTTP POST request to the specified URL.
\ncontent (string, required): The content of the feedback.Upon successful submission, the API returns a status code of 201 and a JSON response with a message indicating the success of the operation.
\nExample response:
\n{\n \"message\": \"Feedback submitted successfully\"\n}\n\nThe endpoint https://praiseordu.pythonanywhere.com/user/submit_trip_form is a POST request that allows users to submit a trip form. The request includes parameters such as name, email, destination, activity, date, and duration in the form-data request body type.
Endpoints for user Feedback // Trip-form functions in hermex travels
\n","_postman_id":"16d2aef8-027c-4e60-9f3a-5dad7e8f9d3f"},{"name":"Others","item":[{"name":"user/list_users","id":"1d3672b5-c2e0-4dea-9c4f-dc72c83af59c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{vault:authorization-secret}}"}]},"isInherited":false},"method":"GET","header":[],"url":"{{baseUrl}}/user/list_users","description":"The list_users endpoint retrieves a list of users.
The response is in JSON format and has the following schema:
\n{\n \"type\": \"object\",\n \"properties\": {\n \"users\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"string\"\n }\n }\n }\n}\n\nEndpoints for user OTHER functions in hermex travels
\n","_postman_id":"de15a18a-5dab-4c02-8137-f3edf23459d0"},{"name":"Email verification","item":[{"name":"resend_email_verification","id":"f67d73a2-091e-4b90-8c31-300bcc75cfd3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"{{baseUrl}}/user/resend_verification_email","urlObject":{"path":["user","resend_verification_email"],"host":["{{baseUrl}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"f67d73a2-091e-4b90-8c31-300bcc75cfd3"}],"id":"92a99b6b-091e-49b7-9790-42898a3a501a","_postman_id":"92a99b6b-091e-49b7-9790-42898a3a501a","description":""},{"name":"Points","item":[{"name":"user/add_points","id":"dca40a96-38ea-4261-ae60-ae72333eff83","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{vault:authorization-secret}}"}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"points_earned\": 21\r\n}","options":{"raw":{"language":"json"}}},"url":"{{baseUrl}}/user/add_points","urlObject":{"path":["user","add_points"],"host":["{{baseUrl}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"dca40a96-38ea-4261-ae60-ae72333eff83"},{"name":"user/redeem_points","id":"54fba188-1acd-4021-b560-245bfedf221a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"","urlObject":{"query":[],"variable":[]}},"response":[],"_postman_id":"54fba188-1acd-4021-b560-245bfedf221a"}],"id":"0e6d4dfe-723f-436c-8892-14b6c74adea3","_postman_id":"0e6d4dfe-723f-436c-8892-14b6c74adea3","description":""},{"name":"Pin","item":[{"name":"user/create-pin","id":"ba4212f1-3677-4bec-9159-ea20a92994f6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{vault:authorization-secret}}"}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"pin\": \"2468\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{baseUrl}}/user/create-pin","description":"/user/create-pinSets a 4-digit PIN for an authenticated user. This PIN is hashed and securely stored in the database.
\n✅ Requires JWT access token in the Authorization header.
{\n \"pin\": \"1234\"\n}\n\nPIN must be exactly 4 digits.
\nPIN must contain only numbers (0-9).
PIN is securely stored as a hashed value (not plain text).
\nHTTP 200 OK
\n{\n \"message\": \"PIN set successfully\"\n}\n\nHTTP 400 Bad Request
\n{\n \"error\": \"PIN must be exactly 4 digits and contain only numbers\"\n}\n\nHTTP 404 Not Found
\n{\n \"error\": \"User not found\"\n}\n\nLogs an entry in the AuditTrail table with:
Action: PIN set successfully
Resource: PIN Details
Performed by: Authenticated user ID
\nTimestamp and details of the action
\nbashCopyEditcurl -X POST http://localhost:5000/create-pin \\\n -H \"Authorization: Bearer <your_token>\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\"pin\": \"1234\"}'\n\n/user/input-pinValidates a user’s 4-digit PIN. Implements attempt limiting and lockout logic to prevent brute-force attacks.
\n✅ Requires JWT access token in the Authorization header.
{\n \"pin\": \"1234\"\n}\n\nValidates the PIN format (must be 4 digits).
\nChecks the hashed PIN against the stored value.
\nTracks failed attempts:
\nLocks user out after MAX_PIN_ATTEMPTS.
Lockout duration is enforced (LOCKOUT_TIME).
Resets attempt count on success.
\nHTTP 200 OK
\n{\n \"message\": \"PIN validated successfully\"\n}\n\nHTTP 400 Bad Request
\n{\n \"error\": \"PIN must be exactly 4 digits.\"\n}\n\nHTTP 404 Not Found
\n{\n \"error\": \"User not found\"\n}\n\nHTTP 403 Forbidden
\n{\n \"error\": \"Too many attempts. Try again in a few minutes.\"\n}\n\nHTTP 401 Unauthorized
\n{\n \"error\": \"Invalid PIN. Attempts left: 2\"\n}\n\n/user/change-pinAllows a user to securely reset their PIN by providing the correct old PIN and a valid new 4-digit PIN. Includes lockout protection after multiple failed attempts.
\n✅ Requires JWT access token in the Authorization header.
{\n \"old_pin\": \"1234\",\n \"new_pin\": \"5678\"\n}\n\nValidates the format of both old and new PINs.
\nVerifies the old PIN matches the stored hashed PIN.
\nChecks for lockout if too many failed attempts have occurred.
\nResets failed attempt count and updates PIN on success.
\nEnforces retry wait time after lockout (LOCKOUT_TIME).
HTTP 200 OK
\n{\n \"message\": \"PIN reset successfully\"\n}\n\nHTTP 400 Bad Request
\n{\n \"error\": \"Old PIN must be exactly 4 digits\"\n}\n\nHTTP 404 Not Found
\n{\n \"error\": \"User not found\"\n}\n\nHTTP 403 Forbidden
\n{\n \"error\": \"Too many attempts. Try again in a few minutes.\"\n}\n\nHTTP 401 Unauthorized
\n{\n \"error\": \"Incorrect old PIN. Attempts left: 2\"\n}\n\nGET /check-pinDescription:
\nCheck if the currently authenticated user has already set up a 4-digit PIN.
\nRequires JWT authentication (@jwt_required()).
Must include a valid Authorization header with a Bearer token.
Example Header:
\nAuthorization: Bearer <your_token_here>\n\nMethod: GET
URL: /check-pin
Body: None (no request body needed).
\n{\n \"pin_set\": true,\n \"message\": \"PIN has been set\"\n}\n\nHTTP Status Code: 200 OK
{\n \"pin_set\": false,\n \"message\": \"PIN has not been set\"\n}\n\nHTTP Status Code: 200 OK
{\n \"error\": \"User not found\"\n}\n\nHTTP Status Code: 404 Not Found
This endpoint does not return the actual PIN (for security reasons).
\nIt only checks if a PIN exists for the user account.
\nIf the user is not authenticated or token is invalid/expired, a 401 Unauthorized response will be returned automatically.
Request PIN Reset OTPPOST /request-pin-reset\n\nRequires a valid JWT access token.
\nmakefileCopyEditAuthorization: Bearer
\nThis endpoint allows an authenticated user to request a One-Time Password (OTP) for PIN reset.
\nThe OTP is securely generated, hashed, and stored in the database along with an expiration timestamp.
\nA reset email containing the plain OTP is sent to the user’s registered email address.
\nHeaders:
\nBody:
\nExtract the current user's username from the JWT token.
\nFind the corresponding user record in the database.
\nIf the user is not found, return a 404 Not Found error.
Generate a secure 6-digit OTP.
\nHash the OTP using the Scrypt hashing algorithm with:
\nRandomly generated salt
\nParameters: n=16384, r=8, p=1, dklen=64
Store the hashed OTP and salt (in hex format) in the user's database record.
\nSet the OTP expiration time to 10 minutes from now.
\nSend an email to the user containing the OTP using send_brevo_email.
If email sending fails, rollback the database changes.
\nReturn a 200 OK response if successful.
Status Code: 200 OK
Example Response:
\n{\n \"message\": \"PIN Reset OTP sent to your registered email\"\n}\n\nOTP is hashed using a strong algorithm (Scrypt) to prevent brute-force attacks.
\nSalt is random per OTP, preventing rainbow table attacks.
\nOTP expires after 10 minutes, ensuring temporary validity.
\nPlain OTP is sent only via email, and never stored in plain text.
\nReset PIN with OTPPOST /reset-pin-with-otp\n\nRequires a valid JWT access token.
\nmakefileCopyEditAuthorization: Bearer
\nThis endpoint allows an authenticated user to reset their PIN by submitting a previously generated OTP (received via email).
\nThe submitted OTP is securely verified against the stored hashed OTP, and upon success, the user's PIN is updated.
\nHeaders:
\nBody Parameters:
\nExample Request Body:
\n{\n \"new_pin\": \"1234\",\n \"otp\": \"654321\"\n}\n\nValidate input:
\nEnsure new_pin is provided and is exactly 4 digits.
Ensure otp is provided.
Retrieve the current user from the JWT token.
\nCheck for user existence:
\n404 Not Found.Check for active OTP:
\nVerify the submitted OTP:
\nExtract salt and hashed OTP from stored user data.
\nRe-hash the submitted OTP using the same salt and Scrypt parameters.
\nCompare the hashes securely.
\nHandle OTP verification:
\nIf OTP is invalid, return a 400 Bad Request.
If an error occurs during verification, return 500 Internal Server Error.
On successful OTP verification:
\nUpdate the user's PIN securely (hashed).
\nReset the OTP fields (otp, otp_expires_at) to None.
Reset PIN attempt counters (pin_attempts, locked_until).
Audit the action:
\nAuditTrail table recording the PIN reset.Commit all changes to the database.
\nReturn a 200 OK response indicating successful PIN reset.
Status Code: 200 OK
Example Response:
\n{\n \"message\": \"Your PIN has been reset successfully\"\n}\n\nNew PIN is securely hashed using a password hashing function (generate_password_hash) before storage.
OTP verification is done with the originally used salt and Scrypt settings.
\nExpired OTPs are properly rejected.
\nAudit trail logs the reset action for traceability and security monitoring.
\nOTP is deleted after use to prevent replay attacks.
\nPOST /user/newsletter/subscribe
This endpoint allows users to subscribe to the newsletter by providing a valid email address. It checks if the user is already subscribed and prevents duplicate subscriptions.
\n{\n \"email\": \"user@example.com\"\n}\n\nUser is successfully subscribed to the newsletter.
\nResponse Body:
\n{\n \"message\": \"You have subscribed to our newsletters successfully\"\n}\n\nThe email field was not provided or is empty.
Response Body:
\n{\n \"message\": \"Email is required\"\n}\n\nThe email is already subscribed to the newsletter.
\nResponse Body:
\n{\n \"message\": \"You are already subscribed to our newsletters\"\n}\n\nThe endpoint first checks if the email field is present in the request body.
\nIf the email is missing, it returns a 400 error.
\nIt then checks the database for an existing subscriber with the same email.
\nIf found, a 409 conflict is returned to avoid duplicate entries.
\nIf not, a new Subscriber record is created and stored in the database.
Upon success, a 201 response is returned with a confirmation message.
\nPOST /user/newsletter/unsubscribe
This endpoint allows users to unsubscribe from the newsletter by providing their email address. It ensures the email exists in the subscriber list before processing the unsubscription.
\n{\n \"email\": \"user@example.com\"\n}\n\nThe user has been successfully unsubscribed.
\nResponse Body:
\n{\n \"message\": \"You have been unsubscribed from our newsletters successfully\"\n}\n\nThe request does not include the email field.
Response Body:
\n{\n \"message\": \"Email is required\"\n}\n\nThe email provided is not in the subscriber list.
\nResponse Body:
\n{\n \"message\": \"Email not found in our subscriber list\"\n}\n\nThe endpoint validates if the email is present in the request body.
If not provided, it returns a 400 response.
The system then searches for a subscriber with that email.
\nIf the subscriber is not found, it returns a 404 response.
If found, the subscriber is deleted from the database and a success message is returned with 200 OK.
StartFragment
\nThis API endpoint handles virtual wallet deposits by processing payment requests, validating currencies, and initializing payments through supported payment gateways (Paystack for NGN, Flutterwave for USD/GHS).
\nPOST /api/v2/user/virtualwallet/deposit
Required: JWT (JSON Web Token)
\nMethod: Bearer Token in Authorization header
\nExample: Authorization: Bearer
http
\nContent-Type: application/json\nAuthorization: Bearer <jwt_token>\n\njson
\n{\n \"amount\": 1000.50,\n \"currency\": \"NGN\"\n}\n\njson
\n{\n \"status\": true,\n \"message\": \"Authorization URL created\",\n \"data\": {\n \"authorization_url\": \"https://checkout.paystack.com/...\",\n \"access_code\": \"xxxxxx\",\n \"reference\": \"txn_ref_123\"\n }\n}\n\njson
\n{\n \"error\": \"Invalid amount\"\n}\n\nOR
\njson
\n{\n \"status\": \"error\",\n \"success\": false,\n \"message\": \"Wallet funding currency mismatch\",\n \"code\": \"400 --> BAD REQUEST\",\n \"wallet_currency\": \"NGN\",\n \"payment_currency\": \"USD\",\n \"meta\": {\n \"timestamp\": \"2024-01-01T12:00:00Z\",\n \"user_message\": \"This wallet is denominated in NGN. You can only fund it using NGN not USD. Please try again with the correct currency.\"\n }\n}\n\njson
\n{\n \"error\": \"User not found\"\n}\n\njson
\n{\n \"error\": \"Duplicate transaction\"\n}\n\njson
\n{\n \"error\": \"Payment initialization failed\"\n}\n\nValidates request JSON format
\nEnsures amount is valid decimal > 0
\nChecks if currency is supported (NGN, USD, GHS)
\nExtracts username from JWT token
\nRetrieves user from database
\nReturns 404 if user not found
\nRetrieves user's virtual wallet
\nCreates new wallet with NGN default if none exists
\nCritical: Enforces currency matching between payment currency and wallet currency
\nGenerates unique transaction reference
\nCreates idempotency key to prevent duplicate transactions
\nCreates two transaction records:
\nWalletTransaction: Tracks wallet credit intent
PaymentTransaction: Tracks payment processing
Both transactions start in \"pending\" status
\nPaystack: Used for NGN transactions
\nFlutterwave: Used for USD and GHS transactions
\nDetects if request is from mobile or web
\nAdjusts callback URLs accordingly
\njson
\n{\n \"email\": \"user@example.com\",\n \"amount\": 100050, // Amount in kobo (×100)\n \"currency\": \"NGN\",\n \"reference\": \"txn_ref_123\",\n \"callback_url\": \"https://your-domain.com/callback/paystack/...\"\n}\n\njson
\n{\n \"tx_ref\": \"txn_ref_123\",\n \"amount\": \"1000.50\",\n \"currency\": \"USD\",\n \"redirect_url\": \"https://your-domain.com/callback/flutterwave/...\",\n \"customer\": {\n \"email\": \"user@example.com\",\n \"phonenumber\": \"+1234567890\",\n \"name\": \"John Doe\"\n }\n}\n\nIf gateway request fails (non-200 response):
\nUpdates both transactions to \"failed\" status
\nLogs error with full exception details
\nReturns 502 Gateway Error
\nImportant: Users can only fund wallets with the same currency as the wallet denomination.
\nUses idempotency_key to prevent duplicate transactions
Key format: wallet_deposit:{user_id}:{currency}:{timestamp}
Returns 409 Conflict if duplicate detected
\ntext
\nhttps://your-domain.com/api/wallet/callback/paystack?reference=txn_ref_123&platform=web&provider=paystack\n\ntext
\nhttps://your-domain.com/api/wallet/callback/flutterwave?reference=txn_ref_123&platform=mobile&provider=flutterwave\n\nLogs payment initialization attempts
\nLogs gateway selection (Paystack/Flutterwave)
\nLogs errors with full stack trace
\nUses routes_logger for all payment-related logging
virtual_wallets
\nCreated if user doesn't have one
\nBalance updated after successful payment verification (not in this endpoint)
\nwallet_transactions
\nNew record with type \"credit\"
\nStatus: \"pending\" → \"completed\"/\"failed\"
\npayment_transactions
\nNew record with payment details
\nLinks to wallet transaction via reference
\nPCI Compliance: Transaction intent is persisted before contacting payment gateway
\nInput Validation: All inputs validated and sanitized
\nJWT Authentication: Required for all requests
\nCurrency Enforcement: Strict currency matching prevents conversion issues
\nIdempotency: Prevents duplicate charges
\nbash
\ncurl -X POST https://api.your-domain.com/api/virtual-wallet/deposit \\\n -H \"Content-Type: application/json\" \\\n -H \"Authorization: Bearer YOUR_JWT_TOKEN\" \\\n -d '{\n \"amount\": 5000.00,\n \"currency\": \"NGN\"\n }'\n\npython
\nimport requests\nheaders = {\n \"Authorization\": \"Bearer YOUR_JWT_TOKEN\",\n \"Content-Type\": \"application/json\"\n}\ndata = {\n \"amount\": 100.00,\n \"currency\": \"USD\"\n}\nresponse = requests.post(\n \"https://api.your-domain.com/api/virtual-wallet/deposit\",\n headers=headers,\n json=data\n)\nprint(response.json())\n\nThe actual wallet balance is NOT updated in this endpoint
\nBalance updates occur in separate callback endpoints after payment verification
\nAmounts are stored as Decimal with 2 decimal places precision
\nMobile detection affects callback URL construction but not business logic
\nAll timestamps are in UTC
\nStartFragment
\nThis API handles debiting user virtual wallets for booking payments (flights, hotels, etc.). It reserves funds, processes currency conversions, applies markup, and integrates with payment providers (Flutterwave/Paystack) for fund transfers.
\nPOST /api/v2/user/virtualwallet/debitDebits a user's virtual wallet for booking payments.
\nRequired: JWT (JSON Web Token)
\nMethod: Bearer Token in Authorization header
\nExample: Authorization: Bearer
http
\nContent-Type: application/json\nAuthorization: Bearer <jwt_token>\n\njson
\n{\n \"amount\": 500.00,\n \"request_currency\": \"NGN\",\n \"reason\": \"Flight booking payment\",\n \"booking_id\": \"BOOK_123456\"\n}\n\njson
\n{\n \"status\": \"success\",\n \"success\": true,\n \"code\": \"200 --> OK\",\n \"message\": \"Wallet debited successfully for FLIGHT booking\",\n \"data\": {\n \"debited_amount\": \"500.00\",\n \"wallet_currency\": \"NGN\",\n \"reference\": \"TXN_REF_789\",\n \"new_balance\": \"2500.00\",\n \"booking_details\": {\n \"order_id\": \"ORDER_ABC123\",\n \"type\": \"flight\"\n }\n },\n \"meta\": {\n \"timestamp\": \"2024-01-01T12:00:00Z\"\n }\n}\n\njson
\n{\n \"status\": \"success\",\n \"success\": true,\n \"code\": \"200 --> OK\",\n \"message\": \"Intraverse transfer money sent successfully\",\n \"data\": {\n \"reference\": \"TXN_REF_789\",\n \"external provider\": \"flutterwave\",\n \"booking_orderID\": \"ORDER_ABC123\"\n },\n \"meta\": {\n \"timestamp\": \"2024-01-01T12:00:00Z\"\n }\n}\n\njson
\n{\n \"status\": \"success\",\n \"success\": true,\n \"code\": \"200 --> OK\",\n \"message\": \"Transaction already processed\",\n \"data\": {\n \"amount\": \"500.00\",\n \"currency\": \"NGN\",\n \"reference\": \"TXN_REF_789\",\n \"status\": \"success\"\n },\n \"meta\": {\n \"timestamp\": \"2024-01-01T12:00:00Z\"\n }\n}\n\njson
\n{\n \"status\": \"error\",\n \"success\": false,\n \"code\": \"400 --> BAD REQUEST\",\n \"message\": \"amount is required\",\n \"meta\": {\n \"timestamp\": \"2024-01-01T12:00:00Z\"\n }\n}\n\njson
\n{\n \"status\": \"error\",\n \"success\": false,\n \"code\": \"400 --> BAD REQUEST\",\n \"message\": \"Insufficient wallet balance\",\n \"data\": {\n \"balance\": \"1000.00\",\n \"amount_required\": \"1500.00\",\n \"currency\": \"NGN\"\n },\n \"meta\": {\n \"timestamp\": \"2024-01-01T12:00:00Z\"\n }\n}\n\njson
\n{\n \"status\": \"error\",\n \"success\": false,\n \"code\": \"404 --> NOT FOUND\",\n \"message\": \"Wallet not found\",\n \"meta\": {\n \"timestamp\": \"2024-01-01T12:00:00Z\"\n }\n}\n\njson
\n{\n \"status\": \"error\",\n \"success\": false,\n \"code\": \"500 --> INTERNAL SERVER ERROR\",\n \"message\": \"Wallet debit failed\",\n \"details\": \"Transfer to Flutterwave failed\"\n}\n\nValidates amount is present and positive
Converts amount to Decimal with 2 decimal places using to_money()
Validates request_currency is supported (NGN, USD, GHS)
Validates booking_id is provided and exists
Extracts username from JWT
\nRetrieves user and their virtual wallet
\nReturns 404 if no wallet exists
\nGenerates idempotency key: wallet_debit:{booking_type}:{booking_id}:{timestamp}
Prevents duplicate processing of same booking
\nReturns existing transaction data if duplicate detected
\nConverts request_currency to wallet_currency if different
Uses convert_currency() function for accurate conversion
Rounds to 2 decimal places using ROUND_HALF_UP
Calculates available balance: balance - reserved_balance
Returns 400 if insufficient funds
\nImportant: Uses Decimal for precise calculations
Increases reserved_balance by debit amount
Creates WalletTransaction with status \"pending\"
Generates unique transaction reference
\nApplies 3% markup: debit_amount \\\\* 0.03
Calculates actual transfer amount: debit_amount - markup
Marks up amount is stored in payment transaction
\nNGN Wallets: Uses Paystack for transfers
\nUSD/GHS Wallets: Uses Flutterwave for transfers
\nTransfers funds to external provider account
\nTransaction status becomes \"processing\"
\nExternal provider handles actual payout
\nDirect Debit: Immediately reduces wallet balance
\nUpdates booking status to \"PROCESSING\"
\nMarks booking source as \"INTERNAL WALLET DEBITING\"
\nTransaction becomes \"success\" immediately
\nSimilar to hotel bookings (direct debit)
\nWallet balance immediately reduced
\nFor non-flight bookings: Finalizes debit immediately
\nFor flight bookings: Defers to callback/webhook for final status
\nUpdates wallet balance and reduces reserved balance
\nOn any exception: Rolls back database changes
\nReleases reserved balance
\nUpdates transaction status to \"failed\"
\nReturns 500 with error details
\nPayload Structure:
\njson
\n{\n \"account_bank\": \"BANK_CODE\",\n \"account_number\": \"ACCOUNT_NUMBER\",\n \"amount\": \"450.00\",\n \"currency\": \"USD\",\n \"reference\": \"TXN_REF_789\",\n \"beneficiary_name\": \"BENEFICIARY_NAME\",\n \"debit_currency\": \"USD\",\n \"callback_url\": \"https://your-domain.com/callback/flutterwave\",\n \"narration\": \"Payment for flight ticket ORDER_ABC123\",\n \"action\": \"instant\"\n}\n\nImplementation Note: Paystack integration logic is handled in callback/webhook functions, not in the main debit endpoint.
\nPOST /api/callback/flutterwaveHandles Flutterwave transfer status updates.
\nhttp
\nverif-hash: <FLW_SECRET_HASH>\nContent-Type: application/json\n\njson
\n{\n \"data\": {\n \"reference\": \"TXN_REF_789\",\n \"id\": \"TRANSFER_ID_123\",\n \"status\": \"SUCCESSFUL\"\n }\n}\n\nValidates verif-hash header matches FLW_SECRET_HASH
Returns 403 on invalid signature
\nPOST /api/callback/paystackHandles Paystack transfer status updates.
\nhttp
\nx-paystack-signature: <HMAC_SHA512_SIGNATURE>\nContent-Type: application/json\n\nValidates HMAC SHA512 signature using PAYSTACK_SECRET_KEY
Returns 403 on invalid signature
\nGET /api/callback/paystack/redirectUser-facing callback for Paystack transfers.
\nVerifies transaction status with Paystack API
\nDoes NOT update wallet balance directly
\nTriggers webhook logic for processing
\nReturns current transaction status
\ntext
\nwallet_debit:{booking_type}:{booking_id[:10]}:{timestamp}\n\nChecks for existing transaction with same idempotency key
\nReturns existing transaction data (200 OK)
\nPrevents double-charging for same booking
\npython
\nWalletTransaction:\n idempotency_key: String (unique)\n reference: String (unique)\n status: String (pending/processing/success/failed)\n\ntext
\nif request_currency == wallet_currency:\n debit_amount = amount\nelse:\n converted = convert_currency(amount, request_currency, wallet_currency)\n debit_amount = round(converted, 2)\n\ntext
\nhermex_markup = debit_amount * 0.03 # 3% markup\nreal_debit_amount = debit_amount - hermex_markup\n\ntext
\nif wallet_currency == request_currency:\n provider_amount = real_debit_amount\nelse:\n provider_amount = convert_currency(real_debit_amount, wallet_currency, request_currency)\n\nvirtual_wallets
\nbalance: Reduced on successful debit
reserved_balance: Temporarily increased then reduced
wallet_transactions
\nNew \"debit\" type transaction
\nStatus: pending → processing → success/failed
\npayment_transactions
\nLinks to booking and wallet transaction
\nStores provider details and markup
\nbookings
\nbooking_status: Updated to \"PROCESSING\"
source: Set to \"INTERNAL WALLET DEBITING\"
\"Debiting wallet for Intraverse flight booking\"
\"Intraverse flight booking debit for USD/GHS wallet via Flutterwave\"
\"Debiting wallet for Hotel Booking\"
All exceptions with full stack trace
\nroutes_loggerJWT token required
\nUser can only debit their own wallet
\nAll inputs validated and sanitized
\nDecimal precision maintained throughout
\nPrevents duplicate charges
\nSafe retry mechanism
\nFlutterwave: verif-hash validation
Paystack: HMAC SHA512 signature validation
\nPrevents race conditions with concurrent debits
\nEnsures funds are available during processing
\nDatabase operations wrapped in transactions
\nAutomatic rollback on failures
\nbash
\ncurl -X POST https://api.your-domain.com/api/virtual-wallet/debit \\\n -H \"Content-Type: application/json\" \\\n -H \"Authorization: Bearer YOUR_JWT_TOKEN\" \\\n -d '{\n \"amount\": 1000.00,\n \"request_currency\": \"USD\",\n \"reason\": \"Flight to London\",\n \"booking_id\": \"FLIGHT_789\"\n }'\n\nbash
\ncurl -X POST https://api.your-domain.com/api/virtual-wallet/debit \\\n -H \"Content-Type: application/json\" \\\n -H \"Authorization: Bearer YOUR_JWT_TOKEN\" \\\n -d '{\n \"amount\": 250.00,\n \"request_currency\": \"NGN\",\n \"reason\": \"Hotel reservation\",\n \"booking_id\": \"HOTEL_456\"\n }'\n\npython
\nimport requests\nheaders = {\n \"Authorization\": \"Bearer YOUR_JWT_TOKEN\",\n \"Content-Type\": \"application/json\"\n}\ndata = {\n \"amount\": 750.50,\n \"request_currency\": \"GHS\",\n \"reason\": \"Flight booking\",\n \"booking_id\": \"BOOK_GH123\"\n}\nresponse = requests.post(\n \"https://api.your-domain.com/api/virtual-wallet/debit\",\n headers=headers,\n json=data\n)\nprint(f\"Status: {response.status_code}\")\nprint(f\"Response: {response.json()}\")\n\ntext
\nUser Request\n ↓\nValidate Inputs\n ↓\nCheck Wallet & Balance\n ↓\nGenerate Idempotency Key\n ↓\nReserve Balance\n ↓\nApply Markup (3%)\n ↓\n ├── Flight Booking → External Provider → Processing Status\n ├── Hotel Booking → Direct Debit → Success Status\n └── Other Booking → Direct Debit → Success Status\n ↓\n ├── Success → Update Balance & Booking\n └── Failure → Rollback & Release Funds\n\nFlight bookings require external provider integration and may have delayed status updates
\nHotel/other bookings are processed immediately
\nReserved balance ensures funds aren't double-spent during processing
\nMarkup (3%) is deducted before provider transfer
\nCallbacks/webhooks are essential for flight booking completion
\nCurrency conversions happen at current exchange rates via convert_currency()
Decimal precision is maintained throughout (2 decimal places)
\nError responses include detailed metadata for debugging
\nTimestamps are always in UTC format (ISO 8601)
\nThe Virtual Wallet system provides a comprehensive solution for managing user wallet balances, enabling deposits, debits for bookings, and balance inquiries. The system supports multiple currencies (NGN, USD, GHS) and integrates with leading payment gateways including Paystack (for NGN) and Flutterwave (for USD/GHS).
\nKey features include:
\nAll endpoints require JWT (JSON Web Token) authentication.
\nMethod: Bearer Token in Authorization header
\nExample: Authorization: Bearer <jwt_token>
Endpoint: POST {{baseUrl}}/api/v2/user/virtualwallet/credit
Handles virtual wallet deposits by processing payment requests, validating currencies, and initializing payments through supported payment gateways.
\nContent-Type: application/json\nAuthorization: Bearer <jwt_token>\n{\n \"amount\": 1000.50,\n \"currency\": \"NGN\"\n}\n{\n \"status\": true,\n \"message\": \"Authorization URL created\",\n \"data\": {\n \"authorization_url\": \"https://checkout.paystack.com/...\",\n \"access_code\": \"xxxxxx\",\n \"reference\": \"txn_ref_123\"\n }\n}\n400 - Bad Request (Invalid Amount)
\n{\n \"error\": \"Invalid amount\"\n}\n400 - Currency Mismatch
\n{\n \"status\": \"error\",\n \"success\": false,\n \"message\": \"Wallet funding currency mismatch\",\n \"code\": \"400 --> BAD REQUEST\",\n \"wallet_currency\": \"NGN\",\n \"payment_currency\": \"USD\",\n \"meta\": {\n \"timestamp\": \"2024-01-01T12:00:00Z\",\n \"user_message\": \"This wallet is denominated in NGN. You can only fund it using NGN not USD. Please try again with the correct currency.\"\n }\n}\n404 - User Not Found
\n{\n \"error\": \"User not found\"\n}\n409 - Duplicate Transaction
\n{\n \"error\": \"Duplicate transaction\"\n}\n502 - Payment Gateway Error
\n{\n \"error\": \"Payment gateway error\"\n}\nEndpoint: POST {{baseUrl}}/api/v2/user/virtualwallet/debit
Debits a user's virtual wallet for booking payments (flights, hotels, etc.). The system reserves funds, processes currency conversions, applies markup, and integrates with payment providers for fund transfers.
\nContent-Type: application/json\nAuthorization: Bearer <jwt_token>\n{\n \"amount\": 500.00,\n \"request_currency\": \"NGN\",\n \"reason\": \"Flight booking payment\",\n \"booking_id\": \"BOOK_123456\"\n}\n{\n \"status\": \"success\",\n \"success\": true,\n \"code\": \"200 --> OK\",\n \"message\": \"Wallet debited successfully for FLIGHT booking\",\n \"data\": {\n \"debited_amount\": \"500.00\",\n \"wallet_currency\": \"NGN\",\n \"reference\": \"TXN_REF_789\",\n \"new_balance\": \"2500.00\",\n \"booking_details\": {\n \"order_id\": \"ORDER_ABC123\",\n \"type\": \"flight\"\n }\n },\n \"meta\": {\n \"timestamp\": \"2024-01-01T12:00:00Z\"\n }\n}\n{\n \"status\": \"success\",\n \"success\": true,\n \"code\": \"200 --> OK\",\n \"message\": \"Intraverse transfer completed successfully\",\n \"data\": {\n \"debited_amount\": \"500.00\",\n \"wallet_currency\": \"NGN\",\n \"reference\": \"TXN_REF_789\",\n \"new_balance\": \"2500.00\",\n \"transfer_details\": {\n \"provider\": \"flutterwave\",\n \"status\": \"completed\"\n }\n }\n}\n400 - Bad Request (Invalid Amount)
\n{\n \"error\": \"Invalid amount\"\n}\n400 - Insufficient Funds
\n{\n \"status\": \"error\",\n \"success\": false,\n \"message\": \"Insufficient wallet balance\",\n \"code\": \"400 --> BAD REQUEST\",\n \"data\": {\n \"required_amount\": \"500.00\",\n \"available_balance\": \"200.00\",\n \"currency\": \"NGN\"\n },\n \"meta\": {\n \"timestamp\": \"2024-01-01T12:00:00Z\"\n }\n}\n404 - Booking Not Found
\n{\n \"error\": \"Booking not found\"\n}\n404 - User Not Found
\n{\n \"error\": \"User not found\"\n}\n409 - Duplicate Transaction
\n{\n \"error\": \"Duplicate transaction\"\n}\n502 - Payment Provider Error
\n{\n \"error\": \"Payment provider error\"\n}\nEndpoint: GET {{baseUrl}}/api/v2/user/virtualwallet/balance
Retrieves the current balance of the user's virtual wallet.
\nAuthorization: Bearer <jwt_token>\nNo request body or query parameters required.
\n{\n \"status\": \"success\",\n \"success\": true,\n \"code\": \"200 --> OK\",\n \"message\": \"Wallet balance retrieved successfully\",\n \"data\": {\n \"balance\": \"2500.00\",\n \"currency\": \"NGN\",\n \"wallet_id\": \"WALLET_123\",\n \"last_transaction_date\": \"2024-01-01T12:00:00Z\"\n },\n \"meta\": {\n \"timestamp\": \"2024-01-01T12:00:00Z\"\n }\n}\n404 - Wallet Not Found
\n{\n \"status\": \"error\",\n \"success\": false,\n \"message\": \"Wallet not found\",\n \"code\": \"404 --> NOT FOUND\",\n \"meta\": {\n \"timestamp\": \"2024-01-01T12:00:00Z\"\n }\n}\n401 - Unauthorized
\n{\n \"error\": \"Unauthorized access\"\n}\nThe Virtual Wallet system supports three currencies:
\nThis endpoint allows users to submit inquiries or feedback through a contact form. It is designed to facilitate communication between users and the support team regarding questions, suggestions, or any other concerns.
\nMethod: POST
\nEndpoint: {{baseUrl}}/user/contact-us
The request body must be in JSON format and should include the following parameters:
\nname (string): The name of the user submitting the inquiry.
\nemail (string): The email address of the user for follow-up communication.
\nsubject (string): A brief subject line summarizing the inquiry.
\nmessage (string): The detailed message or question from the user.
\nExample Request Body:
\n{\n \"name\": \"Alice Example\",\n \"email\": \"alice@example.com\",\n \"subject\": \"Question about pricing\",\n \"message\": \"Hi team, I’d like to know more ...\"\n}\n\nUpon successful submission, the API will respond with a status code of 200 and a JSON object containing a message.
Status Code: 200
\nContent-Type: application/json
\nExample Response:
\n{\n \"message\": \"\"\n}\n\nThis response indicates that the inquiry has been successfully received, and any further communication will be directed to the provided email address.
\n","urlObject":{"path":["user","contact-us"],"host":["{{baseUrl}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"2b2723c3-129e-4b76-b65b-6a33f6a9b1d6"}],"id":"732b4ecf-d117-4a78-9f8e-3945a110fba1","description":"Endpoints for USERS/CLIENTS in hermex travels
\n","_postman_id":"732b4ecf-d117-4a78-9f8e-3945a110fba1"},{"name":"Admin & Super_Admin Endpoints","item":[{"name":"AdminRoute/Create/Login","item":[{"name":"admin/login","id":"64a6bdd6-16ac-449e-975b-acd1dc89e102","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"username\": \"Super=Admin\",\r\n \"password\": \"SuperAdmin123\"\r\n}\r\n","options":{"raw":{"language":"json"}}},"url":"{{baseUrl}}/admin/login","description":"This endpoint allows administrators to log in.
\nusername (string): The username of the administrator.
password (string): The password of the administrator.
The response is in JSON format with the following schema:
\n{\n \"type\": \"object\",\n \"properties\": {\n \"access_token\": {\n \"type\": \"string\"\n }\n }\n}\n\nThis endpoint is used to access the admin interface.
\nThe request to this endpoint is an HTTP GET request with no request body.
\nThis request does not require a request body.
\nThe response to this request is in JSON format and includes the following fields:
\ntotal_bookings (number): The total number of bookings.
total_revenue (number): The total revenue generated.
total_users (number): The total number of users.
trip_forms (array): An array of trip forms, each containing the following fields:
activity (string): The activity of the trip.
date (string): The date of the trip.
destination (string): The destination of the trip.
duration (string): The duration of the trip.
name (string): The name of the trip.
{\n \"type\": \"object\",\n \"properties\": {\n \"total_bookings\": {\n \"type\": \"number\"\n },\n \"total_revenue\": {\n \"type\": \"number\"\n },\n \"total_users\": {\n \"type\": \"number\"\n },\n \"trip_forms\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"object\",\n \"properties\": {\n \"activity\": {\n \"type\": \"string\"\n },\n \"date\": {\n \"type\": \"string\"\n },\n \"destination\": {\n \"type\": \"string\"\n },\n \"duration\": {\n \"type\": \"string\"\n },\n \"name\": {\n \"type\": \"string\"\n }\n }\n }\n }\n }\n}\n\nEndpoints for ADMIN Route/Create/Login functions in hermex travels
\n","_postman_id":"f8fb4f29-e942-4ac9-acd7-fa1a91441e10"},{"name":"Super Admin Only","item":[{"name":"admin/create_admin","id":"67a7dc37-9716-486a-bc86-ffbe39de3a88","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{vault:authorization-secret}}"}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"username\": \"adminElmo\",\r\n \"password\": \"admin123\",\r\n \"email\": \"boronicle@gmail.com\",\r\n \"full_name\": \"Admin User\",\r\n \"phone_number\": \"+1234567890\",\r\n \"country\": \"CountryName\",\r\n \"preferred_language\": \"English\",\r\n \"travel_preferences\": {\"destinations\": [\"Paris\", \"London\"]}\r\n}\r\n","options":{"raw":{"language":"json"}}},"url":"{{baseUrl}}/admin/create_admin","description":"This endpoint allows you to create a new admin user. The request should be sent as an HTTP POST to the specified URL. The request body should be in raw JSON format and include the following parameters:
\nusername (string): The username of the admin user.
\npassword (string): The password for the admin user.
\nemail (string): The email address of the admin user.
\nfull_name (string): The full name of the admin user.
\nphone_number (string): The phone number of the admin user.
\ncountry (string): The country of residence of the admin user.
\npreferred_language (string): The preferred language of the admin user.
\ntravel_preferences (object): An object containing the travel preferences of the admin user, including a list of destinations.
\nThe response to this request will have a status code of 201 and a content type of application/json. The response body will contain a message confirming the successful creation of the admin user.
\n","urlObject":{"path":["admin","create_admin"],"host":["{{baseUrl}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"67a7dc37-9716-486a-bc86-ffbe39de3a88"},{"name":"admin/assign_admin/","id":"e34fbfd2-831b-4582-b647-de6f64a80d06","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{vault:authorization-secret}}"}]},"isInherited":false},"method":"PUT","header":[],"url":"{{baseUrl}}/admin/assign_admin/ElmoT","description":"The PUT request is used to update or create the admin assignment for a specific user at the given endpoint. The request should include the user identifier in the URL path.
The response returned with a status code of 200 and a content type of application/json. The response body follows the JSON schema below:
{\n \"message\": \"\"\n}\n\nThis endpoint is used to update the role of a user in the admin system.
\nusername (string, required): The username of the user whose role needs to be updated.
role (string, required): The new role to be assigned to the user.
The response is in JSON format with the following schema:
\n{\n \"message\": \"string\"\n}\n\nmessage (string): A message indicating the status of the role update operation.This endpoint sends an HTTP DELETE request to delete a user with the specified username.
\nThe response is in JSON format and has the following schema:
\n{\n \"type\": \"object\",\n \"properties\": {\n \"message\": {\n \"type\": \"string\"\n }\n }\n}\n\nEndpoints for SUPER ADMIN ALONE
\n","_postman_id":"f61b5380-7eb7-44cf-ac4f-1c5fc504a52e"},{"name":"Basic Functions","item":[{"name":"/admin/deactivate_user","id":"c9d15cac-9eb7-4182-ba2a-fbd9dba05872","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{vault:authorization-secret}}"}]},"isInherited":false},"method":"PUT","header":[],"url":"{{baseUrl}}/admin/deactivate_user/Rassy1","description":"The endpoint sends an HTTP PUT request to deactivate a user with the specified ID. Upon successful execution, the response returns a status code of 200 and a JSON object with a key \"message\" and an empty string value.
\n{\n \"type\": \"object\",\n \"properties\": {\n \"message\": {\n \"type\": \"string\"\n }\n }\n}\n\nThis endpoint retrieves a list of users from the admin panel.
\nNo request body is required for this endpoint.
\nThe response will be in JSON format with the following schema:
\n{\n \"type\": \"object\",\n \"properties\": {\n \"users\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"string\"\n }\n }\n }\n}\n\nThe response will include a users array containing the list of users.
This endpoint sends an HTTP PUT request to reactivate a user with the specified ID.
\nThe response returns a JSON object with the following schema:
\n{\n \"type\": \"object\",\n \"properties\": {\n \"message\": {\n \"type\": \"string\"\n }\n }\n}\n\nThis endpoint makes an HTTP GET request to retrieve user information for the specified user ID. The response returns a JSON object with the user's details including country, email, full name, active status, phone number, preferred language, role, and travel preferences.
\nThis request does not require a request body.
\nThe response is in the form of a JSON object with the following schema:
\n{\n \"country\": \"\",\n \"email\": \"\",\n \"full_name\": \"\",\n \"is_active\": null,\n \"phone_number\": \"\",\n \"preferred_language\": \"\",\n \"role\": \"\",\n \"travel_preferences\": \"\",\n \"username\": \"\"\n}\n\nThe response schema includes the user's details such as country, email, full name, active status, phone number, preferred language, role, travel preferences, and username.
\n","urlObject":{"protocol":"https","path":["admin","view_user","Elo"],"host":["praiseordu","pythonanywhere","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"1459979d-d83f-4b70-8f9b-3d8723e64d53"},{"name":"admin/view_booking","id":"a9f14d8d-4209-48ee-93a2-5245e00a2312","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{vault:authorization-secret}}"}]},"isInherited":false},"method":"GET","header":[],"url":"{{baseUrl}}/admin/view_booking/123","description":"This endpoint retrieves the details of a specific booking with the ID 123.
\nNo request body is required for this endpoint.
\nThe response will be in JSON format and will follow the schema below:
\n{\n \"type\": \"object\",\n \"properties\": {\n \"error\": {\n \"type\": \"string\"\n }\n }\n}\n\nThe response will include the following key:
\nerror: A string indicating the error message, if any.This endpoint retrieves a list of feedback from the admin panel.
\nNo request body is required for this endpoint.
\nThe response is in JSON format and follows the schema below:
\n{\n \"feedback\": []\n}\n\nThe feedback key contains an array of feedback objects. In this particular response, the array is empty.
Endpoints for basic ADMIN user functions in hermex travels
\n","_postman_id":"2319fa51-109c-4291-9b46-4f3f60137f0d"},{"name":"Advanced Functions","item":[{"name":"user/total_revenue","id":"214fc9c1-c7f3-4334-93b9-d0da637b3843","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{vault:authorization-secret}}"}]},"isInherited":false},"method":"GET","header":[],"url":"{{baseUrl}}/user/total_revenue","description":"This endpoint retrieves the total revenue for the user.
\nThis request does not require a request body.
\ntotal_revenue (number): The total revenue generated by the user.Example Response:
\n{\n \"total_revenue\": 0\n}\n\nThis endpoint makes an HTTP GET request to retrieve and manage bookings from the admin interface.
\nThe request should be made to the following URL:
\nhttps://praiseordu.pythonanywhere.com/admin/manage_bookings\n\nThe request should include the following payload in the raw request body type:
\nUpon a successful execution, the response will have a status code of 200 and a content type of application/json. The response body will follow the JSON schema below:
{\n \"type\": \"object\",\n \"properties\": {\n \"bookings\": {\n \"type\": \"array\"\n }\n }\n}\n\nThis endpoint allows administrators to update the status of a booking. The HTTP PUT request should be made to https://praiseordu.pythonanywhere.com/admin/update_booking_status. The request should include a JSON payload with the \"booking_id\" and \"status\" fields.
\nbooking_id (number): The ID of the booking to be updated.
status (string): The new status to be assigned to the booking.
The response will be in JSON format with the following schema:
\n{\n \"type\": \"object\",\n \"properties\": {\n \"error\": {\n \"type\": \"string\"\n }\n }\n}\n\nThe response will have a status code of 404 if there is an error, and the \"error\" property will contain a string describing the error.
\n","urlObject":{"protocol":"https","path":["admin","update_booking_status"],"host":["praiseordu","pythonanywhere","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"2574ab43-79ef-4a5f-8473-3cd68314007e"},{"name":"/admin/generate_reports","id":"a4adabe2-0296-4e91-8bfd-877545268a03","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{vault:authorization-secret}}"}]},"isInherited":false},"method":"GET","header":[],"url":"{{baseUrl}}/admin/generate_reports","description":"This endpoint sends an HTTP GET request to retrieve reports from the admin. The response is in JSON format and includes the following fields:
\ntotal_bookings (number): The total number of bookings.
\ntotal_revenue (number): The total revenue generated.
\ntotal_users (number): The total number of users.
\n{\n \"total_bookings\": 0,\n \"total_revenue\": 0,\n \"total_users\": 0\n}\n\nThis endpoint allows the admin to update the status of a feedback entry.
\nfeedback_id (number): The ID of the feedback entry to be updated.
status (string): The new status to be assigned to the feedback entry.
The response will be in JSON format with the following schema:
\n{\n \"type\": \"object\",\n \"properties\": {\n \"error\": {\n \"type\": \"string\"\n }\n }\n}\n\n{\n \"feedback_id\": 0,\n \"status\": \"\"\n}\n\nStatus: 404
\nContent-Type: application/json
\n{ \"error\": \"\"}
\nStartFragment
\nGET /audit_trails
This endpoint allows administrators (admin or super_admin) to view audit trail logs, optionally filtered by action type, user, and date range.
Ensure the request includes the following headers:
\nOptional query parameters to filter the audit trails:
\nStatus Code: 200 OK
Response Body:
{\n \"audit_trails\": [\n {\n \"id\": 1,\n \"action\": \"login\",\n \"performed_by\": 42,\n \"target_user\": null,\n \"target_resource\": \"auth_service\",\n \"timestamp\": \"2024-01-10T15:30:00Z\",\n \"details\": \"User logged in successfully.\"\n },\n {\n \"id\": 2,\n \"action\": \"update\",\n \"performed_by\": 42,\n \"target_user\": 45,\n \"target_resource\": \"user_management\",\n \"timestamp\": \"2024-01-11T10:00:00Z\",\n \"details\": \"Updated user profile.\"\n }\n ],\n \"total_logs\": 2,\n \"message\": \"Audit trails retrieved successfully.\"\n}\n\nStatus Code: 403 Forbidden
Response Body:
{\n \"error\": \"Unauthorized access. Only admins and super_admins are allowed.\"\n}\n\nperformed_by ValueStatus Code: 400 Bad Request
Response Body:
{\n \"error\": \"Invalid performed_by value. It should be a numeric user ID.\"\n}\n\nstart_date or end_date FormatStatus Code: 400 Bad Request
Response Body:
{\n \"error\": \"Invalid start_date format. Use ISO 8601 format (e.g., 2023-01-01T00:00:00Z).\"\n}\n\nStatus Code: 404 Not Found
Response Body:
{\n \"error\": \"User not found\"\n}\n\nStatus Code: 500 Internal Server Error
Response Body:
{\n \"error\": \"An unexpected error occurred. Please try again later.\"\n}\n\nJWT Authentication
\nAuthorization header.User Role Validation
\nThe logged-in user must have the role of admin or super_admin.
403 Forbidden is returned for unauthorized roles.
Optional Filters
\naction, performed_by, start_date, and end_date are applied if provided in the request query.Role-Based Filtering
\nadmin: Can view only the logs they performed and that of regular users but not other admins or the super admin.
super_admin: Can view all logs.
Query Execution
\nResponse Construction
\nEndpoints for Advanced ADMIN user functions in hermex travels
\n","_postman_id":"5a40b0e4-3ff0-443b-aa74-babac67c5ab4"},{"name":"Events & Organizations","item":[{"name":"Events","item":[{"name":"New Request","id":"8f755bac-6af8-41e8-8822-b2d555d3cad8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"","urlObject":{"query":[],"variable":[]}},"response":[],"_postman_id":"8f755bac-6af8-41e8-8822-b2d555d3cad8"}],"id":"8dcd29dd-f3ed-4c20-aea4-35123e008ae7","_postman_id":"8dcd29dd-f3ed-4c20-aea4-35123e008ae7","description":""},{"name":"Organizatinos","item":[{"name":"Create/Add Orgs","id":"c2401a4b-1a0e-4be6-9f0c-d7fa51bc1d05","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"name\": \"Pajoma Tours\",\r\n \"contact_number\": \"+5244555885555\",\r\n \"contact_email\": \"pajomatours@pajoma.com\",\r\n \"description\": \"A fantastic place to visit with your family and friends\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{baseUrl}}/admin/events/orgs_services/add_organization","urlObject":{"path":["admin","events","orgs_services","add_organization"],"host":["{{baseUrl}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"c2401a4b-1a0e-4be6-9f0c-d7fa51bc1d05"}],"id":"ae22cc1f-6e82-4763-8a72-9d884caf5b1c","_postman_id":"ae22cc1f-6e82-4763-8a72-9d884caf5b1c","description":""}],"id":"a3702d54-749b-4200-b9fb-2ea377f1fa78","_postman_id":"a3702d54-749b-4200-b9fb-2ea377f1fa78","description":""},{"name":"PIN Reset","item":[{"name":"Reset User Pin","id":"7fd2ac63-06fa-4d7f-b147-1620c71f714d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"{{baseUrl}}/admin/reset-pin","urlObject":{"path":["admin","reset-pin"],"host":["{{baseUrl}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"7fd2ac63-06fa-4d7f-b147-1620c71f714d"}],"id":"7cd52c0f-4a6b-4437-979d-441b457877f3","_postman_id":"7cd52c0f-4a6b-4437-979d-441b457877f3","description":""},{"name":"Newsletter","item":[{"name":"Newsletter send","id":"e28d7714-c96e-4551-afcc-7feba8f25ae3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{vault:authorization-secret}}"}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"subject\": \"New Dream Travels on the horizon\",\r\n \"content\": \"Welcome to the world of Hermex where travel is seamlined tailored to your needs
\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{baseUrl}}/admin/newsletter/send","description":"POST /admin/newsletter/send
This endpoint allows admin and super_admin users to send out newsletters to all subscribers. It validates authentication and authorization before dispatching the newsletter content.
\n🔐 JWT authentication is required
\nOnly users with roles: admin or super_admin can access this route
{\n \"subject\": \"Hermex Weekly Travel Update\",\n \"content\": \"<h1 class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml'>This Week's Top Destinations</h1><p class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml'>Explore with us!</p>\"\n}\n\nNewsletter was successfully sent to all subscribers.
\nResponse Body:
\n{\n \"message\": \"Newsletter sent\"\n}\n\nMissing required subject or content.
Response Body:
\nThe authenticated user is not authorized (not an admin or super_admin).
\nResponse Body:
\n{\n \"error\": \"Unauthorized access. Only an admin or super_admin is allowed.\"\n}\n\nAuthenticate the user with JWT.
\nRetrieve user details and check role.
\nIf unauthorized, log the event in the AuditTrail and return 403.
If subject or content is missing, return 400.
If valid, call send_newsletter(subject, content) to dispatch the newsletter.
Return success response.
\nWelcome to the world of Hermex where travel is seamlined tailored to your needs
\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{baseUrl}}/admin/newsletter/send"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Sun, 29 Jun 2025 21:33:59 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"cloudflare"},{"key":"Nel","value":"{\"report_to\":\"cf-nel\",\"success_fraction\":0.0,\"max_age\":604800}"},{"key":"Access-Control-Allow-Origin","value":"http://localhost:3000"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Vary","value":"Origin"},{"key":"Cf-Cache-Status","value":"DYNAMIC"},{"key":"Report-To","value":"{\"group\":\"cf-nel\",\"max_age\":604800,\"endpoints\":[{\"url\":\"https://a.nel.cloudflare.com/report/v4?s=NFWlctJbcUKDGN1L%2BqWUST39EOjV7g5jU9zhnIROvslAAc2JRiFKqTQhwuO9kxcaZsET5GS8RTR161VEV59owMdzAU4rtJOj0kP281fzjZV4Gkfa3oLGxqE%3D\"}]}"},{"key":"Content-Encoding","value":"br"},{"key":"CF-RAY","value":"95788b97d98afea9-LHR"},{"key":"alt-svc","value":"h3=\":443\"; ma=86400"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Newsletter sent\"\n}"}],"_postman_id":"e28d7714-c96e-4551-afcc-7feba8f25ae3"},{"name":"Get Newsletter Subs","id":"61e8da8a-574a-4b0b-bbe9-ef24ba30dbb9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{vault:authorization-secret}}"}]},"isInherited":false},"method":"GET","header":[],"url":"{{baseUrl}}/admin/newsletter/get-subscribers","description":"GET /admin/newsletter/get-subscribers
This endpoint returns a list of all newsletter subscriber email addresses. It is accessible only by users with admin or super_admin roles. Unauthorized access attempts are logged in the audit trail for security purposes.
🔐 JWT Authentication Required
\nRole-based Access: Only admin and super_admin users are permitted
Returns the list of subscriber emails.
\nResponse Body:
\n{\n \"subscribers\": [\n \"john@example.com\",\n \"alice@example.com\",\n \"samuel@example.com\"\n ]\n}\n\nReturned when a non-admin user attempts to access the endpoint. Logs the unauthorized attempt to the AuditTrail.
Response Body:
\n{\n \"error\": \"Unauthorized access. Only an admin or super_admin is allowed.\"\n}\n\nThe user must be authenticated via a valid JWT token.
\nThe identity is retrieved and used to fetch the user from the database.
\nIf the user is not an admin or super_admin:
Access is denied (403).
\nAn entry is created in the AuditTrail model to log the unauthorized attempt.
If authorized:
\nAll subscriber emails are queried from the Subscriber table.
The emails are returned in the response as a list.
\nThis endpoint allows you to delete an image asset from the email assets storage by providing the image URL.
\nUpon a successful deletion, the API will return a response with a status code of 200 and a JSON object containing a message. The expected response format is as follows:
{\n \"message\": \"Image \\\"8f6d4fe28db245b0b1d80526d41260d1_2013_07_Fresh-Windows-Wallpapers-50.jpg\\\" deleted successfully\"\n}\n\nEnsure that the provided image_url is valid and corresponds to an existing image in the storage.
The response message may be empty, indicating that the deletion was successful without any additional information.
\nThis operation is irreversible, so use it with caution.
\nEndpoints for ADMIN users in hermex travels
\n","_postman_id":"9bd19cfe-2309-4760-99a1-ed9818bf9398"},{"name":"Hotels Endpoints","item":[{"name":"BASIC Hotel Functions","item":[{"name":"hotels/search_hotels","id":"17feb79e-1783-4932-a820-1842a8dd9397","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{baseUrl}}/hotels/search_hotels?city_name=London","description":"Base URL: https://backend.hermextravels.com/
Search for hotels based on location and various filters.
\nGET /hotels/search_hotels
amenities[]****)Available amenity filters (case-insensitive):
\n\"wifi\"
\"pool\"
\"gym\"
\"parking\"
\"restaurant\"
\"spa\"
\"pet_friendly\" (same as pet_friendly=true)
jsonCopy
\n{\n \"coordinates\": {\n \"lat\": 37.1283343,\n \"lon\": -84.0835576\n },\n \"current_page\": 1,\n \"hotels\": [\n {\n \"id\": \"lp3fe05\",\n \"name\": \"Quality Inn\",\n \"chain\": \"Quality Inn\",\n \"address\": \"400 Gop St\",\n \"city\": \"London\",\n \"country\": \"US\",\n \"zip\": \"40741\",\n \"latitude\": 37.14835,\n \"longitude\": -84.10971,\n \"rating\": 7.2,\n \"reviewCount\": 204,\n \"stars\": 2,\n \"main_photo\": \"https://static.cupid.travel/hotels/269699943.jpg\",\n \"thumbnail\": \"https://static.cupid.travel/hotels/thumbnail/269699943.jpg\",\n \"currency\": \"USD\",\n \"facilityIds\": [2083, 16, 109, ...],\n \"accessibilityAttributes\": {\n \"petFriendly\": \"\",\n \"showerChair\": null,\n ...\n }\n },\n ...\n ],\n \"per_page\": 20,\n \"total_hotels\": 15,\n \"total_pages\": 1\n}\n\nhttpCopy
\nGET /hotels/search_hotels?city_name=London&country_code=US\n\nhttpCopy
\nGET /hotels/search_hotels?city_name=London&rating_min=7&amenities[]=wifi&amenities[]=pool\n\nStartFragment
\njsonCopyEdit{\n \"total_hotels\": 200,\n \"total_pages\": 10,\n \"current_page\": 2,\n \"per_page\": 20,\n \"hotels\": [\n {\n \"id\": \"54321\",\n \"name\": \"Marriott Paris\",\n \"rating\": 4.7,\n \"chain\": \"Marriott\",\n \"room_type\": \"Deluxe\",\n \"free_cancellation\": false,\n \"pet_friendly\": true,\n \"child_friendly\": true,\n \"facilityIds\": [101, 202],\n \"location\": {\n \"city\": \"Paris\",\n \"country\": \"FR\"\n }\n }\n ],\n \"coordinates\": {\n \"lat\": 48.8566,\n \"lon\": 2.3522\n }\n}\n\nhttpCopy
\nGET /hotels/search_hotels?city_name=London&page=2&per_page=10\n\n400 Bad Request
{\n \"error\": \"Invalid country code format\"\n}\n\n404 Not Found
{\n \"error\": \"No hotels found\"\n}\n\n400 Bad Request
{\n \"error\": \"Parameter 'rating_min' must be a number\"\n}\n\n500 Internal Server Error
{\n \"error\": \"Unexpected error occurred\"\n}\n\nGet all hotels → Paginated list is returned.
\nApply filters → Narrow down search results.
\nUse pagination → Navigate through results.
\n🔹 Users must first retrieve hotels before applying filters to ensure a smooth experience.
\n🔹 Pagination ensures efficient data retrieval.
\nGET /search_hotels?city_name=New York&country_code=US&page=1&per_page=10\n\nGET /search_hotels?city_name=London&country_code=GB&rating_min=5.0&pet_friendly=true\n\nConvenient Location near Daniel Boone National Forrest
This hotel is the perfect choice for nature lovers, being just 2 miles away from the stunning Daniel Boone National Forrest.
Comfortable Rooms and Amenities
The rooms at Country Inn & Suites London, Kentucky are designed for both relaxation and productivity, featuring free Wi-Fi, cable TV, and a work desk. The added convenience of a microwave and refrigerator ensures a comfortable stay.
Relaxing and Convenient Facilities
Guests can start their day with a delicious hot continental breakfast and take advantage of the heated indoor pool, fitness centre, meeting room, and library. The hotel offers everything you need for a memorable stay.
Book your stay now at Country Inn & Suites London, Kentucky for a perfect blend of comfort and convenience.
\",\n \"hotelTypeId\": 204,\n \"id\": \"lp1f847\",\n \"latitude\": 37.11207,\n \"longitude\": -84.10037,\n \"main_photo\": \"https://static.cupid.travel/hotels/521218529.jpg\",\n \"name\": \"Country Inn & Suites by Radisson, London, KY\",\n \"rating\": 8.2,\n \"reviewCount\": 929,\n \"stars\": 3,\n \"thumbnail\": \"https://static.cupid.travel/hotels/thumbnail/521218529.jpg\",\n \"zip\": \"40741\"\n },\n {\n \"accessibilityAttributes\": {\n \"attributes\": null,\n \"distanceFromTheElevatorToTheAccessibleRoom\": 0,\n \"entranceDoorWidth\": 0,\n \"entranceType\": null,\n \"petFriendly\": \"\",\n \"rampAngle\": 0,\n \"rampLength\": 0,\n \"roomMaxGuestsNumber\": 0,\n \"showerChair\": null\n },\n \"address\": \"100 Holiday Trl Ne\",\n \"chain\": \"Holiday Inn Express\",\n \"chainId\": 2301,\n \"city\": \"London\",\n \"country\": \"us\",\n \"currency\": \"USD\",\n \"deletedAt\": null,\n \"facilityIds\": [\n 2083,\n 6848,\n 16,\n 109,\n 28,\n 48,\n 51,\n 81,\n 25,\n 108,\n 143,\n 455,\n 451,\n 449,\n 462,\n 457,\n 461,\n 425,\n 459,\n 465,\n 468,\n 422,\n 424,\n 421,\n 420,\n 500,\n 521,\n 540,\n 584,\n 720,\n 757,\n 761,\n 784,\n 857\n ],\n \"hotelDescription\": \"Convenient Location
Situated just off I-70, Holiday Inn Express London I-70 is only 20 miles from downtown Columbus, offering easy access to both city attractions and peaceful natural spots.
Modern Amenities
Enjoy a complimentary continental breakfast, unwind in the indoor pool, and stay active in the state-of-the-art fitness center. Each room is equipped with free Wi-Fi, a flat-screen TV, microwave, and refrigerator for your convenience.
Business and Leisure Facilities
Benefit from the 24-hour business center, guest laundry facilities, and round-the-clock front desk service. Whether you're here for work or leisure, we've got you covered.
Book your stay at Holiday Inn Express London I-70 now and experience comfort and convenience at its best.
\",\n \"hotelTypeId\": 204,\n \"id\": \"lp252c5\",\n \"latitude\": 39.95204,\n \"longitude\": -83.38148,\n \"main_photo\": \"https://static.cupid.travel/hotels/337519258.jpg\",\n \"name\": \"Holiday Inn Express London-I-70, an IHG Hotel\",\n \"rating\": 7.1,\n \"reviewCount\": 200,\n \"stars\": 2,\n \"thumbnail\": \"https://static.cupid.travel/hotels/thumbnail/337519258.jpg\",\n \"zip\": \"43140\"\n },\n {\n \"accessibilityAttributes\": {\n \"attributes\": null,\n \"distanceFromTheElevatorToTheAccessibleRoom\": 0,\n \"entranceDoorWidth\": 0,\n \"entranceType\": null,\n \"petFriendly\": \"\",\n \"rampAngle\": 0,\n \"rampLength\": 0,\n \"roomMaxGuestsNumber\": 0,\n \"showerChair\": null\n },\n \"address\": \"1895 Highway 192 W\",\n \"chain\": \"Microtel Inns & Suites\",\n \"chainId\": 2111,\n \"city\": \"London\",\n \"country\": \"us\",\n \"currency\": \"USD\",\n \"deletedAt\": null,\n \"facilityIds\": [\n 2083,\n 6848,\n 16,\n 109,\n 301,\n 28,\n 4,\n 48,\n 49,\n 81,\n 25,\n 108,\n 127,\n 143,\n 170,\n 195,\n 222,\n 218,\n 455,\n 451,\n 449,\n 462,\n 457,\n 461,\n 425,\n 459,\n 467,\n 460,\n 465,\n 468,\n 422,\n 456,\n 452,\n 453,\n 424,\n 458,\n 486,\n 488,\n 418,\n 485,\n 420,\n 497,\n 521,\n 540,\n 568,\n 584,\n 630,\n 720,\n 757,\n 761,\n 784,\n 803,\n 857,\n 859,\n 916\n ],\n \"hotelDescription\": \"Modern Amenities and Comfortable Stay
This London hotel provides a comfortable stay with free Wi-Fi, an indoor pool, and rooms featuring a cable TV and work desk. Stay active at the fitness centre or relax in suites with a kitchenette and sofa bed.
Delicious Breakfast and Convenient Services
Start your day with a delicious continental breakfast including hot coffee, fresh fruit, and pastries. Benefit from a 24-hour reception, fax, photocopying services, and laundry facilities for added convenience.
Explore Nearby Attractions
Conveniently located, the hotel is just 1 mile from Mountain Laurel Gallery and 5 miles from Levi Jackson Wilderness State Park. Book your stay at Microtel Inn & Suites London for a delightful and convenient experience.
\",\n \"hotelTypeId\": 204,\n \"id\": \"lp27790\",\n \"latitude\": 37.11209,\n \"longitude\": -84.09555,\n \"main_photo\": \"https://static.cupid.travel/hotels/132452625.jpg\",\n \"name\": \"Microtel Inn & Suites by Wyndham London\",\n \"rating\": 7.6,\n \"reviewCount\": 694,\n \"stars\": 4,\n \"thumbnail\": \"https://static.cupid.travel/hotels/thumbnail/132452625.jpg\",\n \"zip\": \"40741\"\n },\n {\n \"accessibilityAttributes\": {\n \"attributes\": null,\n \"distanceFromTheElevatorToTheAccessibleRoom\": 0,\n \"entranceDoorWidth\": 0,\n \"entranceType\": null,\n \"petFriendly\": \"\",\n \"rampAngle\": 0,\n \"rampLength\": 0,\n \"roomMaxGuestsNumber\": 0,\n \"showerChair\": null\n },\n \"address\": \"400 Gop St\",\n \"chain\": \"Quality Inn\",\n \"chainId\": 1122,\n \"city\": \"London\",\n \"country\": \"us\",\n \"currency\": \"USD\",\n \"deletedAt\": null,\n \"facilityIds\": [\n 2083,\n 16,\n 109,\n 4,\n 49,\n 81,\n 25,\n 127,\n 185,\n 222,\n 455,\n 451,\n 449,\n 462,\n 461,\n 465,\n 468,\n 422,\n 456,\n 452,\n 453,\n 418,\n 421,\n 420,\n 540,\n 568,\n 584,\n 675,\n 708,\n 714,\n 720,\n 761,\n 803,\n 857,\n 859,\n 1005\n ],\n \"hotelDescription\": \"Convenient Location and Amenities
The Quality Inn hotel, just six miles from Wood Creek Lake, offers a range of amenities including free breakfast, high-speed internet, and local calls. Guest rooms are well-equipped with modern conveniences like refrigerators and microwaves, with some featuring whirlpool bathtubs.
Relaxing Recreation Options
Guests can unwind in the indoor heated pool, outdoor pool, or hot tub. The hotel is pet-friendly and provides laundry facilities for convenience. Corporate travelers have access to business services and a meeting room.
Explore Nearby Attractions
Located near popular spots like Daniel Boone Motocross Park and Levi Jackson State Park, guests can also visit the first Kentucky Fried Chicken restaurant. Shopping areas, restaurants, and lounges are just minutes away.
Book your stay at Quality Inn for a comfortable and enjoyable experience.
\",\n \"hotelTypeId\": 218,\n \"id\": \"lp3fe05\",\n \"latitude\": 37.14835,\n \"longitude\": -84.10971,\n \"main_photo\": \"https://static.cupid.travel/hotels/269699943.jpg\",\n \"name\": \"Quality Inn\",\n \"rating\": 7.2,\n \"reviewCount\": 204,\n \"stars\": 2,\n \"thumbnail\": \"https://static.cupid.travel/hotels/thumbnail/269699943.jpg\",\n \"zip\": \"40741\"\n },\n {\n \"accessibilityAttributes\": {\n \"attributes\": null,\n \"distanceFromTheElevatorToTheAccessibleRoom\": 0,\n \"entranceDoorWidth\": 0,\n \"entranceType\": null,\n \"petFriendly\": \"\",\n \"rampAngle\": 0,\n \"rampLength\": 0,\n \"roomMaxGuestsNumber\": 0,\n \"showerChair\": null\n },\n \"address\": \"2075 Hwy 192\",\n \"chain\": \"Baymont Inn & Suites\",\n \"chainId\": 1993,\n \"city\": \"London\",\n \"country\": \"us\",\n \"currency\": \"USD\",\n \"deletedAt\": null,\n \"facilityIds\": [\n 2083,\n 6848,\n 16,\n 109,\n 301,\n 28,\n 4,\n 48,\n 81,\n 143,\n 195,\n 222,\n 200,\n 455,\n 449,\n 462,\n 457,\n 425,\n 459,\n 460,\n 468,\n 422,\n 456,\n 452,\n 458,\n 486,\n 464,\n 488,\n 418,\n 420,\n 497,\n 540,\n 584,\n 631,\n 642,\n 714,\n 720,\n 757,\n 761,\n 784,\n 828,\n 835,\n 857,\n 859,\n 899,\n 916,\n 1020\n ],\n \"hotelDescription\": \"Convenient Location
Situated just 2 minutes away from Interstate 75, Baymont Inn in London, Kentucky offers easy access to the scenic Laurel River Lake in the Daniel Boone National Forest.
Modern Amenities
Guests can stay connected with complimentary Wi-Fi throughout the property and take advantage of the outdoor pool and fitness centre for relaxation and recreation.
Comfortable Accommodations
Each room features a cable TV, desk, and en suite bathroom with a hairdryer. Upgrade to a suite for a luxurious spa bath experience.
Experience the perfect blend of convenience and comfort at Baymont Inn London. Book your stay now!
\",\n \"hotelTypeId\": 205,\n \"id\": \"lp1fe9f\",\n \"latitude\": 37.1125,\n \"longitude\": -84.10117,\n \"main_photo\": \"https://static.cupid.travel/hotels/428523831.jpg\",\n \"name\": \"Baymont by Wyndham London KY\",\n \"rating\": 7.6,\n \"reviewCount\": 364,\n \"stars\": 2,\n \"thumbnail\": \"https://static.cupid.travel/hotels/thumbnail/428523831.jpg\",\n \"zip\": \"40741\"\n },\n {\n \"accessibilityAttributes\": {\n \"attributes\": null,\n \"distanceFromTheElevatorToTheAccessibleRoom\": 0,\n \"entranceDoorWidth\": 0,\n \"entranceType\": null,\n \"petFriendly\": \"\",\n \"rampAngle\": 0,\n \"rampLength\": 0,\n \"roomMaxGuestsNumber\": 0,\n \"showerChair\": null\n },\n \"address\": \"506 Minton Drive\",\n \"chain\": \"Holiday Inn Express\",\n \"chainId\": 2301,\n \"city\": \"London\",\n \"country\": \"us\",\n \"currency\": \"USD\",\n \"deletedAt\": null,\n \"facilityIds\": [\n 2083,\n 16,\n 109,\n 301,\n 51,\n 81,\n 25,\n 75,\n 108,\n 455,\n 451,\n 449,\n 462,\n 457,\n 456,\n 488,\n 540,\n 584,\n 630,\n 720,\n 761,\n 828,\n 857,\n 916\n ],\n \"hotelDescription\": \"Indulge in Comfort and Convenience
Modern Rooms and Amenities: The Holiday Inn Express Hotel & Suites London offers stylish rooms with essential amenities such as cable TV, microwave, and refrigerator. Enjoy the convenience of in-room coffee maker and ironing facilities during your stay.
Delicious Breakfast Options: Start your day right with a hot breakfast buffet that includes a variety of options like eggs, bacon, and fresh fruit. The contemporary dining area provides a perfect setting to kick start your morning.
Fitness and Business Facilities: Stay active at the on-site fitness center equipped with cardio machines and catch up on work at the business center with computer, printer, and fax services available for guests.
Book your stay at the London Holiday Inn Express now for a perfect blend of comfort and convenience.
\",\n \"hotelTypeId\": 204,\n \"id\": \"lp34e71\",\n \"latitude\": 37.1127,\n \"longitude\": -84.09816,\n \"main_photo\": \"https://static.cupid.travel/hotels/247786698.jpg\",\n \"name\": \"Holiday Inn Express Hotel & Suites London, an IHG Hotel\",\n \"rating\": 7.8,\n \"reviewCount\": 279,\n \"stars\": 2,\n \"thumbnail\": \"https://static.cupid.travel/hotels/thumbnail/247786698.jpg\",\n \"zip\": \"40741\"\n },\n {\n \"accessibilityAttributes\": {\n \"attributes\": null,\n \"distanceFromTheElevatorToTheAccessibleRoom\": 0,\n \"entranceDoorWidth\": 0,\n \"entranceType\": null,\n \"petFriendly\": \"\",\n \"rampAngle\": 0,\n \"rampLength\": 0,\n \"roomMaxGuestsNumber\": 0,\n \"showerChair\": null\n },\n \"address\": \"870 State Route 42 NE\",\n \"chain\": \"Not Available\",\n \"city\": \"London\",\n \"country\": \"us\",\n \"currency\": \"USD\",\n \"deletedAt\": null,\n \"facilityIds\": [\n 2083,\n 16,\n 109,\n 4,\n 25,\n 108,\n 497,\n 540,\n 584,\n 675,\n 720,\n 761,\n 857\n ],\n \"hotelDescription\": \"Convenient Location
Located near local attractions and easily accessible from I-70, FairBridge Inn Express London is the perfect base for exploring London, Ohio.
Modern Amenities
Enjoy complimentary freshly brewed coffee in the lobby each morning and stay connected with Wi-Fi access throughout the hotel.
Comfortable Stay
Unwind in spacious guestrooms equipped with expanded cable TV and complimentary local calls, ensuring a relaxing end to your day.
Book your stay at FairBridge Inn Express London now for a memorable and convenient experience!
\",\n \"hotelTypeId\": 205,\n \"id\": \"lp317c3\",\n \"latitude\": 39.95152,\n \"longitude\": -83.38106,\n \"main_photo\": \"https://static.cupid.travel/hotels/200701865.jpg\",\n \"name\": \"FairBridge Inn Express London\",\n \"rating\": 4.8,\n \"reviewCount\": 129,\n \"stars\": 2,\n \"thumbnail\": \"https://static.cupid.travel/hotels/thumbnail/200701865.jpg\",\n \"zip\": \"43140\"\n },\n {\n \"accessibilityAttributes\": {\n \"attributes\": null,\n \"distanceFromTheElevatorToTheAccessibleRoom\": 0,\n \"entranceDoorWidth\": 0,\n \"entranceType\": null,\n \"petFriendly\": \"\",\n \"rampAngle\": 0,\n \"rampLength\": 0,\n \"roomMaxGuestsNumber\": 0,\n \"showerChair\": null\n },\n \"address\": \"110 Melcon Ln\",\n \"chain\": \"Red Roof Inn\",\n \"chainId\": 1839,\n \"city\": \"London\",\n \"country\": \"us\",\n \"currency\": \"USD\",\n \"deletedAt\": null,\n \"facilityIds\": [\n 2083,\n 16,\n 109,\n 28,\n 4,\n 48,\n 49,\n 81,\n 64,\n 25,\n 108,\n 127,\n 185,\n 211,\n 455,\n 451,\n 449,\n 462,\n 457,\n 461,\n 425,\n 459,\n 465,\n 468,\n 422,\n 456,\n 452,\n 424,\n 458,\n 486,\n 464,\n 418,\n 421,\n 487,\n 521,\n 540,\n 568,\n 584,\n 630,\n 714,\n 720,\n 761,\n 784,\n 857,\n 859,\n 916,\n 1005\n ],\n \"hotelDescription\": \"Welcome to The Red Roof Inn – London!
Gazebo, Picnic Area, and BBQ Facilities: Enjoy outdoor gatherings with our gazebo, picnic area, and barbecue facilities.
In-Room Amenities: Relax in our rooms equipped with a flat-screen TV, cable, radio/alarm clock, small refrigerator, and coffee maker.
Convenience and Accessibility: Benefit from our 24-hour front desk, banquet facilities, vending machines, and free parking.
Experience the best of London, KY, with a stay at The Red Roof Inn. Book now for an unforgettable stay!
\",\n \"hotelTypeId\": 205,\n \"id\": \"lp24caf\",\n \"latitude\": 37.14461,\n \"longitude\": -84.10855,\n \"main_photo\": \"https://static.cupid.travel/hotels/403478343.jpg\",\n \"name\": \"Red Roof Inn London I-75\",\n \"rating\": 8.6,\n \"reviewCount\": 439,\n \"stars\": 2,\n \"thumbnail\": \"https://static.cupid.travel/hotels/thumbnail/403478343.jpg\",\n \"zip\": \"40741\"\n },\n {\n \"accessibilityAttributes\": {\n \"attributes\": null,\n \"distanceFromTheElevatorToTheAccessibleRoom\": 0,\n \"entranceDoorWidth\": 0,\n \"entranceType\": null,\n \"petFriendly\": \"\",\n \"rampAngle\": 0,\n \"rampLength\": 0,\n \"roomMaxGuestsNumber\": 0,\n \"showerChair\": null\n },\n \"address\": \"105 Melcon Hill Dr\",\n \"chain\": \"Econo Lodge\",\n \"chainId\": 1128,\n \"city\": \"London\",\n \"country\": \"us\",\n \"currency\": \"USD\",\n \"deletedAt\": null,\n \"facilityIds\": [\n 2083,\n 16,\n 109,\n 301,\n 4,\n 48,\n 81,\n 25,\n 63,\n 143,\n 185,\n 195,\n 200,\n 455,\n 451,\n 449,\n 462,\n 457,\n 461,\n 459,\n 467,\n 460,\n 465,\n 468,\n 422,\n 456,\n 452,\n 466,\n 453,\n 424,\n 486,\n 464,\n 488,\n 485,\n 420,\n 463,\n 521,\n 540,\n 630,\n 675,\n 720,\n 761,\n 784,\n 857,\n 859,\n 916,\n 989,\n 1005\n ],\n \"hotelDescription\": \"Convenient Amenities
Enjoy our outdoor pool, free Wi-Fi, and in-room microwave and refrigerator for added comfort during your stay.
Deluxe Continental Breakfast
Start your day right with our complimentary breakfast, served fresh every morning to kickstart your adventures in London, Kentucky.
Nearby Attractions
Explore Levi Jackson Wilderness Road State Park, Saint Joseph-London Hospital, and more just a short drive away from Econo Lodge London.
Book now for a relaxing and enjoyable stay at Econo Lodge London, where convenience meets comfort.
\",\n \"hotelTypeId\": 221,\n \"id\": \"lp1eb86\",\n \"latitude\": 37.14472,\n \"longitude\": -84.10807,\n \"main_photo\": \"https://static.cupid.travel/hotels/570050452.jpg\",\n \"name\": \"Econo Lodge\",\n \"rating\": 5.3,\n \"reviewCount\": 74,\n \"stars\": 2,\n \"thumbnail\": \"https://static.cupid.travel/hotels/thumbnail/570050452.jpg\",\n \"zip\": \"40741\"\n },\n {\n \"accessibilityAttributes\": {\n \"attributes\": null,\n \"distanceFromTheElevatorToTheAccessibleRoom\": 0,\n \"entranceDoorWidth\": 0,\n \"entranceType\": null,\n \"petFriendly\": \"\",\n \"rampAngle\": 0,\n \"rampLength\": 0,\n \"roomMaxGuestsNumber\": 0,\n \"showerChair\": null\n },\n \"address\": \"1918 Highway 192 W\",\n \"chain\": \"Comfort Suites\",\n \"chainId\": 1121,\n \"city\": \"London\",\n \"country\": \"us\",\n \"currency\": \"USD\",\n \"deletedAt\": null,\n \"facilityIds\": [\n 2083,\n 6848,\n 16,\n 109,\n 301,\n 3,\n 28,\n 48,\n 108,\n 195,\n 455,\n 449,\n 457,\n 425,\n 459,\n 468,\n 422,\n 456,\n 466,\n 488,\n 487,\n 540,\n 584,\n 630,\n 675,\n 720,\n 757,\n 761,\n 857,\n 916\n ],\n \"hotelDescription\": \"Modern Accommodation with Convenient Amenities
At Comfort Suites London, guests can enjoy a comfortable stay in modern rooms equipped with essential amenities. The hotel's fitness centre is perfect for those looking to stay active during their travels, while the on-site restaurant and bar provide convenient dining options. With a 24-hour front desk and free WiFi, guests can expect excellent service and connectivity throughout their stay.
Nearby Attractions and Easy Access
Conveniently located just 15 km from Laurel River Lake, guests have easy access to outdoor recreational activities. Additionally, the proximity to attractions like Harland Sanders Cafe and Museum, Holly Bay Marina, and Kentucky Music Hall of Fame and Museum offers guests plenty of options for exploration and entertainment.
Non-Smoking Property with Free Parking
For a hassle-free experience, Comfort Suites London is a non-smoking property with free private parking. Guests can relax knowing their vehicles are secure while they explore the nearby sights. Book your stay now and experience comfort and convenience at Comfort Suites London.
\",\n \"hotelTypeId\": 204,\n \"id\": \"lp1ff92\",\n \"latitude\": 37.11038,\n \"longitude\": -84.09576,\n \"main_photo\": \"https://static.cupid.travel/hotels/169794442.jpg\",\n \"name\": \"Comfort Suites\",\n \"rating\": 6.9,\n \"reviewCount\": 140,\n \"stars\": 3,\n \"thumbnail\": \"https://static.cupid.travel/hotels/thumbnail/169794442.jpg\",\n \"zip\": \"40741\"\n }\n ],\n \"per_page\": 20,\n \"total_hotels\": 10,\n \"total_pages\": 1\n}"}],"_postman_id":"17feb79e-1783-4932-a820-1842a8dd9397"},{"name":"hotels/hotel_details","id":"be7a2e0a-e1e6-4374-8645-58a1cf19ed4a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"{{baseUrl}}/hotels/hotel_details?hotel_id=lp67890","description":"This endpoint retrieves the details of a specific hotel identified by the provided hotel ID. The response is in JSON format and includes various details such as address, airport code, check-in and check-out times, facilities, hotel images, location coordinates, room details, sentiment analysis, star rating, and more.
\n{\n \"address\": \"\",\n \"airportCode\": \"\",\n \"chain\": \"\",\n \"chainId\": 0,\n \"checkinCheckoutTimes\": {\n \"checkin\": \"\",\n \"checkinEnd\": \"\",\n \"checkinStart\": \"\",\n \"checkout\": \"\"\n },\n \"childAllowed\": true,\n \"city\": \"\",\n \"country\": \"\",\n \"email\": \"\",\n \"facilities\": [\n {\n \"facilityId\": 0,\n \"name\": \"\"\n }\n ],\n \"fax\": \"\",\n \"groupRoomMin\": 0,\n \"hotelDescription\": \"\",\n \"hotelFacilities\": [\"\"],\n \"hotelImages\": [\n {\n \"caption\": \"\",\n \"defaultImage\": true,\n \"order\": 0,\n \"url\": \"\",\n \"urlHd\": \"\"\n }\n ],\n \"hotelImportantInformation\": \"\",\n \"hotelType\": \"\",\n \"hotelTypeId\": 0,\n \"id\": \"\",\n \"location\": {\n \"latitude\": 0,\n \"longitude\": 0\n },\n \"main_photo\": \"\",\n \"name\": \"\",\n \"parking\": \"\",\n \"petsAllowed\": true,\n \"phone\": \"\",\n \"policies\": [\n {\n \"child_allowed\": \"\",\n \"description\": \"\",\n \"name\": \"\",\n \"parking\": \"\",\n \"pets_allowed\": \"\",\n \"policy_type\": \"\"\n }\n ],\n \"rating\": 0,\n \"reviewCount\": 0,\n \"rooms\": [\n {\n \"bedTypes\": [\n {\n \"bedSize\": \"\",\n \"bedType\": \"\",\n \"quantity\": 0\n }\n ],\n \"description\": \"\",\n \"hotelId\": \"\",\n \"id\": 0,\n \"maxAdults\": 0,\n \"maxChildren\": 0,\n \"maxOccupancy\": 0,\n \"photos\": [\n {\n \"classId\": 0,\n \"classOrder\": 0,\n \"failoverPhoto\": \"\",\n \"hd_url\": \"\",\n \"imageClass1\": \"\",\n \"imageClass2\": \"\",\n \"imageDescription\": \"\",\n \"mainPhoto\": true,\n \"score\": 0,\n \"url\": \"\"\n }\n ],\n \"roomAmenities\": [\n {\n \"amenitiesId\": 0,\n \"name\": \"\",\n \"sort\": 0\n }\n ],\n \"roomName\": \"\",\n \"roomSizeSquare\": 0,\n \"roomSizeUnit\": \"\"\n }\n ],\n \"sentiment_analysis\": {\n \"categories\": [\n {\n \"description\": \"\",\n \"name\": \"\",\n \"rating\": 0\n }\n ],\n \"cons\": [\"\"],\n \"pros\": [\"\"]\n },\n \"sentiment_updated_at\": \"\",\n \"starRating\": 0\n}\n\nThis API endpoint makes an HTTP GET request to retrieve a list of recommended hotels based on the provided latitude and longitude.
\nlat (required): The latitude coordinate for the location.
lon (required): The longitude coordinate for the location.
Upon a successful request, the API returns a JSON response with a status code of 200. The response contains an array of hotel objects, each providing details such as address, chain, city, country, currency, facility IDs, hotel description, hotel type ID, ID, latitude, longitude, main photo, name, rating, review count, stars, thumbnail, and zip code.
\nExample Response:
\n{\n \"hotels\": [\n {\n \"address\": \"\",\n \"chain\": \"\",\n \"chainId\": 0,\n \"city\": \"\",\n \"country\": \"\",\n \"currency\": \"\",\n \"facilityIds\": [0],\n \"hotelDescription\": \"\",\n \"hotelTypeId\": 0,\n \"id\": \"\",\n \"latitude\": 0,\n \"longitude\": 0,\n \"main_photo\": \"\",\n \"name\": \"\",\n \"rating\": 0,\n \"reviewCount\": 0,\n \"stars\": 0,\n \"thumbnail\": \"\",\n \"zip\": \"\"\n }\n ]\n}\n\nEndpoints for basic hotel functions in hermex travels
\n","_postman_id":"5a9db77d-6c12-44ed-b30e-a27f1e1f3114"},{"name":"ADV. Hotel Functions","item":[{"name":"hotels/get_rates","id":"e4aabf6b-5e32-405b-927c-9be2f0556dce","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{vault:authorization-secret}}"}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"checkin\": \"2025-04-07\",\r\n \"checkout\": \"2025-04-08\"\r\n ,\r\n \"hotelIds\": [\r\n \"lp2d11e\"\r\n ],\r\n \"occupancies\": [\r\n {\r\n \"adults\": 1,\r\n \"children\": []\r\n }\r\n ],\r\n \"guestNationality\": \"US\",\r\n \"currency\": \"USD\", // Add the currency field here\r\n \"roomMapping\": true\r\n}\r\n","options":{"raw":{"language":"json"}}},"url":"{{baseUrl}}/hotels/get_rates","description":"The GET /get_rates endpoint allows both the frontend and mobile teams to retrieve the rates for hotels based on specified parameters such as hotel IDs, check-in and check-out dates, guest nationality, currency, and occupancy details. The endpoint also applies a markup percentage to the rates to ensure that the returned prices reflect business rules or additional charges. This integration documentation explains how to use this endpoint effectively, including request format, response structure, and common error handling.
URL: /get_rates
Method: POST
Authentication: No authentication required.
\nContent-Type: application/json
The request body should be in JSON format with the following required fields:
\nhotelIds (required)Type: Array of strings
\nDescription: List of hotel IDs for which rates need to be fetched.
\nExample: [\"hotel123\", \"hotel456\"]
occupancies (required)Type: Array of objects (can have multiple occupancy configurations)
\nDescription: Contains information about the number of adults and children for each room configuration. The first object will be used if multiple occupancy configurations are not provided.
\nFields:
\nadults (required): The number of adults in the room.
Type: Integer
\nExample: 2
children (optional): A list of children’s ages (optional, required only if children are included).
Type: Array of integers
\nExample: [5, 8]
guestNationality (optional)Type: String
\nDescription: The nationality of the guest (used for filtering special rates based on nationality).
\nDefault: \"US\"
Example: \"GB\"
currency (optional)Type: String
\nDescription: The currency in which the prices will be returned.
\nDefault: \"USD\"
Example: \"EUR\"
{\n \"hotelIds\": [\"hotel123\", \"hotel456\"],\n \"occupancies\": [\n {\n \"adults\": 2,\n \"children\": [5, 8]\n }\n ],\n \"guestNationality\": \"US\",\n \"currency\": \"USD\"\n}\n\nThe response will be in JSON format. If the request is successful, it will return the list of hotel rates, along with any applied markup.
\nStatus Code: 200 OK
Content: A JSON object containing the rates array, which includes the rates for the specified hotels.
{\n \"rates\": [\n {\n \"hotelId\": \"hotel123\",\n \"roomTypes\": [\n {\n \"offerId\": \"offer1\",\n \"rates\": [\n {\n \"adultCount\": 2,\n \"boardName\": \"Room Only\",\n \"retailRate\": {\n \"initialPrice\": [\n {\n \"amount\": 645.15,\n \"currency\": \"USD\"\n }\n ],\n \"total\": [\n {\n \"amount\": 645.15,\n \"currency\": \"USD\"\n }\n ]\n }\n }\n ]\n }\n ]\n }\n ]\n}\n\n{ \"error\": \"hotelIds are required\" }
Description: The hotelIds field is required and cannot be empty.
Response:
\n{ \"error\": \"childAges must be a non-empty list if children are present\" }
Description: If children are present, childAges must be a non-empty list.
Response:
\n{ \"error\": \"No rates found\" }
Description: If no rates are found for the given hotel IDs.
\nResponse:
\n{ \"error\": \"An error occurred. Please try again later.\" }
Description: An unexpected error occurred on the server side.
\nResponse:
\nThe backend applies a markup percentage to the original rates for each hotel. The markup is applied to the initialPrice and the total price:
pythonCopyEditmarkup_price = original_price * (1 + markup_percentage / 100)
\n For instance, if the original price is 100 USD and the markup percentage is 3%, the new price will be 103 USD.
Update in the Response:
The initialPrice and total for each rate are updated to reflect the new price after markup.
The frontend should expect a rates array in the response, which contains the room details and updated pricing.
When displaying the price to the user, ensure that either the initialPrice and total are visible to the user.
Similar to the frontend team, ensure that the UI reflects the updated price.
\nIf any rate details are missing or if there's a specific error, show appropriate messages to users (e.g., \"No rates available for the selected hotels\").
\nDate Ranges: The check-in date is set to 180 days from the current date, and check-out is one day later. These dates are hardcoded in the request and cannot be changed by the client.
\nCurrency Handling: The response will include the currency of the rates, so ensure proper currency formatting on both mobile and web platforms.
\nThis endpoint is essential for retrieving hotel pricing based on specific search criteria, with dynamic price adjustments based on markup. Both frontend and mobile teams should ensure that they properly handle the response, errors, and edge cases, ensuring a smooth user experience.
\nThis HTTP POST request to {{baseUrl}}/hotels/get_rates is used to retrieve the rates for hotels based on the specified check-in and check-out dates, hotel IDs, guest details, and guest nationality. The request payload includes the check-in date, check-out date, hotel IDs, number of adult guests, and guest nationality.
\nThe response to this request is a JSON object with a status code of 200 and a content type of application/json. The response includes rate information for the specified hotels, including hotel ID, room types, offer ID, retail rates, price type, rate type, cancellation policies, occupancy details, and suggested selling price.
\nThis document provides a comprehensive description of the response body containing hotel rates and room types. The data includes details such as room offers, pricing, cancellation policies, commissions, taxes, fees, and other attributes for various hotel room types.
\nHotel ID: Each rate entry is associated with a hotelId.
Room Types: Each hotel can have multiple room types with detailed offers.
\nFor each room type:
\nOffer ID: Unique identifier for the offer.
\nOffer Initial Price: The starting price of the room.
\nOffer Retail Rate: The retail rate of the room.
\nPrice Type: Indicates the pricing model (e.g., commission).
Rate Type: Type of rate (e.g., standard).
Suggested Selling Price: Recommended price for the room.
\nSupplier Information: Includes supplier and supplierId.
Room Type ID: Unique identifier for the room type.
\nEach room type contains detailed rates with:
\nAdult Count: Number of adults accommodated.
\nChild Count: Number of children accommodated.
\nBoard Name and Type: Information on the board offering (e.g., Room Only).
Maximum Occupancy: Maximum number of occupants allowed.
\nCancellation Policies:
\nCancel Policy Info: Contains the cancellation amount, cancel time, currency, and type.
\nHotel Remarks: Additional remarks or conditions provided by the hotel.
\nRefundable Tag: Indicates if the offer is refundable.
\nCommission: The amount of commission included in the pricing.
\nRate ID: Unique identifier for the specific rate.
\nRemarks: Additional comments or notes about the rate.
\nRetail Rate: Includes:
\nInitial Price: Base price of the room.
\nSuggested Selling Price: Recommended price and its source.
\nTaxes and Fees: Detailed breakdown of additional costs (e.g., resort fees, mandatory taxes).
\nTotal: Overall cost including all fees.
\nlp19b5fOffer ID: GE5ESNBSIZKVMQ2QJJNEERSRKIZFMR2OINCVGVCTKNGEURCWKVLEGRKJKZDVKRKXINEEUVK2KZEVGMSPJNFE4RKPJZBFGSKSI5KTIU2TKRFFMR2WKVJEGQSKKZHEMRKSGJFEYRSDIUZFOS2TJM2UKRKLJUZEQSSOJBDEKV2DJBFEMTKVJFKEWTSLJJGFKT2WJJKESUSFKUZFMQ2FJE2UKVSTKJBU4SSWJZDE6U2DIZDU4S2FKNKFGMSMJJCFKU2XJNCUUNKIIZCVMMSJJFKVUVKJKMZE6TCKJVCU6U2TKNFVEQ2VGJIVGWCJGVDVIR2SGJHEUWSOIZDVEMRSJNHEWRJSKRJUWTCCIRKVKTSTIVEU4RKWKVKTESCJIZHEKSKTGJHESSSNIVHVESSTJRBE2VJSKVJVESJVIVKEKVSDIJFFUTSGIVJDEMSHLJCFKV2NGJKEONKGKZGVGU2ZJRDEYRKXKZBVCS2KIZLE2URSKNEVCMSFJ5JVGQSLKJAVMQ2NLJKUSNKFKZKVEQ2SJJKVUVCJKMZFMTCKIRCTEVRSIVFU4SKGINLUWVKKGVDVMVKWGJEUSVJSIVEVKS2OJRFE4RKPK5FVUSKSJJKTEVSDKJFEUSSFKNJFGVSKIZHEMRKSGJBEOSSLIVHVIS2LJNFEGVJSK5JUKSSGI5CVKVKTJBEUKWSGJFJDETSKJJFEMQKVKNFUSVSHKZEVMQSVJE2UKVSTKJBUMSS2IZDEGUS2KVGEMS2FJNKEWU2LJZCFKQ2XJNEUYRSHKZEU4Q2MJJDE2VSJKFFU4TCKJJLECVKKKREVESCVGRJVGVCJGQZEMRKWKNDEWUSOIVEVGMSLJFJEGVCJKNFTES2OIRKUGV2TIVFE4R2FKVKUWSCHKJGFMSKRGJHEWSSBKVHVGSZSJFJEWVJSKFJVEUCRGNKEGTSKJ5DTINCILFGVEUKHJEZFGMSNIJMEMVKZKRCUSQSTI5ETKRCBJVBDER2BLFEFSVKTKB6DCMBVGMYTC7BSPRWHAMJZMI2WM7BSFV6FKU2EPRKVG7BSGAZDKLJQG4WTCNL4GIYDENJNGA3S2MJWPR6DMLRQGA
Offer Initial Price: $710.45 (USD)
\nOffer Retail Rate: $710.45 (USD)
\nSuggested Selling Price: $696.38 (USD) from expedia.com
Supplier: nuitee
Supplier ID: 2
\nRoom Type ID: GUYTILJRGA2TGMJRPRHFERSOPQZDAMRVGAYTCNJRGA2DA7BSPRJDCMBTHF6DMNZQGI2A
Adult Count: 2
\nChild Count: 0
\nBoard Name: Room Only
\nMax Occupancy: 2
\nCancellation Policies:
\nCancel Amount: $710.45
\nCancel Time: 2025-01-15 10:40:00
Refundable Tag: NRFN
Commission: $40.21 (USD)
\nRate ID: I42FUVCPJZBFQR2VGNCESTSSLJDVUVCEIVGUEWCHJUZVIS2OKJNEONBSIRGU4SSTJVGVURCBJVNFER2JLFCE2WKSK5EEKM2HJNHFEWCHJFMUITKNKJLUOVJTIREU2VCEI5EVSRCNJVNFOSCFGNKESTS2LJDUSWKEJ5HFEV2IIUZUIS2OLJMEOSSSKRCU2QSXI5GTGR2NJZNFGR22KNKE2TSKLBDUUNSEINEVUU2HIFNEIS2NIJMEORJSLBMU2USRI5ETEVCBJZNFER22GZDUWM2TG5FVMSSYLFLEWVCQKJFVMR2SIQ2EOSSBKRAVCMZUI5EVURCRJUZTIS2VLJDE2V2EKNIFCWKUJ5GVUV2IIU2EIUKNLJNEOWKZIRJU2VCRJJJESRSVJFNFER2BGJKEOTKKKJCU2MSUINHEETSHIVMUIS2NLJJEORRWIU2FKU2HJJNDMRCFJVBFGR2VLFCEGTKKKZDUKWKEJFGUINCHJI3EMRKNJJIUOTJULBMU4USYI5AVURCJJEZFGSRUKJKTIVKTI5FFSUSUIVGUEU2HKVLVIQKNJJHEORJSKNAU2SSRJBETERCBPQ3TCMBOGQ2XYMRQGI2S2MBXFUYTKIBRGA5DIMB2GAYHYUSP
Taxes and Fees:
\nResort: $25.76 (USD)
\nResort: $4.24 (USD)
\nTotal: $710.45 (USD)
\n(Similar details structured as above)
\nTaxes and fees vary based on the room type and location.
\nRefundable Tag indicates whether the booking is refundable (RFN) or non-refundable (NRFN).
This document reflects an example breakdown and structure for documentation purposes. Adjustments may be made for specific needs.
\nEach subsequent room type includes similar details as outlined above. Use the provided format for documentation consistency.
\n","urlObject":{"path":["hotels","get_rates"],"host":["{{baseUrl}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"e4aabf6b-5e32-405b-927c-9be2f0556dce"},{"name":"hotels/prebook","id":"70dc0616-dfb1-4ec1-bad3-c658fd0778a1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{vault:authorization-secret}}"}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"offerId\":\"GE5ESNKNKRCVEQ2OJJNEMRSPKRFU4R2OJNCVOVCTGJGEMRCWKNGVGVKJKZDVKRKXINEEURK2KVHVIS2PJNJEIVKPK5JVISKSINLFGV2TKRETKQKWKVLEGRCKKZFEMQ2SGIZEWSSDIUZFIMSLJM2UOVSLJUZEKSRVI5LEKVKLJBGEMTSFJFKEWT2KJJGFKT2VJMZESNKEKUZFKU2SJE2U4RSHKZBU4TCKJJDE6VCLKZGEUQ2FINKFGMSLKJCFMVKVGJCUUVSOIZCVMMSOJJCVUVKJKUZE6S2SIRCU6V2KKRGEETKVGJJVGRKJGVCVMU2SINDEUWSGIZBVGQ2GJRDEGRKHJYZEGS2OIRKUGV2TIVFE4R2VIVLVGSCJIZHEKUKXJMZEUUSIKVMU4S2MJNNEIVCPKEZFOSSOJBCE2USKKVFUSWSFGZKUGUSMJJBVKR2UJNCESUSJIZBVOU2FJFLEQVKFKZBVCS2KIZLESUSLK5FU4TKVGZJVEV2JKJBFKNCXKNLESNKDKZJVMQ2QJJLE4RSVKIZEER2OJNCTEVCLINFUMSCGIVJFGV2KKZHEKRKSINEEUVK2IVEVES2PJRFEYRKPKJFVGS2SI5KTIUKTKJEVUS2WKVLEGSSKKZFEMUKSGJLEYRSNIZJVMQ2UJNHEKVSVKNBUSTCGI5LEKVKLJBFEMTSFJFIUWTSKJJEVKT2TJNNESUSBKUZFCU2SJNBESVSTKZBUYRZVIJLEOURSIZGEMS2FK5KEWRKHKJCFKMSNKNCUSRSHKZKVOS2IJFCVUVKJKJFUUR2KJJKVKTSDKNFVKMSGJNKTESCKJJGVMRKWINDEUVSCIZDVEMSKJM2UWRKDKRFUWSS2IRKUGV2TIREUMR2VIVKUWSKKIZGVKSKRJQ2EOTJTKRHU6QSTI5EVQRCJJ5CDIUCSJJCTM7BTGQZDONJRPQZHY3DQGUZWCZDGPQZC27COI5HHYVKTPQZDAMRVFUYDSLJQGF6DEMBSGUWTAOJNGAZHY7BRGEXDAMA\"\r\n}\r\n","options":{"raw":{"language":"json"}}},"url":"{{baseUrl}}/hotels/prebook","description":"POST /prebook
Authorization: Bearer )This endpoint allows a user to prebook a hotel room by providing an offerId. It calculates the total price with a 10% markup, creates a pending booking record in the database, and returns the prebook response along with the booking details.
{\n \"Authorization\": \"Bearer <your_token>\"\n}\n\n{\n \"offerId\": \"string\" // Required, Offer ID of the hotel room\n}\n\n{\n \"data\": {\n \"roomTypes\": [\n {\n \"rates\": [\n {\n \"price\": {\n \"total\": {\n \"amount\": 110.0 // Price with markup\n }\n }\n }\n ]\n }\n ]\n },\n \"booking_id\": \"550e8400-e29b-41d4-a716-446655440000\",\n \"booking_type\": \"HOTEL\",\n \"status\": \"PENDING\",\n \"order_id\": \"Hex_ORDER-21544gbh-5fd-df651df61gdf6\"\n}\n\nMissing offerId (400 Bad Request)
\n{\n \"error\": \"offerId is required\"\n}\n\nInternal Server Error (500 Internal Server Error)
\n{\n \"error\": \"Error message\"\n}\n\nValidates that offerId is provided.
Calls external API (api.prebook()) to prebook the hotel room.
Processes response:
\nRemoves unnecessary commission fields.
Applies a 10% markup to the total price.
\nCreates a pending booking record in the database with:
\nuser_id (extracted from JWT token)
booking_type as HOTEL
status as PENDING
order_id as a unique identifier.
Returns the modified prebook response with additional booking details.
\nEnsure the JWT token is included in the request headers.
\nDisplay the updated total price after markup.
\nUse the booking_id in subsequent payment or booking confirmation requests.
Author: Backend Team 🚀
\n","urlObject":{"path":["hotels","prebook"],"host":["{{baseUrl}}"],"query":[],"variable":[]}},"response":[{"id":"2becff35-9abb-4adb-a460-f808fc970619","name":"hotels/prebook","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"offerId\":\"GE5ESNKNKRCVEQ2OJJNEMRSPKRFU4R2OJNCVOVCTGJGEMRCWKNGVGVKJKZDVKRKXINEEURK2KVHVIS2PJNJEIVKPK5JVISKSINLFGV2TKRETKQKWKVLEGRCKKZFEMQ2SGIZEWSSDIUZFIMSLJM2UOVSLJUZEKSRVI5LEKVKLJBGEMTSFJFKEWT2KJJGFKT2VJMZESNKEKUZFKU2SJE2U4RSHKZBU4TCKJJDE6VCLKZGEUQ2FINKFGMSLKJCFMVKVGJCUUVSOIZCVMMSOJJCVUVKJKUZE6S2SIRCU6V2KKRGEETKVGJJVGRKJGVCVMU2SINDEUWSGIZBVGQ2GJRDEGRKHJYZEGS2OIRKUGV2TIVFE4R2VIVLVGSCJIZHEKUKXJMZEUUSIKVMU4S2MJNNEIVCPKEZFOSSOJBCE2USKKVFUSWSFGZKUGUSMJJBVKR2UJNCESUSJIZBVOU2FJFLEQVKFKZBVCS2KIZLESUSLK5FU4TKVGZJVEV2JKJBFKNCXKNLESNKDKZJVMQ2QJJLE4RSVKIZEER2OJNCTEVCLINFUMSCGIVJFGV2KKZHEKRKSINEEUVK2IVEVES2PJRFEYRKPKJFVGS2SI5KTIUKTKJEVUS2WKVLEGSSKKZFEMUKSGJLEYRSNIZJVMQ2UJNHEKVSVKNBUSTCGI5LEKVKLJBFEMTSFJFIUWTSKJJEVKT2TJNNESUSBKUZFCU2SJNBESVSTKZBUYRZVIJLEOURSIZGEMS2FK5KEWRKHKJCFKMSNKNCUSRSHKZKVOS2IJFCVUVKJKJFUUR2KJJKVKTSDKNFVKMSGJNKTESCKJJGVMRKWINDEUVSCIZDVEMSKJM2UWRKDKRFUWSS2IRKUGV2TIREUMR2VIVKUWSKKIZGVKSKRJQ2EOTJTKRHU6QSTI5EVQRCJJ5CDIUCSJJCTM7BTGQZDONJRPQZHY3DQGUZWCZDGPQZC27COI5HHYVKTPQZDAMRVFUYDSLJQGF6DEMBSGUWTAOJNGAZHY7BRGEXDAMA\"\r\n}\r\n","options":{"raw":{"language":"json"}}},"url":"{{baseUrl}}/hotels/prebook"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Sun, 23 Mar 2025 18:44:55 GMT","enabled":true},{"key":"Content-Type","value":"application/json","enabled":true},{"key":"Transfer-Encoding","value":"chunked","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true},{"key":"cf-cache-status","value":"DYNAMIC","enabled":true},{"key":"Report-To","value":"{\"endpoints\":[{\"url\":\"https:\\/\\/a.nel.cloudflare.com\\/report\\/v4?s=%2B5%2FHBITkhvOGk2Uo8T1vIFbbM6ex5aTQznrVk1mKIUfSRyeuna%2Bz9hFVgwT6tTCt1ONbwRCRAq4ukEqYRaiOjd%2FEo4TBTDeJhuwlG4TdKmSRbFSrdcxipBYfXh3UJ2FemQEfOVxOwJ%2FL0sTN\"}],\"group\":\"cf-nel\",\"max_age\":604800}","enabled":true},{"key":"NEL","value":"{\"success_fraction\":0,\"report_to\":\"cf-nel\",\"max_age\":604800}","enabled":true},{"key":"Server","value":"cloudflare","enabled":true},{"key":"CF-RAY","value":"925015286803d1fd-LHR","enabled":true},{"key":"Content-Encoding","value":"br","enabled":true},{"key":"alt-svc","value":"h3=\":443\"; ma=86400","enabled":true},{"key":"server-timing","value":"cfL4;desc=\"?proto=TCP&rtt=161013&min_rtt=159401&rtt_var=63000&sent=5&recv=6&lost=0&retrans=0&sent_bytes=2824&recv_bytes=2356&delivery_rate=24375&cwnd=252&unsent_bytes=0&cid=0d2db7a1f8c52195&ts=2269&x=0\"","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"booking_id\": \"8baf3e8d-e6eb-4081-9fe8-b729006d5fa1\",\n \"order_id\": \"HeX_ORDER-2fccb852-c-1742755495\",\n \"prebook_response\": {\n \"data\": {\n \"boardChanged\": false,\n \"cancellationChanged\": false,\n \"commission\": 34.48,\n \"currency\": \"USD\",\n \"hotelId\": \"lp53adf\",\n \"isPackageRate\": null,\n \"offerId\": \"GE5ESNKNKRCVEQ2OJJNEMRSPKRFU4R2OJNCVOVCTGJGEMRCWKNGVGVKJKZDVKRKWGJHEUVK2KVEVCMSPJRFEUVKPK5FFIS2SI5KTIU2TLFETKRKWKVJEGQSKKZHEMRKSGJFEYRSDIUZFOS2TJM2UKRKLJUZEQSSOJBDEKV2DJBFEMTKVJFKEWTSLJJGFKT2WJJKESUSFKUZFKU2SJE2U2VCHKZBVASS2IZDE6URSKZDU4S2FJ5KFGMSLKZCFISKXKNCUUVSOIZCVMMSOJRCVUVKPKNFFQSKKJJCUWVCLGJEVEQKVGJKVGV2JGVAVISKWINCEUNKDIREVEMSKJRDEGRKLKRJUWS2GIVCUWV2LKVFU2M2VJFJFGT2MJJEUMTKTGJLEOTJSIVLVMU2LJRBE2VSNKMZFKSSGJJCE2USDIZFUMRSGINJUWT2HLJBUKS2UJNJUYRSEKU2E4U2HJJHEOVSHKYZE2SKKJZCVCV2LJZFEUTKFJ5KUWMSJKJDVKNSTKNJEUQSDKREVEQ2IJI2UERSRKIZE6TCGINKUWTSDKVFFEQ2VGJLVGVKKIZDVMRKXINEEWVSNKZDVEMSOJRFESVKPJZBVQS2SIRKTIUKTKRETIMSEIVLEGRCHGVBFKNSTGJFUSUSDKREU4MSDJNFEKRKLJUZEKS2OI5KVKVJSJBFFMTKWJFITETSJJJEVKT2RKJLUSUSDKRHVCMSUJE2UGVSTKZBUYSSWINCESURSJZGEMS2FJ5KFGS2LJJBVKNCTKNDEOWSFKRCVIMSMJJFEGRKLJZBUUTCKJJCVCUSKKREVESSVLFJVGU2JGVCVMT2WINEEUVSGIVBVEMSGJRDEGRSLKRFUGS2GGZCEOTSCLBDFSNCUKM3UEUSIIUZUIU2MJJJEOSKXKRDU2SSBI5CVSRCVJVBFCSCJLFCECN2DKNFDI7BTGQZDONJRPQZHY3DQGUZWCZDGPQZC27CVKNCHYVKTPQZDAMRVFUYDSLJRHB6DEMBSGUWTAOJNGE4XY7BRGEXDAMA\",\n \"prebookId\": \"B1FvkfX2D\",\n \"price\": 347.99,\n \"priceDifferencePercent\": 0,\n \"priceType\": \"commission\",\n \"roomTypes\": [\n {\n \"rates\": [\n {\n \"adultCount\": 2,\n \"boardName\": \"Room Only\",\n \"boardType\": \"RO\",\n \"cancellationPolicies\": {\n \"cancelPolicyInfos\": [\n {\n \"amount\": 347.99,\n \"cancelTime\": \"1969-12-31 10:00:00\",\n \"currency\": \"USD\",\n \"timezone\": \"GMT\",\n \"type\": \"amount\"\n }\n ],\n \"hotelRemarks\": [],\n \"refundableTag\": \"NRFN\"\n },\n \"childCount\": 0,\n \"maxOccupancy\": 2,\n \"name\": \"Deluxe Larger 1 King Bed Guestroom - Room Only\",\n \"occupancyNumber\": 1,\n \"priceType\": \"commission\",\n \"rateId\": \"I5MTERCNJZFFOTKNGNKEWTS2LFDVSMSUIVGUEV2NJUZUIQ2OLJJUOWJTKRGU4SSYI5EVURCBJVNFER2JLFCE2WKSK5EEKM2HJNHFEWCHJFMUITKNKJLUOVJTIREU2USRI5MTGVCPJZFFOR2VGNKEOTS2KVDTIWSEJVNFEV2NLEZUOSJXIJJEKTK2IRAU2USWI5ATIVCDJ5CDIR2JLFCEKTSKKFEEKWKUKM3UIRSOLJIFMS2VGM2EWVSKLBMVMS2UJFJDMRCFKFFFCSKOGZCEKTKSLFDU4NSGJNGVGV2MIJNEQWKNJJMEOUK2IRGU6SSRJBCTIRCHJ5BFQR2OLFCUKNCUJRCU2WSUJFGVEWCHKVMVGR2NLJIUONCXKRDU4QSTI42DEVCDG5BU6S2KIRCTIN2CKJEEKM2EKNGUUU2HJVMVIQ2NIJIUOQRWIRCTOQ2TI5CVSVCLJVCDIR2NLFKEOTSKKJCU4SSFGZETET2LJJCEKNCJLJJEQRJTIRJUYSSSI5EVOVCHJVFECR2FLFCFKTKCKF6DGNBXFY4TS7BRHE3DSLJRGIWTGMJAGEYDUMBQHIYDA7CSJ4\",\n \"remarks\": \"\",\n \"retailRate\": {\n \"initialPrice\": null,\n \"suggestedSellingPrice\": [\n {\n \"amount\": 360.53,\n \"currency\": \"USD\",\n \"source\": \"\"\n }\n ],\n \"taxesAndFees\": [\n {\n \"amount\": 60.9,\n \"currency\": \"USD\",\n \"description\": \"Tax Recovery Charges & Service Fees\",\n \"included\": true\n },\n {\n \"amount\": 59.62,\n \"currency\": \"USD\",\n \"description\": \"Resort Fee per Night\",\n \"included\": false\n }\n ],\n \"total\": [\n {\n \"amount\": 347.99,\n \"currency\": \"USD\"\n }\n ]\n }\n }\n ]\n }\n ],\n \"suggestedSellingPrice\": 360.53,\n \"supplier\": \"nuitee\",\n \"supplierId\": 2,\n \"termsAndConditions\": \"\"\n },\n \"status\": \"success\"\n }\n}"}],"_postman_id":"70dc0616-dfb1-4ec1-bad3-c658fd0778a1"},{"name":"hotels/book","id":"3912661f-4213-435e-bc36-9d2bcdc7d248","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{vault:authorization-secret}}"}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"prebookId\": \"JkBsBqh2G\",\r\n \"hotel_id\": \"lp4b056\",\r\n \"tx_ref\": \"HeX_TX-250408574A0A0\",\r\n \"order_id\": \"HeX_#-250408147151\",\r\n \"holder\": {\r\n \"firstName\": \"Elmo-eras\",\r\n \"lastName\": \"Tayviah\",\r\n \"email\": \"boronicle@gmail.com\"\r\n },\r\n \"payment\": {\r\n \"method\": \"ACC_CREDIT_CARD\" // Add the correct payment method\r\n },\r\n \"guests\": [\r\n {\r\n \"firstName\": \"John\",\r\n \"lastName\": \"Doe\",\r\n \"email\": \"john.doe@example.com\",\r\n \"occupancyNumber\": 1, // Make sure to include this field\r\n \"remarks\": \"quiet room please\" // Optional, if available\r\n }\r\n ]\r\n}\r\n","options":{"raw":{"language":"json"}}},"url":"{{baseUrl}}/hotels/book","description":"StartFragment
\nThis document outlines the usage of the /book API endpoint for processing hotel bookings. This endpoint handles the final booking confirmation, payment processing, and storing booking details.
URL: /hotels/book
Method: POST
Authentication: JWT Token Required (sent in the Authorization header)
Content-Type: application/json
The following fields are required:
\njsonCopy
\n{\n \"prebookId\": \"W-FX0j2QA\",\n \"hotel_id\": \"lp53adf\",\n \"order_id\": \"HeX_ORDER-87578a5a-1-1742834873\",\n \"holder\": {\n \"firstName\": \"Elmo-eras\",\n \"lastName\": \"Tayviah\",\n \"email\": \"boronicle@gmail.com\"\n },\n \"payment\": {\n \"method\": \"ACC_CREDIT_CARD\" // Add the correct payment method\n },\n \"guests\": [\n {\n \"firstName\": \"John\",\n \"lastName\": \"Doe\",\n \"email\": \"john.doe@example.com\",\n \"occupancyNumber\": 1, // Make sure to include this field\n \"remarks\": \"quiet room please\" // Optional, if available\n }\n ]\n}\n\n{\n \"data\": {\n \"bookedRooms\": [\n {\n \"adults\": 2,\n \"boardName\": \"Room Only\",\n \"boardType\": \"RO\",\n \"children\": 0,\n \"firstName\": \"John\",\n \"lastName\": \"Doe\",\n \"rate\": {\n \"retailRate\": {\n \"total\": {\n \"amount\": 392429.37,\n \"currency\": \"NGN\"\n }\n }\n },\n \"roomType\": {\n \"name\": \"Test rate\"\n }\n }\n ],\n \"bookingId\": \"DHk07vZXZ\",\n \"cancellationPolicies\": {\n \"cancelPolicyInfos\": [\n {\n \"amount\": 353539.98,\n \"cancelTime\": \"2025-09-06 23:59:59\",\n \"currency\": \"USD\",\n \"timezone\": \"GMT\",\n \"type\": \"amount\"\n }\n ],\n \"hotelRemarks\": null,\n \"refundableTag\": \"RFN\"\n },\n \"checkin\": \"2025-09-06\",\n \"checkout\": \"2025-09-07\",\n \"clientReference\": \"\",\n \"commission\": 38889.39,\n \"createdAt\": \"2025-03-26T13:37:47\",\n \"currency\": \"NGN\",\n \"holder\": {\n \"email\": \"boronicle@gmail.com\",\n \"firstName\": \"Elmo-eras\",\n \"lastName\": \"Tayviah\",\n \"phone\": \"\"\n },\n \"hotel\": {\n \"hotelId\": \"lp53adf\",\n \"name\": \"\"\n },\n \"hotelConfirmationCode\": \"test\",\n \"knowBeforeYouGo\": \"Know before you go\",\n \"mandatoryFees\": \"Mandatory fees\",\n \"optionalFees\": \"Optional fees\",\n \"price\": 392429.37,\n \"remarks\": \"Remarks sandbox\",\n \"specialRemarks\": \"Example special remarks\",\n \"status\": \"CONFIRMED\",\n \"supplier\": \"nuitee\",\n \"supplierBookingId\": \"DHk07vZXZ\",\n \"supplierBookingName\": \"nuitee\",\n \"supplierId\": 2\n },\n \"message\": \"Hotel booking processed successfully with payment.\"\n}\n\nPrebooking Step:
\nprebookId is obtained from the /prebook endpoint before calling /book.Payment Object:
\npayment object structure must match LiteAPI’s requirements. Consult their documentation for exact fields.Holder/Guests Data:
\nholder must include at least name, email, and phone.
Each guest in guests requires name and surname.
Order ID:
\nbooking_order_id to track the booking status or initiate payment flows.Error Handling:
\nIf a 500 error occurs, prompt the user to retry the booking after some time.
Log the full error response for debugging (e.g., error.message).
Booking Status:
\nPROCESSING. Use the /booking-status endpoint to poll for updates.User selects a hotel and room, then triggers a /prebook request.
Frontend receives a prebookId and displays a confirmation page.
User enters payment details and submits the /book request.
On success, redirect the user to a confirmation page with booking_order_id.
Use booking_order_id to check status or cancel the booking.
Endpoints for advanced hotel functions in hermex travels
\n","_postman_id":"02c543dc-4a37-4158-80d5-e858c55a954d"}],"id":"0d90fa35-bb42-487b-80f1-02010412a622","description":"Endpoints for hotels in hermex travels
\n","_postman_id":"0d90fa35-bb42-487b-80f1-02010412a622"},{"name":"Flights Endpoints","item":[{"name":"PKFares Flights Endpoints","item":[{"name":"flights/pkfare/search","id":"70857288-5281-4efe-ac9b-8731a7a4186e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \n \"search\": {\n \"adults\": 1,\n \"children\": 0,\n \"infants\": 0,\n \"nonstop\": 0,\n \"airline\": \"SQ\",\n \"solutions\": 5,\n \"searchAirLegs\": [\n {\n \"cabinClass\": \"Economy\",\n \"departureDate\": \"2024-12-15\",\n \"destination\": \"BKK\",\n \"origin\": \"HKG\",\n \"airline\": \"SQ\"\n },\n {\n \"cabinClass\": \"Economy\",\n \"departureDate\": \"2024-12-17\",\n \"destination\": \"HKG\",\n \"origin\": \"BKK\",\n \"airline\": \"SQ\"\n }\n ]\n }\n}\n","options":{"raw":{"language":"json"}}},"url":"{{baseUrl}}/flights/pkfare/search","urlObject":{"path":["flights","pkfare","search"],"host":["{{baseUrl}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"70857288-5281-4efe-ac9b-8731a7a4186e"},{"name":"flights/pkfare/precisepricing","id":"6be0e47d-6deb-40c0-839c-941b4feb9965","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \n \"pricing\": {\n \"adults\": 1,\n \"children\": 0,\n \"infants\": 1,\n \"solutionId\": \"1\",\n \"journeys\": {\n \"journey_0\": [{\n \"airline\": \"SA\",\n \"arrival\": \"JNB\",\n \"arrivalDate\": \"2025-11-20\",\n \"arrivalTime\": \"07:45\",\n \"bookingCode\": \"N\",\n \"departure\": \"CPT\",\n \"departureDate\": \"2025-11-20\",\n \"departureTime\": \"05:45\",\n \"flightNum\": \"378\"\n }]\n }\n }\n} ","options":{"raw":{"language":"json"}}},"url":"{{baseUrl}}/flights/pkfare/precisepricing","urlObject":{"path":["flights","pkfare","precisepricing"],"host":["{{baseUrl}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"6be0e47d-6deb-40c0-839c-941b4feb9965"},{"name":"flights/pkfare/ancillarypricing","id":"f93eb66e-45c2-4869-bb03-5d24ed1e5d0b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"authentication\": {\n \"partnerId\": \"pQC4cn5nhgyUodlm+3tXKT/nduw=\",\n \"sign\": \"aac36a9b4a1ebfa12c9bf3f81fffdc\"\n },\n \"pricing\": {\n \"solutionId\": \"1\",\n \"ancillary\": [1, 2],\n \"adults\": 2,\n \"children\": 1,\n \"journeys\": {\n \"journey_0\": [\n {\n \"airline\": \"VJ\",\n \"flightNum\": \"896\",\n \"departure\": \"DEL\",\n \"departureDate\": \"2023-11-30\",\n \"departureTime\": \"00:05\",\n \"arrival\": \"SGN\",\n \"arrivalDate\": \"2023-11-30\",\n \"arrivalTime\": \"06:20\",\n \"bookingCode\": \"I\"\n }\n ]\n }\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{baseUrl}}/flights/pkfare/ancillarypricing","urlObject":{"path":["flights","pkfare","ancillarypricing"],"host":["{{baseUrl}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"f93eb66e-45c2-4869-bb03-5d24ed1e5d0b"},{"name":"flights/pkfare/ancillarybooking","id":"42daac86-fb26-42d1-b1a8-69632ae35629","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"airOrderNum\": \"917049521951368301\",\n \"ancillaryBooking\": {\n \"baggages\": [\n {\n \"passenger\": {\n \"birthday\": \"2003-03-23\",\n \"firstName\": \"XiaoJun\",\n \"lastName\": \"Zhong\",\n \"psgType\": \"ADT\"\n },\n \"baggageDetails\": [\n {\n \"ancillaryKey\": \"38781f820e9ee25737d7b313410b5317\"\n },\n {\n \"ancillaryKey\": \"2781c40741271185391c4ef5dab51df5\"\n }\n ]\n }\n ]\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{baseUrl}}/flights/pkfare/ancillarybooking","urlObject":{"path":["flights","pkfare","ancillarybooking"],"host":["{{baseUrl}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"42daac86-fb26-42d1-b1a8-69632ae35629"},{"name":"flights/pkfare/precisebooking","id":"5ae0f76c-02c4-450c-9b68-9a03ab17c1c5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"booking\": {\n \"solutionId\": \"YOUR_SOLUTION_ID\",\n \"passengers\": [\n {\n \"psgType\": \"ADT\",\n \"firstName\": \"John\",\n \"lastName\": \"Doe\",\n \"birthday\": \"1990-01-01\",\n \"nationality\": \"US\",\n \"cardType\": \"P\",\n \"cardNum\": \"A12345678\",\n \"cardExpiredDate\": \"2030-01-01\"\n }\n ],\n \"journeys\": { // ADD THIS SECTION\n \"journey_0\": [\n {\n \"airline\": \"FD\",\n \"flightNum\": \"501\",\n \"arrival\": \"DMK\",\n \"arrivalDate\": \"2024-12-15\",\n \"arrivalTime\": \"16:40\",\n \"departure\": \"HKG\",\n \"departureDate\": \"2024-12-15\",\n \"departureTime\": \"14:40\",\n \"bookingCode\": \"Z\"\n }\n ],\n \"journey_1\": [\n {\n \"airline\": \"FD\",\n \"flightNum\": \"504\",\n \"arrival\": \"HKG\",\n \"arrivalDate\": \"2024-12-30\",\n \"arrivalTime\": \"19:15\",\n \"departure\": \"DMK\",\n \"departureDate\": \"2024-12-30\",\n \"departureTime\": \"15:30\",\n \"bookingCode\": \"A\"\n }\n ]\n },\n \"ancillary\": {\n \"baggage\": [\n {\n \"ancillaryKey\": \"BAG123\",\n \"payBaggageType\": 1,\n \"baggageWeight\": \"20KG\"\n }\n ],\n \"seat\": [\n {\n \"ancillaryKey\": \"SEAT456\",\n \"seatName\": \"12A\"\n }\n ]\n }\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{baseUrl}}/flights/pkfare/precisebooking","urlObject":{"path":["flights","pkfare","precisebooking"],"host":["{{baseUrl}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"5ae0f76c-02c4-450c-9b68-9a03ab17c1c5"},{"name":"flights/pkfare/orderpricing","id":"47f819a2-f936-41e8-b1d3-282a1c0cad76","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \n \"orderPricing\": {\n \"orderNum\": 1012694529\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{baseUrl}}/flights/pkfare/orderpricing","urlObject":{"path":["flights","pkfare","orderpricing"],"host":["{{baseUrl}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"47f819a2-f936-41e8-b1d3-282a1c0cad76"},{"name":"flights/pkfare/ticketing","id":"0deb4c80-e42a-4b74-9fb4-3b15c8094fd2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"ticketing\": {\n \"orderNum\": \"1012674912\",\n \"pnr\": \"KHZ1WU\",\n \"name\": \"Jango/Wang\",\n \"email\": \"jango.wang@gongfutrip.com\",\n \"telNum\": \"13249073855\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{baseUrl}}/flights/pkfare/ticketing","urlObject":{"path":["flights","pkfare","ticketing"],"host":["{{baseUrl}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"0deb4c80-e42a-4b74-9fb4-3b15c8094fd2"},{"name":"flights/pkfare/ticket-issuance-notify","id":"36c019d0-212a-4636-b06e-3b38ab11af8c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"airPnr\": \"15CUCZ|25CUCZ\",\n \"orderNum\": \"916716911545376001\",\n \"status\": \"ISSUED\",\n \"passengers\": [\n {\n \"passengerIndex\": 1,\n \"ticketNum\": \"1T9LO2\",\n \"psgType\": \"ADT\"\n },\n {\n \"passengerIndex\": 3,\n \"ticketNum\": \"3T9LO2\",\n \"psgType\": \"INF\",\n \"associatedPassengerIndex\": 1\n }\n ],\n \"pnrList\": [\n {\n \"segmentNo\": 1,\n \"ticketNums\": []\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"{{baseUrl}}/flights/pkfare/ticket-issuance-notify","urlObject":{"path":["flights","pkfare","ticket-issuance-notify"],"host":["{{baseUrl}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"36c019d0-212a-4636-b06e-3b38ab11af8c"}],"id":"64e47be3-06bc-419f-a383-b7969284889a","_postman_id":"64e47be3-06bc-419f-a383-b7969284889a","description":""},{"name":"Amadues Flights Endpoints","item":[{"name":"ADV. flight Functions","item":[{"name":"Flight Order management","item":[{"name":"/flight_order/The API endpoint sends a JSON response with the following schema:
\n{\n \"associatedRecords\": [\n {\n \"flightOfferId\": \"\",\n \"originSystemCode\": \"\",\n \"reference\": \"\"\n }\n ],\n \"contacts\": [\n {\n \"purpose\": \"\"\n }\n ],\n \"flightOffers\": [\n {\n \"id\": \"\",\n \"itineraries\": [\n {\n \"segments\": [\n {\n \"aircraft\": {\n \"code\": \"\"\n },\n \"arrival\": {\n \"at\": \"\",\n \"iataCode\": \"\",\n \"terminal\": \"\"\n },\n \"bookingStatus\": \"\",\n \"carrierCode\": \"\",\n \"co2Emissions\": [\n {\n \"cabin\": \"\",\n \"weight\": 0,\n \"weightUnit\": \"\"\n }\n ],\n \"departure\": {\n \"at\": \"\",\n \"iataCode\": \"\",\n \"terminal\": \"\"\n },\n \"duration\": \"\",\n \"id\": \"\",\n \"isFlown\": true,\n \"number\": \"\",\n \"numberOfStops\": 0,\n \"segmentType\": \"\"\n }\n ]\n }\n ],\n \"lastTicketingDate\": \"\",\n \"nonHomogeneous\": true,\n \"price\": {\n \"base\": \"\",\n \"currency\": \"\",\n \"grandTotal\": \"\",\n \"total\": \"\"\n },\n \"pricingOptions\": {\n \"fareType\": [\"\"]\n },\n \"source\": \"\",\n \"travelerPricings\": [\n {\n \"fareDetailsBySegment\": [\n {\n \"cabin\": \"\",\n \"class\": \"\",\n \"fareBasis\": \"\",\n \"includedCheckedBags\": {\n \"quantity\": 0\n },\n \"segmentId\": \"\"\n }\n ],\n \"price\": {\n \"base\": \"\",\n \"currency\": \"\",\n \"taxes\": [\n {\n \"amount\": \"\",\n \"code\": \"\"\n }\n ],\n \"total\": \"\"\n },\n \"travelerId\": \"\",\n \"travelerType\": \"\"\n }\n ],\n \"type\": \"\",\n \"validatingAirlineCodes\": [\"\"]\n }\n ],\n \"id\": \"\",\n \"queuingOfficeId\": \"\",\n \"remarks\": {\n \"general\": [\n {\n \"flightOfferIds\": [\"\"],\n \"subType\": \"\",\n \"text\": \"\"\n }\n ]\n },\n \"ticketingAgreement\": {\n \"option\": \"\"\n },\n \"travelers\": [\n {\n \"contact\": {\n \"emailAddress\": \"\",\n \"phones\": [\n {\n \"countryCallingCode\": \"\",\n \"deviceType\": \"\",\n \"number\": \"\"\n }\n ],\n \"purpose\": \"\"\n },\n \"dateOfBirth\": \"\",\n \"documents\": [\n {\n \"documentType\": \"\",\n \"expiryDate\": \"\",\n \"holder\": true,\n \"issuanceCountry\": \"\",\n \"nationality\": \"\",\n \"number\": \"\"\n }\n ],\n \"gender\": \"\",\n \"id\": \"\",\n \"name\": {\n \"firstName\": \"\",\n \"lastName\": \"\"\n }\n }\n ],\n \"type\": \"\"\n}\n\nThe API endpoint sends a JSON response with the following schema:
\n{\n \"associatedRecords\": [\n {\n \"flightOfferId\": \"\",\n \"originSystemCode\": \"\",\n \"reference\": \"\"\n }\n ],\n \"contacts\": [\n {\n \"purpose\": \"\"\n }\n ],\n \"flightOffers\": [\n {\n \"id\": \"\",\n \"itineraries\": [\n {\n \"segments\": [\n {\n \"aircraft\": {\n \"code\": \"\"\n },\n \"arrival\": {\n \"at\": \"\",\n \"iataCode\": \"\",\n \"terminal\": \"\"\n },\n \"bookingStatus\": \"\",\n \"carrierCode\": \"\",\n \"co2Emissions\": [\n {\n \"cabin\": \"\",\n \"weight\": 0,\n \"weightUnit\": \"\"\n }\n ],\n \"departure\": {\n \"at\": \"\",\n \"iataCode\": \"\",\n \"terminal\": \"\"\n },\n \"duration\": \"\",\n \"id\": \"\",\n \"isFlown\": true,\n \"number\": \"\",\n \"numberOfStops\": 0,\n \"segmentType\": \"\"\n }\n ]\n }\n ],\n \"lastTicketingDate\": \"\",\n \"nonHomogeneous\": true,\n \"price\": {\n \"base\": \"\",\n \"currency\": \"\",\n \"grandTotal\": \"\",\n \"total\": \"\"\n },\n \"pricingOptions\": {\n \"fareType\": [\"\"]\n },\n \"source\": \"\",\n \"travelerPricings\": [\n {\n \"fareDetailsBySegment\": [\n {\n \"cabin\": \"\",\n \"class\": \"\",\n \"fareBasis\": \"\",\n \"includedCheckedBags\": {\n \"quantity\": 0\n },\n \"segmentId\": \"\"\n }\n ],\n \"price\": {\n \"base\": \"\",\n \"currency\": \"\",\n \"taxes\": [\n {\n \"amount\": \"\",\n \"code\": \"\"\n }\n ],\n \"total\": \"\"\n },\n \"travelerId\": \"\",\n \"travelerType\": \"\"\n }\n ],\n \"type\": \"\",\n \"validatingAirlineCodes\": [\"\"]\n }\n ],\n \"id\": \"\",\n \"queuingOfficeId\": \"\",\n \"remarks\": {\n \"general\": [\n {\n \"flightOfferIds\": [\"\"],\n \"subType\": \"\",\n \"text\": \"\"\n }\n ]\n },\n \"ticketingAgreement\": {\n \"option\": \"\"\n },\n \"travelers\": [\n {\n \"contact\": {\n \"emailAddress\": \"\",\n \"phones\": [\n {\n \"countryCallingCode\": \"\",\n \"deviceType\": \"\",\n \"number\": \"\"\n }\n ],\n \"purpose\": \"\"\n },\n \"dateOfBirth\": \"\",\n \"documents\": [\n {\n \"documentType\": \"\",\n \"expiryDate\": \"\",\n \"holder\": true,\n \"issuanceCountry\": \"\",\n \"nationality\": \"\",\n \"number\": \"\"\n }\n ],\n \"gender\": \"\",\n \"id\": \"\",\n \"name\": {\n \"firstName\": \"\",\n \"lastName\": \"\"\n }\n }\n ],\n \"type\": \"\"\n}\n\nThis endpoint is used to predict flight choices based on the provided payload.
\nThe request should be sent in the raw format.
\nThe payload should include various details such as ID, instant ticketing requirement, upsell offer, itineraries, last ticketing date, non-homogeneous, number of bookable seats, one-way information, price details, pricing options, source, traveler pricings, type, and validating airline codes.
\n{\n \"id\": \"\",\n \"instantTicketingRequired\": true,\n \"isUpsellOffer\": true,\n \"itineraries\": [\n {\n \"duration\": \"\",\n \"segments\": [\n {\n \"aircraft\": {\"code\": \"\"},\n \"arrival\": {\"at\": \"\", \"iataCode\": \"\", \"terminal\": \"\"},\n \"blacklistedInEU\": true,\n \"carrierCode\": \"\",\n \"departure\": {\"at\": \"\", \"iataCode\": \"\", \"terminal\": \"\"},\n \"duration\": \"\",\n \"id\": \"\",\n \"number\": \"\",\n \"numberOfStops\": 0,\n \"operating\": {\"carrierCode\": \"\"}\n }\n ]\n }\n ],\n \"lastTicketingDate\": \"\",\n \"lastTicketingDateTime\": \"\",\n \"nonHomogeneous\": true,\n \"numberOfBookableSeats\": 0,\n \"oneWay\": true,\n \"price\": {\n \"additionalServices\": [{\"amount\": \"\", \"type\": \"\"}],\n \"base\": \"\",\n \"currency\": \"\",\n \"fees\": [{\"amount\": \"\", \"type\": \"\"}],\n \"grandTotal\": \"\",\n \"total\": \"\"\n },\n \"pricingOptions\": {\n \"fareType\": [\"\"],\n \"includedCheckedBagsOnly\": true\n },\n \"source\": \"\",\n \"travelerPricings\": [\n {\n \"fareDetailsBySegment\": [\n {\n \"amenities\": [\n {\n \"amenityProvider\": {\"name\": \"\"},\n \"amenityType\": \"\",\n \"description\": \"\",\n \"isChargeable\": true\n }\n ],\n \"brandedFare\": \"\",\n \"brandedFareLabel\": \"\",\n \"cabin\": \"\",\n \"class\": \"\",\n \"fareBasis\": \"\",\n \"includedCheckedBags\": {\"quantity\": 0},\n \"segmentId\": \"\"\n }\n ],\n \"fareOption\": \"\",\n \"price\": {\"base\": \"\", \"currency\": \"\", \"total\": \"\"},\n \"travelerId\": \"\",\n \"travelerType\": \"\"\n }\n ],\n \"type\": \"\",\n \"validatingAirlineCodes\": [\"\"]\n}\n\nThis document outlines the structure and required fields for creating a flight order.
\n{\n \"data\": {\n \"order_id\": \"HeX_#-250415404279\",\n \"type\": \"flight-order\",\n \"flightOffers\": [ ... ],\n \"travelers\": [ ... ],\n \"contacts\": [ ... ]\n }\n}\n\norder_id: string
\n Unique identifier for the order.
Example: \"HeX_#-250415404279\"
type: string
\n Type of the order.
Value: \"flight-order\"
flightOffers: array
\nList of flight offers associated with the order.
\ntravelers: array
\nInformation about travelers included in the order.
\ncontacts: array
\nContact details for the booking.
\nEach flight offer contains detailed information about the flight itinerary, pricing, and traveler-specific details.
\n{\n \"type\": \"flight-offer\",\n \"id\": \"1\",\n \"instantTicketingRequired\": false,\n \"nonHomogeneous\": false,\n \"paymentCardRequired\": false,\n \"source\": \"GDS\",\n \"lastTicketingDate\": \"2025-04-29\",\n \"itineraries\": [ ... ],\n \"price\": { ... },\n \"pricingOptions\": { ... },\n \"validatingAirlineCodes\": [ \"AF\" ],\n \"travelerPricings\": [ ... ]\n}\n\nid: string
\nIdentifier for the flight offer.
\ninstantTicketingRequired: boolean
\nIndicates if instant ticketing is required.
\nnonHomogeneous: boolean
\nIndicates if the offer is non-homogeneous.
\npaymentCardRequired: boolean
\nIndicates if a payment card is required.
\nsource: string
\n Source of the flight offer.
Example: \"GDS\"
lastTicketingDate: string
\n Last date for ticketing.
Format: YYYY-MM-DD
itineraries: array
\nList of itineraries for the flight offer.
\nprice: object
\nPricing details for the flight offer.
\npricingOptions: object
\nOptions related to pricing.
\nvalidatingAirlineCodes: array
\nList of airline codes validating the offer.
\ntravelerPricings: array
\nPricing details per traveler.
\nEach itinerary includes segments detailing each leg of the journey.
\n{\n \"segments\": [\n {\n \"departure\": {\n \"iataCode\": \"CDG\",\n \"terminal\": \"2E\",\n \"at\": \"2025-04-29T18:15:00\"\n },\n \"arrival\": {\n \"iataCode\": \"LHR\",\n \"terminal\": \"4\",\n \"at\": \"2025-04-29T18:35:00\"\n },\n \"carrierCode\": \"AF\",\n \"number\": \"1180\",\n \"aircraft\": {\n \"code\": \"223\"\n },\n \"operating\": {\n \"carrierCode\": \"AF\"\n },\n \"duration\": \"PT1H20M\",\n \"id\": \"1\",\n \"numberOfStops\": 0,\n \"co2Emissions\": [\n {\n \"weight\": 47,\n \"weightUnit\": \"KG\",\n \"cabin\": \"BUSINESS\"\n }\n ]\n }\n ]\n}\n\nDetails about the pricing of the flight offer.
\n{\n \"currency\": \"NGN\",\n \"total\": \"2304190.00\",\n \"base\": \"2148907.00\",\n \"fees\": [\n {\n \"amount\": \"0.00\",\n \"type\": \"SUPPLIER\"\n },\n {\n \"amount\": \"0.00\",\n \"type\": \"TICKETING\"\n },\n {\n \"amount\": \"0.00\",\n \"type\": \"FORM_OF_PAYMENT\"\n }\n ],\n \"grandTotal\": \"2304190.00\",\n \"billingCurrency\": \"NGN\"\n}\n\nInformation about each traveler in the booking.
\n{\n \"id\": \"1\",\n \"dateOfBirth\": \"1982-01-16\",\n \"name\": {\n \"firstName\": \"JORGE\",\n \"lastName\": \"GONZALES\"\n },\n \"gender\": \"MALE\",\n \"contact\": {\n \"emailAddress\": \"jorge.gonzales833@telefonica.es\",\n \"phones\": [\n {\n \"deviceType\": \"MOBILE\",\n \"countryCallingCode\": \"34\",\n \"number\": \"480080076\"\n }\n ]\n },\n \"documents\": [\n {\n \"documentType\": \"PASSPORT\",\n \"number\": \"00000000\",\n \"issuanceDate\": \"2015-04-14\",\n \"expiryDate\": \"2027-04-14\",\n \"issuanceCountry\": \"ES\",\n \"nationality\": \"ES\",\n \"birthPlace\": \"Madrid\",\n \"holder\": true\n }\n ]\n}\n\nContact information for the booking.
\n{\n \"addresseeName\": {\n \"firstName\": \"PABLO\",\n \"lastName\": \"RODRIGUEZ\"\n },\n \"companyName\": \"INCREIBLE VIAJES\",\n \"purpose\": \"STANDARD\",\n \"phones\": [\n {\n \"deviceType\": \"LANDLINE\",\n \"countryCallingCode\": \"34\",\n \"number\": \"480080071\"\n },\n {\n \"deviceType\": \"MOBILE\",\n \"countryCallingCode\": \"33\",\n \"number\": \"480080072\"\n }\n ],\n \"emailAddress\": \"support@increibleviajes.es\",\n \"address\": {\n \"lines\": [\n \"Calle Prado, 16\"\n ],\n \"postalCode\": \"28014\",\n \"cityName\": \"Madrid\",\n \"countryCode\": \"ES\"\n }\n}\n\nUpon successful booking, the response will include the booking details.
\n{\n \"booked_data\": {\n \"data\": {\n \"associatedRecords\": [\n {\n \"creationDate\": \"2025-04-15T09:42:00.000\",\n \"flightOfferId\": \"1\",\n \"originSystemCode\": \"GDS\",\n \"reference\": \"UMVVVY\"\n }\n ],\n \"automatedProcess\": [\n {\n \"code\": \"IMMEDIATE\",\n \"officeId\": \n\nThis endpoint allows you to retrieve flight availabilities based on the provided origin-destination and traveler details.
\noriginDestinations (array): An array of origin-destination details including id, origin location code, destination location code, and departure date-time.
id (string): The ID of the origin-destination.
originLocationCode (string): The code for the origin location.
destinationLocationCode (string): The code for the destination location.
departureDateTime (object): The date and time of departure.
date (string): The date of departure.
time (string): The time of departure.
travelers (array): An array of traveler details including id and traveler type.
id (string): The ID of the traveler.
travelerType (string): The type of traveler.
sources (array): An array of sources.
The response will be a JSON array with the following fields for each flight availability:
\nduration (string): The duration of the flight.
id (string): The ID of the flight availability.
instantTicketingRequired (boolean): Indicates if instant ticketing is required.
originDestinationId (string): The ID of the origin-destination.
paymentCardRequired (boolean): Indicates if payment card is required.
segments (array): An array of flight segments.
aircraft (object): Details of the aircraft.
code (string): The code of the aircraft.arrival (object): Details of the arrival.
at (string): The arrival time.
iataCode (string): The IATA code of the arrival location.
terminal (string): The terminal at the arrival location.
availabilityClasses (array): An array of availability classes.
class (string): The class of availability.
numberOfBookableSeats (integer): The number of bookable seats.
blacklistedInEU (boolean): Indicates if the flight is blacklisted in the EU.
carrierCode (string): The code of the carrier.
departure (object): Details of the departure.
at (string): The departure time.
iataCode (string): The IATA code of the departure location.
terminal (string): The terminal at the departure location.
id (string): The ID of the segment.
number (string): The segment number.
numberOfStops (integer): The number of stops.
source (string): The source of the flight availability.
type (string): The type of the flight availability.
This endpoint allows you to retrieve seatmap information for a flight.
\nThe request body should be in raw format and should include the following parameters:
\nid (string, required): The ID of the seatmap.
\ninstantTicketingRequired (boolean, required): Indicates if instant ticketing is required.
\nisUpsellOffer (boolean, required): Indicates if the offer is an upsell offer.
\nitineraries (array, required): An array of itineraries containing flight segments.
\nlastTicketingDate (string, required): The last ticketing date.
\nlastTicketingDateTime (string, required): The last ticketing date and time.
\nnonHomogeneous (boolean, required): Indicates if the seatmap is non-homogeneous.
\nnumberOfBookableSeats (integer, required): The number of bookable seats.
\noneWay (boolean, required): Indicates if the flight is one-way.
\nprice (object, required): The price details including base, currency, fees, and total.
\npricingOptions (object, required): The pricing options including fare type and included checked bags only.
\nsource (string, required): The source of the seatmap.
\ntravelerPricings (array, required): An array of traveler pricings including fare details by segment, fare option, price, traveler ID, and traveler type.
\nvalidatingAirlineCodes (array, required): An array of validating airline codes.
\nThe response will be in JSON format with the following schema:
\n[\n {\n \"aircraft\": {\n \"code\": \"\"\n },\n \"aircraftCabinAmenities\": {\n \"beverage\": {\n \"beverageType\": \"\",\n \"isChargeable\": true\n },\n \"entertainment\": [\n {\n \"entertainmentType\": \"\",\n \"isChargeable\": true\n }\n ],\n \"food\": {\n \"foodType\": \"\",\n \"isChargeable\": true\n },\n \"power\": {\n \"isChargeable\": true,\n \"powerType\": \"\",\n \"usbType\": \"\"\n },\n \"seat\": {\n \"legSpace\": 0,\n \"medias\": [\n {\n \"description\": {\n \"lang\": \"\",\n \"text\": \"\"\n },\n \"href\": \"\",\n \"mediaType\": \"\",\n \"title\": \"\"\n }\n ],\n \"spaceUnit\": \"\",\n \"tilt\": \"\"\n },\n \"wifi\": {\n \"isChargeable\": true,\n \"wifiCoverage\": \"\"\n }\n },\n \"arrival\": {\n \"at\": \"\",\n \"iataCode\": \"\",\n \"terminal\": \"\"\n },\n \"availableSeatsCounters\": [\n {\n \"travelerId\": \"\",\n \"value\": 0\n }\n ],\n \"carrierCode\": \"\",\n \"class\": \"\",\n \"decks\": [\n {\n \"deckConfiguration\": {\n \"endSeatRow\": 0,\n \"endWingsRow\": 0,\n \"endWingsX\": 0,\n \"exitRowsX\": [0],\n \"length\": 0,\n \"startSeatRow\": 0,\n \"startWingsRow\": 0,\n \"startWingsX\": 0,\n \"width\": 0\n },\n \"deckType\": \"\",\n \"facilities\": [\n {\n \"code\": \"\",\n \"column\": \"\",\n \"coordinates\": {\n \"x\": 0,\n \"y\": 0\n },\n \"position\": \"\",\n \"row\": \"\"\n }\n ],\n \"seats\": [\n {\n \"cabin\": \"\",\n \"characteristicsCodes\": [\"\"],\n \"coordinates\": {\n \"x\": 0,\n \"y\": 0\n },\n \"number\": \"\",\n \"travelerPricing\": [\n {\n \"price\": {\n \"base\": \"\",\n \"currency\": \"\",\n \"taxes\": [\n {\n \"amount\": \"\",\n \"code\": \"\"\n }\n ],\n \"total\": \"\"\n },\n \"seatAvailabilityStatus\": \"\",\n \"travelerId\": \"\"\n }\n ]\n }\n ]\n }\n ],\n \"departure\": {\n \"at\": \"\",\n \"iataCode\": \"\",\n \"terminal\": \"\"\n },\n \"flightOfferId\": \"\",\n \"id\": \"\",\n \"number\": \"\",\n \"operating\": {\n \"carrierCode\": \"\"\n },\n \"segmentId\": \"\",\n \"type\": \"\"\n }\n]\n\nThis JSON schema represents the structure of the response returned by the API when retrieving seatmap information for a flight.
\n","urlObject":{"path":["flights","seatmaps"],"host":["{{baseUrl}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"8d86c802-d622-4aaa-95de-5a1e6f04dabc"},{"name":"flights/search-multi-city","id":"17764eb4-bde1-466f-816c-f4e20ae25351","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"currencyCode\": \"USD\",\n \"originDestinations\": [\n {\n \"id\": \"1\",\n \"originLocationCode\": \"NYC\",\n \"destinationLocationCode\": \"MAD\",\n \"departureDateTimeRange\": {\n \"date\": \"2025-11-01\",\n \"time\": \"10:00:00\"\n }\n },\n {\n \"id\": \"2\",\n \"originLocationCode\": \"MAD\",\n \"destinationLocationCode\": \"PAR\",\n \"departureDateTimeRange\": {\n \"date\": \"2025-11-05\",\n \"time\": \"12:00:00\"\n }\n },\n {\n \"id\": \"3\",\n \"originLocationCode\": \"PAR\",\n \"destinationLocationCode\": \"NYC\",\n \"departureDateTimeRange\": {\n \"date\": \"2025-11-10\",\n \"time\": \"14:00:00\"\n }\n }\n ],\n \"travelers\": [\n {\"id\": \"1\", \"travelerType\": \"ADULT\"}, // Adult\n {\"id\": \"2\", \"travelerType\": \"CHILD\"}, // Child (under 12)\n {\"id\": \"3\", \"travelerType\": \"SEATED_INFANT\"} // Infant\n ],\n \"sources\": [\"GDS\"],\n \"searchCriteria\": {\n \"maxFlightOffers\": 2,\n \"flightFilters\": {\n \"cabinRestrictions\": [\n {\n \"cabin\": \"BUSINESS\",\n \"coverage\": \"MOST_SEGMENTS\",\n \"originDestinationIds\": [\"1\", \"2\", \"3\"]\n }\n ]\n }\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{baseUrl}}/flights/search-multi-city","description":"This endpoint allows you to search for multi-city flight options.
\ncurrencyCode (string): The currency code for the pricing.
originDestinations (array): An array of origin and destination locations with departure date and time.
id (string): Identifier for the origin-destination pair.
originLocationCode (string): The code for the origin location.
destinationLocationCode (string): The code for the destination location.
departureDateTimeRange (object): Date and time for departure.
date (string): The date of departure.
time (string): The time of departure.
travelers (array): An array of travelers with their type.
id (string): Identifier for the traveler.
travelerType (string): Type of traveler (e.g., ADULT, CHILD, etc.).
sources (array): An array of sources for the flight search.
searchCriteria (object): Criteria for the flight search.
maxFlightOffers (number): Maximum number of flight offers to be returned.
flightFilters (object): Filters for the flight search.
cabinRestrictions (array): Restrictions based on cabin class.
cabin (string): The cabin class (e.g., BUSINESS, ECONOMY, etc.).
coverage (string): The coverage type for the cabin restriction.
originDestinationIds (array): Origin-destination pair identifiers.
The response is a JSON schema with the following structure:
\ndata (array): Array of flight data.
id (string): Identifier for the flight.
instantTicketingRequired (boolean): Indicates if instant ticketing is required.
isUpsellOffer (boolean): Indicates if the offer is an upsell.
itineraries (array): Array of flight itineraries.
duration (string): Duration of the itinerary.
segments (array): Array of flight segments.
aircraft (object): Details of the aircraft.
code (string): The code of the aircraft.arrival (object): Details of the arrival.
at (string): Arrival time.
iataCode (string): IATA code of the arrival location.
blacklistedInEU (boolean): Indicates if the flight is blacklisted in the EU.
carrierCode (string): Code of the carrier.
departure (object): Details of the departure.
at (string): Departure time.
iataCode (string): IATA code of the departure location.
terminal (string): Terminal information.
duration (string): Duration of the segment.
id (string): Identifier for the segment.
number (string): Flight number.
numberOfStops (number): Number of stops.
lastTicketingDate (string): Last ticketing date.
lastTicketingDateTime (string): Last ticketing date and time.
nonHomogeneous (boolean): Indicates if the itinerary is non-homogeneous.
numberOfBookableSeats (number): Number of bookable seats.
oneWay (boolean): Indicates if it's a one-way flight.
price (object): Pricing details.
base (string): Base price.
currency (string): Currency code.
fees (array): Array of fees.
amount (string): Amount of the fee.
type (string): Type of the fee.
grandTotal (string): Grand total price.
total (string): Total price.
pricingOptions (object): Options for pricing.
fareType (array): Array of fare types.
includedCheckedBagsOnly (boolean): Indicates if only checked bags are included.
source (string): The source of the flight.
travelerPricings (array): Array of traveler pricings.
fareDetailsBySegment (array): Array of fare details by segment.
amenities (array): Array of amenities.
amenityProvider (object): Provider of the amenity.
name (string): Name of the provider.amenityType (string): Type of the amenity.
description (string): Description of the amenity.
isChargeable (boolean): Indicates if the amenity is chargeable.
brandedFare (string): Branded fare details.
brandedFareLabel (string): Label for the branded fare.
cabin (string): Cabin class.
class (string): Class of the fare.
fareBasis (string): Fare basis.
includedCabinBags (object): Details of included cabin bags.
quantity (number): Quantity of included cabin bags.includedCheckedBags (object): Details of included checked bags.
quantity (number): Quantity of included checked bags.segmentId (string): Identifier for the segment.
fareOption (string): Fare option.
price (object): Pricing details.
base (string): Base price.
currency (string): Currency code.
total (string): Total price.
travelerId (string): Identifier for the traveler.
travelerType (string): Type of the traveler.
type (string): Type of the flight.
validatingAirlineCodes (array): Array of validating airline codes.
dictionaries (object): Dictionaries for aircraft, carriers, currencies, and locations.
aircraft (object): Dictionary of aircraft codes.
carriers (object): Dictionary of carrier codes.
currencies (object): Dictionary of currency codes.
locations (object): Dictionary of location codes.
meta (object): Meta information.
count (number): Count of flight data.POST /booking_confirmation
JWT token required (@jwt_required())
{\n \"Authorization\": \"Bearer <JWT_TOKEN>\",\n \"Content-Type\": \"application/json\"\n}\n\n{\n \"booking_id\": \"987654-hg321-54634fg-fgfdgh\",\n \"tx_ref\": \"HeX_TX-123456789\"\n}\n\n{\n \"message\": \"Flight Booking confirmed successfully\",\n \"booking_id\": \"98765-4321-5355-5535\",\n \"confirmation_number\": \"HeXCF-12345625458555\",\n \"flight_details\": {\n \"flight_booking_id\": \"FB98765\",\n \"carrier_code\": \"AA\",\n \"flight_number\": \"AA123\",\n \"departure_airport\": \"JFK\",\n \"arrival_airport\": \"LAX\",\n \"departure_time\": \"2025-06-01T10:00:00\",\n \"arrival_time\": \"2025-06-01T16:30:00\",\n \"aircraft_code\": \"777\",\n \"co2_emissions\": 500,\n \"status\": \"PAID\"\n }\n}\n\n400 BAD REQUEST – Missing booking_id or tx_ref
404 NOT FOUND – Booking, transaction, or user not found
500 INTERNAL SERVER ERROR – Database or server error
This endpoint confirms a bank transfer payment for a flight booking after the customer has completed the transfer to the provided bank account.
\nUse this endpoint to notify the system that a bank transfer payment has been made for a specific booking. This triggers the payment verification process and updates the booking status accordingly.
\nRequired Fields:
\nbooking_id (string, UUID format): The unique identifier of the booking for which payment is being confirmedExample:
\n{\n \"booking_id\": \"3a1dc5e9-6162-439d-af6d-c4a536aaa88c\"\n}\n\nSuccess Response (200 OK):
\nThe response includes comprehensive payment confirmation details:
\nstatus (string): Payment confirmation status (e.g., \"confirmed\")
booking_id (string): The booking identifier that was confirmed
order_id (string): The generated order reference number
amount_paid (number): The total amount paid in the specified currency
currency (string): The currency code (e.g., \"NGN\" for Nigerian Naira)
confirmation_timestamp (string, ISO 8601): When the payment confirmation was received
bank_details (object): The bank account information used for the transfer
bank_name (string): Name of the receiving bank
account_number (string): Account number where payment was received
account_name (string): Name on the receiving account
message (string): Confirmation message for the user
next_steps (string): Instructions on what happens next
Example Response:
\n{\n \"amount_paid\": 366072.29,\n \"bank_details\": {\n \"account_name\": \"TEST-MANAGED-ACCOUNT\",\n \"account_number\": \"1238446113\",\n \"bank_name\": \"Test Bank\"\n },\n \"booking_id\": \"3a1dc5e9-6162-439d-af6d-c4a536aaa88c\",\n \"confirmation_timestamp\": \"2025-11-24T13:54:33.373815\",\n \"currency\": \"NGN\",\n \"message\": \"Payment confirmation received. Your booking is being processed.\",\n \"order_id\": \"HeX_#-251124443802\",\n \"status\": \"confirmed\",\n \"next_steps\": \"Your ticket will be issued automatically once payment is verified.\"\n}\n\nEnsure the booking_id is valid and corresponds to an existing booking with pending bank transfer payment
The confirmation timestamp is automatically generated by the system
\nAfter confirmation, the system will verify the payment and issue tickets automatically
\nKeep the order_id from the response for future reference and customer support inquiries
Endpoints for advanced flight functions in hermex travels
\n","_postman_id":"061dfe28-2454-432a-b1d5-12c74d2a31db"},{"name":"BASIC flight Functions","item":[{"name":"flights/flight_inspiration","id":"5ba8ab68-beff-457e-97ca-83c37d4433f9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{vault:authorization-secret}}"}]},"isInherited":false},"method":"GET","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"{{baseUrl}}/flights/flight_inspiration?origin=MAD","description":"This endpoint makes an HTTP GET request to retrieve flight inspiration based on the specified origin.
\norigin (string, required): The origin airport code for the flight inspiration.The response will be a JSON array containing flight inspiration details with the following keys:
\ndepartureDate (string): The departure date for the flight.
destination (string): The destination airport code.
links (object): Contains links for flight dates and flight offers.
flightDates (string): Link for flight dates.
flightOffers (string): Link for flight offers.
origin (string): The origin airport code.
price (object): Contains total price details.
total (string): The total price for the flight.returnDate (string): The return date for the flight.
type (string): Type of the flight inspiration.
This endpoint retrieves the cheapest flight dates based on the provided origin, destination, and other parameters.
\norigin (string, required): The three-letter IATA code of the origin airport.
destination (string, required): The three-letter IATA code of the destination airport.
oneWay (boolean, required): Indicates if the flight is one-way.
nonStop (boolean, required): Indicates if the flight should be non-stop.
maxPrice (number, required): The maximum price for the flight.
viewBy (string, required): Indicates how the results should be viewed (e.g., by date).
The response will be in JSON format and will contain an array of objects with the following properties:
\ndepartureDate (string): The date of departure.
destination (string): The destination airport.
links (object): Contains links related to flight destinations and offers.
origin (string): The origin airport.
price (object): Contains information about the total price.
type (string): Indicates the type of flight.
An example response object:
\n[\n {\n \"departureDate\": \"\",\n \"destination\": \"\",\n \"links\": {\n \"flightDestinations\": \"\",\n \"flightOffers\": \"\"\n },\n \"origin\": \"\",\n \"price\": {\n \"total\": \"\"\n },\n \"type\": \"\"\n }\n]\n\nThis endpoint is used to retrieve flight check-in links for a specific airline.
\nMethod: GET
\nEndpoint: http://127.0.0.1:5000/api/flight_checkin_links
Query Parameters:
\nThe response is an array of flight check-in link objects in JSON format. Each object has the following properties:
\nchannel (string): The channel for the check-in link.
\nhref (string): The URL of the check-in link.
\nid (string): The unique identifier of the check-in link.
\ntype (string): The type of the check-in link.
\nExample response body:
\n[\n {\n \"channel\": \"\",\n \"href\": \"\",\n \"id\": \"\",\n \"type\": \"\"\n }\n]\n\nThe API endpoint flight_offers_search is a GET request that retrieves flight offers based on the provided search criteria. The request URL is http://127.0.0.1:5000/api/flight_offers_search, and the parameters are as follows:
children: Number of children for the flight search.
return_date: Return date for the flight search.
infants: Number of infants for the flight search.
origin: The origin airport code for the flight search.
destination: The destination airport code for the flight search.
departure_date: Departure date for the flight search.
adults: Number of adults for the flight search.
non_stop: Indicates if the user prefers non-stop flights.
travel_class: The travel class for the flight search.
max: Maximum number of flight offers to return.
The response returned is a JSON array with a status code of 200 and a content type of application/json. The array contains objects representing flight offers. Each flight offer object includes various details such as ID, instant ticketing requirement, upsell offer status, itineraries, last ticketing date, number of bookable seats, price details, pricing options, source, traveler pricings, validating airline codes, and more.
Due to the complexity and depth of the response, it is recommended to use a JSON schema validator to generate a schema for the response, as the structure contains nested objects and arrays with multiple properties and sub-properties.
\nHere is a sample JSON schema for the response:
\n{\n \"type\": \"array\",\n \"items\": {\n \"type\": \"object\",\n \"properties\": {\n // Detailed schema properties as per the provided response\n }\n }\n}\n\nThis endpoint performs a GET request to retrieve information about airline codes. The request should include a query parameter \"airlineCodes\" with the value of the airline code to be looked up.
\nMethod: GET
\nQuery Parameters:
\nStatus: 200
\nContent-Type: application/json
\nBody:
The response will be a JSON array containing objects with the following fields:
businessName (string): The business name of the airline.
\ncommonName (string): The common name of the airline.
\niataCode (string): The IATA code of the airline.
\nicaoCode (string): The ICAO code of the airline.
\ntype (string): The type of the airline.
\nThis endpoint makes an HTTP GET request to search for airports and cities based on a provided keyword.
\nkeyword (string, required): The keyword to search for airports and cities.The response will be in JSON format with a status code of 200. The response will include an array of airports and an array of cities. Each airport and city object will contain detailed information such as address, analytics, detailed name, geocode, IATA code, ID, name, self reference, sub type, time zone offset, and type.
\nExample Response:
\n{\n \"airports\": [\n {\n \"address\": {\n \"cityCode\": \"\",\n \"cityName\": \"\",\n \"countryCode\": \"\",\n \"countryName\": \"\",\n \"regionCode\": \"\"\n },\n \"analytics\": {\n \"travelers\": {\n \"score\": 0\n }\n },\n \"detailedName\": \"\",\n \"geoCode\": {\n \"latitude\": 0,\n \"longitude\": 0\n },\n \"iataCode\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"self\": {\n \"href\": \"\",\n \"methods\": [\"\"]\n },\n \"subType\": \"\",\n \"timeZoneOffset\": \"\",\n \"type\": \"\"\n }\n ],\n \"cities\": [\n {\n \"address\": {\n \"cityCode\": \"\",\n \"cityName\": \"\",\n \"countryCode\": \"\",\n \"countryName\": \"\",\n \"regionCode\": \"\"\n },\n \"analytics\": {\n \"travelers\": {\n \"score\": 0\n }\n },\n \"detailedName\": \"\",\n \"geoCode\": {\n \"latitude\": 0,\n \"longitude\": 0\n },\n \"iataCode\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"self\": {\n \"href\": \"\",\n \"methods\": [\"\"]\n },\n \"subType\": \"\",\n \"timeZoneOffset\": \"\",\n \"type\": \"\"\n }\n ]\n}\n\nThis API endpoint retrieves the status of a flight based on the carrier code, flight number, and scheduled departure date.
\nMethod: GET
\nEndpoint: http://127.0.0.1:5000/api/flight_status
Query Parameters:
\ncarrierCode (string): The code of the airline carrier.
flightNumber (integer): The flight number.
scheduledDepartureDate (string): The scheduled departure date in the format 'YYYY-MM-DD'.
The response is in JSON format and represents the status of the requested flight. Below is the JSON schema for the response:
\n[\n {\n \"flightDesignator\": {\n \"carrierCode\": \"\",\n \"flightNumber\": 0\n },\n \"flightPoints\": [\n {\n \"departure\": {\n \"timings\": [\n {\n \"qualifier\": \"\",\n \"value\": \"\"\n }\n ]\n },\n \"iataCode\": \"\"\n }\n ],\n \"legs\": [\n {\n \"aircraftEquipment\": {\n \"aircraftType\": \"\"\n },\n \"boardPointIataCode\": \"\",\n \"offPointIataCode\": \"\",\n \"scheduledLegDuration\": \"\"\n }\n ],\n \"scheduledDepartureDate\": \"\",\n \"segments\": [\n {\n \"boardPointIataCode\": \"\",\n \"offPointIataCode\": \"\",\n \"partnership\": {\n \"operatingFlight\": {\n \"carrierCode\": \"\",\n \"flightNumber\": 0\n }\n },\n \"scheduledSegmentDuration\": \"\"\n }\n ],\n \"type\": \"\"\n }\n]\n\nThis API endpoint retrieves the flight delay predictions based on the provided flight details.
\nMethod: GET
\nURL: http://127.0.0.1:5000/api/flight_delay_prediction
Query Parameters:
\noriginLocationCode (string): The code for the origin airport.
destinationLocationCode (string): The code for the destination airport.
departureDate (string): The date of departure in the format 'YYYY-MM-DD'.
departureTime (string): The time of departure in the format 'HH:MM:SS'.
arrivalDate (string): The date of arrival in the format 'YYYY-MM-DD'.
arrivalTime (string): The time of arrival in the format 'HH:MM:SS'.
aircraftCode (string): The code for the aircraft.
carrierCode (string): The code for the airline carrier.
flightNumber (string): The flight number.
duration (integer): The duration of the flight in minutes.
The response is in JSON format and follows the schema below:
\n{\n \"allPredictions\": [\n {\n \"id\": \"\",\n \"probability\": \"\",\n \"result\": \"\",\n \"subType\": \"\",\n \"type\": \"\"\n }\n ],\n \"mostLikelyDelay\": {\n \"id\": \"\",\n \"probability\": \"\",\n \"result\": \"\",\n \"subType\": \"\",\n \"type\": \"\"\n }\n}\n\nThis endpoint retrieves the on-time performance data for a specific airport on a given date.
\nairportCode (query parameter) - The code of the airport for which the on-time performance data is requested.
date (query parameter) - The date for which the on-time performance data is requested.
The response is a JSON object with the following schema:
\n{\n \"id\": \"\",\n \"probability\": \"\",\n \"result\": \"\",\n \"subType\": \"\",\n \"type\": \"\"\n}\n\nThis endpoint retrieves the nearest airport based on the provided longitude and latitude coordinates.
\nlongitude (query parameter) - The longitude coordinate of the location.
latitude (query parameter) - The latitude coordinate of the location.
Upon a successful request, the server will respond with a status code of 200 and a JSON object containing information about the nearest airport. The response includes details such as the airport's address, analytics, distance, geocode, IATA code, name, relevance, subtype, timezone offset, and type.
\nExample response:
\n[\n {\n \"address\": {\n \"cityCode\": \"\",\n \"cityName\": \"\",\n \"countryCode\": \"\",\n \"countryName\": \"\",\n \"regionCode\": \"\",\n \"stateCode\": \"\"\n },\n \"analytics\": {\n \"flights\": {\n \"score\": 0\n },\n \"travelers\": {\n \"score\": 0\n }\n },\n \"detailedName\": \"\",\n \"distance\": {\n \"unit\": \"\",\n \"value\": 0\n },\n \"geoCode\": {\n \"latitude\": 0,\n \"longitude\": 0\n },\n \"iataCode\": \"\",\n \"name\": \"\",\n \"relevance\": 0,\n \"subType\": \"\",\n \"timeZoneOffset\": \"\",\n \"type\": \"\"\n }\n]\n\nThe API endpoint retrieves flight order details. The response is a JSON object with various fields. Below is the JSON schema for the response:
\n{\n \"type\": \"object\",\n \"properties\": {\n \"associatedRecords\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"object\",\n \"properties\": {\n \"flightOfferId\": { \"type\": \"string\" },\n \"originSystemCode\": { \"type\": \"string\" },\n \"reference\": { \"type\": \"string\" }\n }\n }\n },\n \"contacts\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"object\",\n \"properties\": {\n \"purpose\": { \"type\": \"string\" }\n }\n }\n },\n \"flightOffers\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"object\",\n \"properties\": {\n \"id\": { \"type\": \"string\" },\n \"itineraries\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"object\",\n \"properties\": {\n \"segments\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"object\",\n \"properties\": {\n \"aircraft\": {\n \"type\": \"object\",\n \"properties\": {\n \"code\": { \"type\": \"string\" }\n }\n },\n \"arrival\": {\n \"type\": \"object\",\n \"properties\": {\n \"at\": { \"type\": \"string\" },\n \"iataCode\": { \"type\": \"string\" },\n \"terminal\": { \"type\": \"string\" }\n }\n },\n \"bookingStatus\": { \"type\": \"string\" },\n \"carrierCode\": { \"type\": \"string\" },\n \"co2Emissions\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"object\",\n \"properties\": {\n \"cabin\": { \"type\": \"string\" },\n \"weight\": { \"type\": \"number\" },\n \"weightUnit\": { \"type\": \"string\" }\n }\n }\n },\n \"departure\": {\n \"type\": \"object\",\n \"properties\": {\n \"at\": { \"type\": \"string\" },\n \"iataCode\": { \"type\": \"string\" },\n \"terminal\": { \"type\": \"string\" }\n }\n },\n \"duration\": { \"type\": \"string\" },\n \"id\": { \"type\": \"string\" },\n \"isFlown\": { \"type\": \"boolean\" },\n \"number\": { \"type\": \"string\" },\n \"numberOfStops\": { \"type\": \"integer\" },\n \"segmentType\": { \"type\": \"string\" }\n }\n }\n }\n }\n }\n },\n \"lastTicketingDate\": { \"type\": \"string\" },\n \"nonHomogeneous\": { \"type\": \"boolean\" },\n \"price\": {\n \"type\": \"object\",\n \"properties\": {\n \"base\": { \"type\": \"string\" },\n \"currency\": { \"type\": \"string\" },\n \"grandTotal\": { \"type\": \"string\" },\n \"total\": { \"type\": \"string\" }\n }\n },\n \"pricingOptions\": {\n \"type\": \"object\",\n \"properties\": {\n \"fareType\": {\n \"type\": \"array\",\n \"items\": { \"type\": \"string\" }\n }\n }\n },\n \"source\": { \"type\": \"string\" },\n \"travelerPricings\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"object\",\n \"properties\": {\n \"fareDetailsBySegment\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"object\",\n \"properties\": {\n \"cabin\": { \"type\": \"string\" },\n \"class\": { \"type\": \"string\" },\n \"fareBasis\": { \"type\": \"string\" },\n \"includedCheckedBags\": {\n \"type\": \"object\",\n \"properties\": {\n \"quantity\": { \"type\": \"integer\" }\n }\n },\n \"segmentId\": { \"type\": \"string\" }\n }\n }\n },\n \"price\": {\n \"type\": \"object\",\n \"properties\": {\n \"base\": { \"type\": \"string\" },\n \"currency\": { \"type\": \"string\" },\n \"taxes\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"object\",\n \"properties\": {\n \"amount\": { \"type\": \"string\" },\n \"code\": { \"type\": \"string\" }\n }\n }\n },\n \"total\": { \"type\": \"string\" }\n }\n },\n \"travelerId\": { \"type\": \"string\" },\n \"travelerType\": { \"type\": \"string\" }\n }\n }\n },\n \"type\": { \"type\": \"string\" },\n \"validatingAirlineCodes\": {\n \"type\": \"array\",\n \"items\": { \"type\": \"string\" }\n }\n }\n }\n },\n \"id\": { \"type\": \"string\" },\n \"queuingOfficeId\": { \"type\": \"string\" },\n \"remarks\": {\n \"type\": \"object\",\n \"properties\": {\n \"general\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"object\",\n \"properties\": {\n \"flightOfferIds\": {\n \"type\": \"array\",\n \"items\": { \"type\": \"string\" }\n },\n \"subType\": { \"type\": \"string\" },\n \"text\": { \"type\": \"string\" }\n }\n }\n }\n }\n },\n \"ticketingAgreement\": {\n \"type\": \"object\",\n \"properties\": {\n \"option\": { \"type\": \"string\" }\n }\n },\n \"travelers\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"object\",\n \"properties\": {\n \"contact\": {\n \"type\": \"object\",\n \"properties\": {\n \"emailAddress\": { \"type\": \"string\" },\n \"phones\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"object\",\n \"properties\": {\n \"countryCallingCode\": { \"type\": \"string\" },\n \"deviceType\": { \"type\": \"string\" },\n \"number\": { \"type\": \"string\" }\n }\n }\n },\n \"purpose\": { \"type\": \"string\" }\n }\n },\n \"dateOfBirth\": { \"type\": \"string\" },\n \"documents\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"object\",\n \"properties\": {\n \"documentType\": { \"type\": \"string\" },\n \"expiryDate\": { \"type\": \"string\" },\n \"holder\": { \"type\": \"boolean\" },\n \"issuanceCountry\": { \"type\": \"string\" },\n \"nationality\": { \"type\": \"string\" },\n \"number\": { \"type\": \"string\" }\n }\n }\n },\n \"gender\": { \"type\": \"string\" },\n \"id\": { \"type\": \"string\" },\n \"name\": {\n \"type\": \"object\",\n \"properties\": {\n \"firstName\": { \"type\": \"string\" },\n \"lastName\": { \"type\": \"string\" }\n }\n }\n }\n }\n },\n \"type\": { \"type\": \"string\" }\n }\n}\n\nThis endpoint retrieves special offers for flights available in the system.
\nMethod: GET
Endpoint: {{baseUrl}}/flights/flight_special_offers
Status Code: 200 OK
Content-Type: application/json
The response will contain a JSON object with the following structure:
\n{\n \"specialOffers\": [\n {\n \"departureDate\": \"<string>\",\n \"offers\": <array>,\n \"route\": \"<string>\"\n }\n ]\n}\n\nspecialOffers: An array of special flight offers.
\ndepartureDate: A string representing the date of departure.
\noffers: An array that contains details of the available offers (this may be empty).
\nroute: A string indicating the flight route.
\n{\n \"specialOffers\": [\n {\n \"departureDate\": \"2023-10-01\",\n \"offers\": [],\n \"route\": \"NYC-LAX\"\n }\n ]\n}\n\nThis endpoint is useful for users looking to find and evaluate special flight offers based on their travel needs.
\n","urlObject":{"path":["flights","flight_special_offers"],"host":["{{baseUrl}}"],"query":[],"variable":[]}},"response":[{"id":"66374473-7d20-439a-8bbb-a1bdfb86146f","name":"{{baseUrl}}/flights/flight_special_offers","originalRequest":{"method":"GET","header":[],"url":"{{baseUrl}}/flights/flight_special_offers"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"Werkzeug/3.0.6 Python/3.13.0"},{"key":"Date","value":"Thu, 24 Jul 2025 22:18:46 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"2882"},{"key":"Access-Control-Allow-Origin","value":"http://localhost:3000"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Vary","value":"Origin"},{"key":"Connection","value":"close"}],"cookie":[],"responseTime":null,"body":"{\n \"specialOffers\": [\n {\n \"departureDate\": \"2025-07-29\",\n \"offers\": [],\n \"route\": \"ACC → LHR\"\n },\n {\n \"departureDate\": \"2025-07-29\",\n \"offers\": [],\n \"route\": \"ACC → CDG\"\n },\n {\n \"departureDate\": \"2025-07-29\",\n \"offers\": [\n {\n \"airlineLogo\": \"https://cdn.hermextravels.com/EK.png\",\n \"brandedFaresUpsell\": [],\n \"flightOverview\": {\n \"airline\": \"EK\",\n \"currency\": \"USD\",\n \"fareType\": \"ECO SAVER\",\n \"includedCabinBags\": 1,\n \"includedCheckedBags\": 2,\n \"totalDuration\": \"PT8H15M\",\n \"totalPrice\": \"549.40\"\n },\n \"id\": \"1\",\n \"instantTicketingRequired\": false,\n \"isUpsellOffer\": false,\n \"itineraries\": [\n {\n \"duration\": \"PT8H15M\",\n \"flightSegments\": [\n {\n \"aircraft\": \"77W\",\n \"arrival\": \"2025-07-30T06:15:00\",\n \"arrivalCity\": \"Dubai (Dubai International Airport)\",\n \"departure\": \"2025-07-29T18:00:00\",\n \"departureCity\": \"Accra (Kotoka International Airport)\",\n \"flightDuration\": \"PT8H15M\",\n \"flightNumber\": \"EK788\"\n }\n ],\n \"layovers\": [],\n \"segments\": [\n {\n \"aircraft\": {\n \"code\": \"77W\"\n },\n \"arrival\": {\n \"at\": \"2025-07-30T06:15:00\",\n \"iataCode\": \"DXB\",\n \"terminal\": \"3\"\n },\n \"blacklistedInEU\": false,\n \"carrierCode\": \"EK\",\n \"departure\": {\n \"at\": \"2025-07-29T18:00:00\",\n \"iataCode\": \"ACC\",\n \"terminal\": \"3\"\n },\n \"duration\": \"PT8H15M\",\n \"id\": \"1\",\n \"number\": \"788\",\n \"numberOfStops\": 0,\n \"operating\": {\n \"carrierCode\": \"EK\"\n }\n }\n ]\n }\n ],\n \"lastTicketingDate\": \"2025-07-29\",\n \"lastTicketingDateTime\": \"2025-07-29\",\n \"nonHomogeneous\": false,\n \"numberOfBookableSeats\": 9,\n \"oneWay\": false,\n \"price\": {\n \"base\": \"352.00\",\n \"currency\": \"USD\",\n \"fees\": [\n {\n \"amount\": \"0.00\",\n \"type\": \"SUPPLIER\"\n },\n {\n \"amount\": \"0.00\",\n \"type\": \"TICKETING\"\n }\n ],\n \"grandTotal\": \"549.40\",\n \"total\": \"549.40\"\n },\n \"pricingOptions\": {\n \"fareType\": [\n \"PUBLISHED\"\n ],\n \"includedCheckedBagsOnly\": true\n },\n \"source\": \"GDS\",\n \"travelerPricings\": [\n {\n \"fareDetailsBySegment\": [\n {\n \"amenities\": [\n {\n \"amenityProvider\": {\n \"name\": \"BrandedFare\"\n },\n \"amenityType\": \"PRE_RESERVED_SEAT\",\n \"description\": \"PRE RESERVED SEAT ASSIGNMENT\",\n \"isChargeable\": true\n },\n {\n \"amenityProvider\": {\n \"name\": \"BrandedFare\"\n },\n \"amenityType\": \"MEAL\",\n \"description\": \"BEVERAGE\",\n \"isChargeable\": false\n },\n {\n \"amenityProvider\": {\n \"name\": \"BrandedFare\"\n },\n \"amenityType\": \"MEAL\",\n \"description\": \"MEAL VOUCHER\",\n \"isChargeable\": false\n },\n {\n \"amenityProvider\": {\n \"name\": \"BrandedFare\"\n },\n \"amenityType\": \"BRANDED_FARES\",\n \"description\": \"REFUNDABLE TICKET\",\n \"isChargeable\": true\n },\n {\n \"amenityProvider\": {\n \"name\": \"BrandedFare\"\n },\n \"amenityType\": \"BRANDED_FARES\",\n \"description\": \"UPGRADE ELIGIBILITY\",\n \"isChargeable\": true\n },\n {\n \"amenityProvider\": {\n \"name\": \"BrandedFare\"\n },\n \"amenityType\": \"BRANDED_FARES\",\n \"description\": \"CHANGEABLE TICKET\",\n \"isChargeable\": true\n },\n {\n \"amenityProvider\": {\n \"name\": \"BrandedFare\"\n },\n \"amenityType\": \"BRANDED_FARES\",\n \"description\": \"30 PERCENT MILES EARNED\",\n \"isChargeable\": false\n }\n ],\n \"brandedFare\": \"ECOSAVER\",\n \"brandedFareLabel\": \"ECO SAVER\",\n \"cabin\": \"ECONOMY\",\n \"class\": \"L\",\n \"fareBasis\": \"LSSOPGH1\",\n \"includedCabinBags\": {\n \"quantity\": 1\n },\n \"includedCheckedBags\": {\n \"quantity\": 2\n },\n \"segmentId\": \"1\"\n }\n ],\n \"fareOption\": \"STANDARD\",\n \"price\": {\n \"base\": \"352.00\",\n \"currency\": \"USD\",\n \"total\": \"549.40\"\n },\n \"travelerId\": \"1\",\n \"travelerType\": \"ADULT\"\n }\n ],\n \"type\": \"flight-offer\",\n \"validatingAirlineCodes\": [\n \"EK\"\n ]\n }\n ],\n \"route\": \"ACC → DXB\"\n }\n ]\n}"}],"_postman_id":"073b1a35-687c-4652-8e79-79535f082906"}],"id":"1be3555a-7e47-48b2-af2f-d4d7d042e83d","description":"Endpoints for basic flights functions in hermex travels
\n","_postman_id":"1be3555a-7e47-48b2-af2f-d4d7d042e83d"},{"name":"send_email_2_consolidator","id":"432771ec-a13f-4296-aaec-c164404154ee","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{vault:authorization-secret}}"}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"order_id\": \"Hex_#20548787848\",\r\n \"search_id\": \"dcd4ace1-6e19-4230-93d3-a5f3c8af5111\",\r\n \"passengers\": [\r\n {\r\n \"firstName\": \"John\",\r\n \"lastName\": \"Doe\",\r\n \"gender\": \"Male\",\r\n \"dateOfBirth\": \"1990-01-01\",\r\n \"email\": \"john.doe@example.com\",\r\n \"phoneNumber\": \"1234567890\",\r\n \"documentType\": \"Passport\",\r\n \"documentNumber\": \"A1234567\",\r\n \"issuanceLocation\": \"USA\",\r\n \"issuanceDate\": \"2015-05-01\",\r\n \"expiryDate\": \"2025-05-01\",\r\n \"validityCountry\": \"USA\",\r\n \"nationality\": \"USA\",\r\n \"birthPlace\": \"New York\",\r\n \"emergencyFirstName\": \"Jane\",\r\n \"emergencyLastName\": \"Doe\",\r\n \"emergencyEmail\": \"jane.doe@example.com\",\r\n \"emergencyPhoneNumber\": \"0987654321\"\r\n }\r\n ]\r\n}\r\n","options":{"raw":{"language":"json"}}},"url":"{{baseUrl}}/flights/send_booking_email","description":"StartFragment
\nPOST /send_booking_emailThis endpoint is responsible for sending booking confirmation emails to the flight consolidator and Hermex administrators. It retrieves passenger data, validates user authentication, fetches cached search parameters, and then triggers the email service. This cached search parameters id is returned in the flight search endpoint.
\nRequired: Yes (JWT token via @jwt_required() decorator)
The token must include a uuid claim to identify the authenticated user.
{\n \"passengers\": [\n {\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"email\": \"john@example.com\"\n }\n // More passengers\n ],\n \"order_id\": \"ORD12345678\",\n \"search_id\": \"search_abc_123\"\n}\n\npassengers must be present and a valid list.
order_id and search_id must not be empty.
Cached search parameters must exist for the provided search_id.
The JWT must include a uuid to confirm user authentication.
Parse and validate incoming JSON payload.
\nValidate the presence and format of required fields.
\nRetrieve cached flight search parameters using the search_id.
Validate the presence of a uuid in the JWT.
Call the internal send_booking_email() service with order_id, passengers, and params.
200 OK{\n \"message\": \"Email sent successfully to the consolidator and Hermex admins!\"\n}\n\n400 Bad Request{\n \"message\": \"Invalid or missing 'passengers' list.\"\n}\n\n404 Not Found{\n \"error\": \"No cached search found for the given search_id.\"\n}\n\n401 Unauthorized{\n \"error\": \"User authentication failed.\"\n}\n\n500 Internal Server Error{\n \"message\": \"Failed to process the request\",\n \"error\": \"Detailed error message\"\n}\n\ncache: Must support .get() to retrieve search parameters via key.
send_booking_email(order_id, passengers, params): Must be implemented elsewhere to send the actual email.
logger.exception(): Used for detailed error logging.
Endpoints for flights in hermex travels
\n","_postman_id":"672fb3a6-6ffd-4723-9337-f39a3948eb1b"},{"name":"Location Endpoints","item":[{"name":"flights/recommended_locations","id":"ff9673c3-0f3f-4fa2-985e-80891fe8ab17","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{baseUrl}}/api/recommended_locations","description":"This endpoint makes an HTTP GET request to retrieve a list of recommended locations based on the provided city and categories.
\ncity (string, required): The city for which recommended locations are requested.
categories (string, required): The categories of locations to be included in the recommendations.
limit (integer, optional): The maximum number of recommended locations to be returned.
GET {{baseUrl}}/api/recommended_locations\n\nThe API returns a JSON object with the following properties:
\nrecommended_locations (array): An array of recommended locations, each containing the following properties:
address (string): The address of the recommended location.
category (array): The categories of the recommended location.
description (string): The description of the recommended location.
latitude (number): The latitude coordinate of the recommended location.
longitude (number): The longitude coordinate of the recommended location.
name (string): The name of the recommended location.
rating (number): The rating of the recommended location.
status (string): The status of the response.
{\n \"address\": \"Galata Tower, Büyük Hendek Caddesi, 34420 Beyoğlu, Turkey\",\n \"category\": [\n \"building\",\n \"building.historic\",\n \"building.tourism\",\n \"fee\",\n \"man_made\",\n \"man_made.tower\",\n \"tourism\",\n \"tourism.attraction\",\n \"tourism.sights\",\n \"tourism.sights.tower\"\n ],\n \"image_url\": \"https://pixabay.com/get/g72843376732adcdc29f3a8e117bf68ff8bc02633993d510ef3989fa2469bcfd3f3d55f4f38f1455108af3cb780032a2a1d7fb99eb6b81e3e4661509179740956_640.jpg\",\n \"latitude\": 41.025640600395,\n \"longitude\": 28.974213369331654,\n \"name\": \"Galata Kulesi\"\n }\n\n| ID | \r","Instant Ticketing Required | \r","Is Upsell Offer | \r","Duration | \r","Aircraft Code | \r","Arrival Time | \r","Departure Time | \r","Operating Carrier Code | \r","Price Base | \r","Currency | \r","Grand Total | \r","Total Price | \r","Fare Type | \r","Included Checked Bags Only | \r","Source | \r","Last Ticketing Date | \r","Non-Homogeneous | \r","Number of Bookable Seats | \r","One Way | \r","Last Ticketing Date Time | \r","Validating Airline Codes | \r","
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| {{id}} | \r","{{instantTicketingRequired}} | \r","{{isUpsellOffer}} | \r","{{itineraries.[0].duration}} | \r","{{itineraries.[0].segments.[0].aircraft.code}} | \r","{{itineraries.[0].segments.[0].arrival.at}} | \r","{{itineraries.[0].segments.[0].departure.at}} | \r","{{itineraries.[0].segments.[0].operating.carrierCode}} | \r","{{price.base}} | \r","{{price.currency}} | \r","{{price.grandTotal}} | \r","{{price.total}} | \r","{{pricingOptions.fareType.[0]}} | \r","{{pricingOptions.includedCheckedBagsOnly}} | \r","{{source}} | \r","{{lastTicketingDate}} | \r","{{nonHomogeneous}} | \r","{{numberOfBookableSeats}} | \r","{{oneWay}} | \r","{{lastTicketingDateTime}} | \r","{{validatingAirlineCodes}} | \r","
The API endpoint POST /api/search_multi_city is used to search for multi-city flight offers.
The request body should be in JSON format and include the following parameters:
\noriginDestinations (array of objects): Contains details of the origin and destination locations, along with the departure date and time range.
travelers (array of objects): Contains details of the travelers, including traveler type.
sources (array of strings): Contains the sources for the flight search.
searchCriteria (object): Contains the search criteria, including the maximum number of flight offers.
The response will be in JSON format with a status code of 200. It will include an array of flight offer objects, each containing the following properties:
\nid (string): The ID of the flight offer.
instantTicketingRequired (boolean): Indicates if instant ticketing is required for the offer.
isUpsellOffer (boolean): Indicates if the offer is an upsell offer.
itineraries (array of objects): Contains details of the itineraries, including duration and segments.
lastTicketingDate (string): The last ticketing date for the offer.
lastTicketingDateTime (string): The last ticketing date and time for the offer.
nonHomogeneous (boolean): Indicates if the offer is non-homogeneous.
numberOfBookableSeats (number): The number of bookable seats for the offer.
oneWay (boolean): Indicates if the offer is for a one-way trip.
price (object): Contains details of the price, including base, currency, fees, and grand total.
pricingOptions (object): Contains pricing options, including fare type and included checked bags only.
source (string): The source of the flight offer.
travelerPricings (array of objects): Contains details of the traveler pricings, including fare details by segment and price.
type (string): The type of the flight offer.
validatingAirlineCodes (array of strings): Contains the validating airline codes for the offer.
The response of this request can be documented as a JSON schema.
\n","urlObject":{"protocol":"http","port":"5000","path":["api","search_multi_city"],"host":["127","0","0","1"],"query":[],"variable":[]}},"response":[],"_postman_id":"79ac4397-09c6-4683-86d8-5930c29e0853"}],"id":"dcfb8cd1-a036-4e18-b22c-08ac086b45f4","description":"Endpoints for locations in hermex travels
\n","_postman_id":"dcfb8cd1-a036-4e18-b22c-08ac086b45f4"},{"name":"Activities Endpoints","item":[{"name":"Basic Activities","item":[{"name":"flights/tours_activities","id":"2fc8f7f8-4196-4fcb-9725-2aa2ac9f9ce6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://praiseordu.pythonanywhere.com/api/tours_activities?latitude=40.71455&longitude=-74.00714","description":"The GET request retrieves a list of tours and activities based on the provided latitude, longitude, and radius parameters.
The response is in JSON format and represents an array of tour and activity objects. Each object includes the following properties:
\ngeoCode: An object containing the latitude and longitude of the location.
id: The unique identifier of the tour or activity.
minimumDuration: The minimum duration of the tour or activity.
name: The name of the tour or activity.
pictures: An array of URLs to pictures related to the tour or activity.
price: An object containing the currency code of the price.
self: An object with the href and methods properties.
type: The type of the tour or activity.
Example response:
\n[\n {\n \"geoCode\": {\n \"latitude\": 0,\n \"longitude\": 0\n },\n \"id\": \"\",\n \"minimumDuration\": \"\",\n \"name\": \"\",\n \"pictures\": [\"\"],\n \"price\": {\n \"currencyCode\": \"\"\n },\n \"self\": {\n \"href\": \"\",\n \"methods\": [\"\"]\n },\n \"type\": \"\"\n }\n]\n\nThis endpoint retrieves autocomplete suggestions based on the provided query.
\nThe response is a JSON object with the following schema:
\n{\n \"results\": [\n {\n \"airport_name\": \"\",\n \"city_name\": \"\",\n \"country_name\": \"\",\n \"iata_code\": \"\"\n }\n ]\n}\n\nThe results array contains objects with fields for airport name, city name, country name, and IATA code. The values for these fields will be populated based on the provided query.
This endpoint retrieves the details of a specific activity.
\nNo request body is required for this endpoint.
\nactivityId (path parameter) - The ID of the activity to retrieve.The response will be in JSON format with the following schema:
\n{\n \"activityId\": \"\",\n \"description\": null,\n \"name\": \"\",\n \"price\": 0\n}\n\nactivityId (string) - The ID of the activity.
description (string or null) - The description of the activity, if available.
name (string) - The name of the activity.
price (number) - The price of the activity.
Endpoints for basic activities in hermex travels
\n","_postman_id":"28ae6898-2232-40ba-a603-d7a97b82713f"},{"name":"ADV. Activities","item":[{"name":"api/book_transfer","id":"5d0b2e43-4112-4e32-8a3d-a0b7ce3b1663","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{vault:authorization-secret}}"}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"data\": {\r\n \"note\": \"Note to driver\",\r\n \"passengers\": [\r\n {\r\n \"firstName\": \"John\",\r\n \"lastName\": \"Doe\",\r\n \"title\": \"MR\",\r\n \"contacts\": {\r\n \"phoneNumber\": \"+33123456789\",\r\n \"email\": \"user@email.com\"\r\n },\r\n \"billingAddress\": {\r\n \"line\": \"Avenue de la Bourdonnais, 19\",\r\n \"zip\": \"75007\",\r\n \"countryCode\": \"FR\",\r\n \"cityName\": \"Paris\"\r\n }\r\n }\r\n ],\r\n \"agency\": {\r\n \"contacts\": [\r\n {\r\n \"email\": {\r\n \"address\": \"abc@test.com\"\r\n }\r\n }\r\n ]\r\n },\r\n \"payment\": {\r\n \"methodOfPayment\": \"CREDIT_CARD\",\r\n \"creditCard\": {\r\n \"number\": \"4111111111111111\",\r\n \"holderName\": \"JOHN DOE\",\r\n \"vendorCode\": \"VI\",\r\n \"expiryDate\": \"1018\",\r\n \"cvv\": \"111\"\r\n }\r\n },\r\n \"extraServices\": [\r\n {\r\n \"code\": \"EWT\",\r\n \"itemId\": \"EWT0291\"\r\n }\r\n ],\r\n \"equipment\": [\r\n {\r\n \"code\": \"BBS\"\r\n }\r\n ],\r\n \"corporation\": {\r\n \"address\": {\r\n \"line\": \"5 Avenue Anatole France\",\r\n \"zip\": \"75007\",\r\n \"countryCode\": \"FR\",\r\n \"cityName\": \"Paris\"\r\n },\r\n \"info\": {\r\n \"AU\": \"FHOWMD024\",\r\n \"CE\": \"280421GH\"\r\n }\r\n },\r\n \"startConnectedSegment\": {\r\n \"transportationType\": \"FLIGHT\",\r\n \"transportationNumber\": \"AF176\",\r\n \"departure\": {\r\n \"uicCode\": \"7400001\",\r\n \"iataCode\": \"JFK\",\r\n \"localDateTime\": \"2024-08-19T17:00:00\"\r\n },\r\n \"arrival\": {\r\n \"uicCode\": \"7400001\",\r\n \"iataCode\": \"LHR\",\r\n \"localDateTime\": \"2024-08-20T08:05:00\"\r\n }\r\n },\r\n \"endConnectedSegment\": {\r\n \"transportationType\": \"FLIGHT\",\r\n \"transportationNumber\": \"AF380\",\r\n \"departure\": {\r\n \"uicCode\": \"7400001\",\r\n \"iataCode\": \"CDG\",\r\n \"localDateTime\": \"2024-08-19T20:00:00\"\r\n },\r\n \"arrival\": {\r\n \"uicCode\": \"7400001\",\r\n \"iataCode\": \"CDG\",\r\n \"localDateTime\": \"2024-08-19T20:00:00\"\r\n }\r\n }\r\n }\r\n}\r\n","options":{"raw":{"language":"json"}}},"url":"http://127.0.0.1:5000/api/book_transfer?offerId =0741476933","description":"This endpoint is used to book a transfer with the provided offer ID.
\ndata (object)
note (string, optional)
passengers (array)
firstName (string)
lastName (string)
title (string)
contacts (object)
phoneNumber (string)
email (string)
billingAddress (object)
line (string)
zip (string)
countryCode (string)
cityName (string)
agency (object)
contacts (array)
email (object)
address (string)payment (object)
methodOfPayment (string)
creditCard (object)
number (string)
holderName (string)
vendorCode (string)
expiryDate (string)
cvv (string)
extraServices (array)
code (string)
itemId (string)
equipment (array)
code (string)corporation (object)
address (object)
line (string)
zip (string)
countryCode (string)
cityName (string)
info (object)
AU (string)
CE (string)
startConnectedSegment (object)
transportationType (string)
transportationNumber (string)
departure (object)
uicCode (string)
iataCode (string)
localDateTime (string)
arrival (object)
uicCode (string)
iataCode (string)
localDateTime (string)
endConnectedSegment (object)
transportationType (string)
transportationNumber (string)
departure (object)
uicCode (string)
iataCode (string)
localDateTime (string)
arrival (object)
uicCode (string)
iataCode (string)
localDateTime (string)
{\n \"type\": \"object\",\n \"properties\": {\n \"id\": { \"type\": \"string\" },\n \"passengers\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"object\",\n \"properties\": {\n \"contacts\": {\n \"type\": \"object\",\n \"properties\": {\n \"email\": { \"type\": \"string\" },\n \"phoneNumber\": { \"type\": \"string\" }\n }\n },\n \"firstName\": { \"type\": \"string\" },\n \"lastName\": { \"type\": \"string\" },\n \"title\": { \"type\": \"string\" }\n }\n }\n },\n \"reference\": { \"type\": \"string\" },\n \"transfers\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"object\",\n \"properties\": {\n \"cancellationRules\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"object\",\n \"properties\": {\n \"currencyCode\": { \"type\": \"string\" },\n \"feeType\": { \"type\": \"string\" },\n \"feeValue\": { \"type\": \"string\" },\n \"metricMax\": { \"type\": \"string\" },\n \"metricMin\": { \"type\": \"string\" },\n \"metricType\": { \"type\": \"string\" },\n \"ruleDescription\": { \"type\": \"string\" }\n }\n }\n },\n \"confirmNbr\": { \"type\": \"string\" },\n \"converted\": {\n \"type\": \"object\",\n \"properties\": {\n \"currencyCode\": { \"type\": \"string\" },\n \"isEstimated\": { \"type\": \"boolean\" },\n \"monetaryAmount\": { \"type\": \"string\" },\n \"taxes\": {\n \"type\": \"array\",\n \"items\": { \"type\": \"string\" }\n },\n \"totalFees\": { \"type\": \"string\" },\n \"totalTaxes\": { \"type\": \"string\" }\n }\n },\n \"end\": {\n \"type\": \"object\",\n \"properties\": {\n \"dateTime\": { \"type\": \"string\" },\n \"locationCode\": { \"type\": \"string\" }\n }\n },\n \"methodOfPayment\": { \"type\": \"string\" },\n \"offerId\": { \"type\": \"string\" },\n \"quotation\": {\n \"type\": \"object\",\n \"properties\": {\n \"currencyCode\": { \"type\": \"string\" },\n \"isEstimated\": { \"type\": \"boolean\" },\n \"monetaryAmount\": { \"type\": \"string\" },\n \"taxes\": {\n \"type\": \"array\",\n \"items\": { \"type\": \"string\" }\n },\n \"totalFees\": { \"type\": \"string\" },\n \"totalTaxes\": { \"type\": \"string\" }\n }\n },\n \"serviceProvider\": {\n \"type\": \"object\",\n \"properties\": {\n \"code\": { \"type\": \"string\" },\n \"logoUrl\": { \"type\": \"string\" },\n \"name\": { \"type\": \"string\" },\n \"termsUrl\": { \"type\": \"string\" }\n }\n },\n \"start\": {\n \"type\": \"object\",\n \"properties\": {\n \"dateTime\": { \"type\": \"string\" },\n \"locationCode\": { \"type\": \"string\" }\n }\n },\n \"status\": { \"type\": \"string\" },\n \"transferType\": { \"type\": \"string\" },\n \"vehicle\": {\n \"type\": \"object\",\n \"properties\": {\n \"baggages\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"object\",\n \"properties\": {\n \"count\": { \"type\": \"integer\" },\n \"size\": { \"type\": \"string\" }\n }\n }\n },\n \"category\": { \"type\": \"string\" },\n \"code\": { \"type\": \"string\" },\n \"description\": { \"type\": \"string\" },\n \"imageURL\": { \"type\": \"string\" },\n \"seats\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"object\",\n \"properties\": {\n \"count\": { \"type\": \"integer\" }\n }\n }\n }\n }\n }\n }\n }\n },\n \"type\": { \"type\": \"string\" }\n }\n}\n\nThis endpoint is used to transfer offers.
\nstartLocationCode (string): The code for the starting location.
endAddressLine (string): The address line for the end location.
endCityName (string): The city name for the end location.
endZipCode (string): The zip code for the end location.
endCountryCode (string): The country code for the end location.
endName (string): The name of the end location.
endGeoCode (string): The geographic code for the end location.
transferType (string): The type of transfer.
startDateTime (string): The start date and time for the transfer.
passengers (number): The number of passengers.
stopOvers (array): An array of stopover details including duration, address, city, country, zip code, name, and geographic code.
startConnectedSegment (object): Details of the connected segment including transportation type, number, departure, and arrival information.
passengerCharacteristics (array): An array of passenger characteristics including type code and age.
The response is in JSON format and follows the schema below:
\n{\n \"data\": [\n {\n \"cancellationRules\": [\n {\n \"feeType\": \"string\",\n \"feeValue\": \"string\",\n \"metricMax\": \"string\",\n \"metricType\": \"string\",\n \"ruleDescription\": \"string\"\n }\n ],\n \"converted\": {\n \"base\": {\n \"monetaryAmount\": \"string\"\n },\n \"currencyCode\": \"string\",\n \"monetaryAmount\": \"string\",\n \"taxes\": [\n {\n \"monetaryAmount\": \"string\"\n }\n ],\n \"totalFees\": {\n \"monetaryAmount\": \"string\"\n },\n \"totalTaxes\": {\n \"monetaryAmount\": \"string\"\n }\n },\n \"distance\": {\n \"unit\": \"string\",\n \"value\": 0\n },\n \"end\": {\n \"address\": {\n \"cityName\": \"string\",\n \"countryCode\": \"string\",\n \"latitude\": 0,\n \"line\": \"string\",\n \"longitude\": 0,\n \"zip\": \"string\"\n },\n \"dateTime\": \"string\"\n },\n \"id\": \"string\",\n \"language\": \"string\",\n \"methodsOfPaymentAccepted\": [\n \"string\"\n ],\n \"passengerCharacteristics\": [\n {\n \"age\": 0,\n \"passengerTypeCode\": \"string\"\n }\n ],\n \"quotation\": {\n \"base\": {\n \"monetaryAmount\": \"string\"\n },\n \"currencyCode\": \"string\",\n \"monetaryAmount\": \"string\",\n \"taxes\": [\n {\n \"monetaryAmount\": \"string\"\n }\n ],\n \"totalFees\": {\n \"monetaryAmount\": \"string\"\n },\n \"totalTaxes\": {\n \"monetaryAmount\": \"string\"\n }\n },\n \"serviceProvider\": {\n \"code\": \"string\",\n \"logoUrl\": \"string\",\n \"name\": \"string\",\n \"termsUrl\": \"string\"\n },\n \"start\": {\n \"dateTime\": \"string\",\n \"locationCode\": \"string\"\n },\n \"transferType\": \"string\",\n \"type\": \"string\",\n \"vehicle\": {\n \"category\": \"string\",\n \"code\": \"string\",\n \"description\": \"string\",\n \"imageURL\": \"string\",\n \"seats\": [\n {\n \"count\": 0\n }\n ]\n }\n }\n ]\n}\n\nThis endpoint is used to confirm bookings by sending an HTTP POST request to the specified URL.
\ntime_frame (number): Specifies the time frame for the booking confirmation.Status: 200
\nContent-Type: application/json
\nmessage (string): A message indicating the result of the booking confirmation.
This HTTP POST request is used to access the branded fares upsell API. The request body should be in raw format and include parameters such as id, instantTicketingRequired, isUpsellOffer, itineraries, lastTicketingDate, nonHomogeneous, numberOfBookableSeats, oneWay, price, pricingOptions, source, travelerPricings, type, and validatingAirlineCodes. The response will be in JSON format with parameters including id, instantTicketingRequired, itineraries, lastTicketingDate, paymentCardRequired, price, pricingOptions, source, travelerPricings, type, and validatingAirlineCodes. The response will also include a status code of 200 and content type of application/json.
\n","urlObject":{"path":["api","branded-fares-upsell"],"host":["{{baseUrl}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"ebf1d4f2-a98f-47f3-b516-53187df08108"},{"name":"api/cancel_transfer/This HTTP POST request is used to cancel a transfer with a specific confirmation number. The request should include the confirmation number as a query parameter in the URL. The expected input for this request is the confirmation number of the transfer to be canceled. The format of the response is in JSON and the status code returned is 200 upon successful cancellation.
\n","urlObject":{"protocol":"http","port":"5000","path":["api","cancel_transfer","M1NVU0VHfElDSEFBVENSRVNVQVR8MjAyNC0wOC0xN1QyMjoyMToxMA"],"host":["127","0","0","1"],"query":[{"key":"confirmNbr","value":"58456688"}],"variable":[]}},"response":[],"_postman_id":"0796eeec-4064-4020-ba38-f7e86767bbb1"}],"id":"8886266f-7378-449b-9733-a583a88ae406","description":"Endpoints for advanced activities in hermex travels
\n","_postman_id":"8886266f-7378-449b-9733-a583a88ae406"}],"id":"e6768855-f621-46b0-a27b-61392e100a47","description":"Endpoints for activities in hermex travels
\n","_postman_id":"e6768855-f621-46b0-a27b-61392e100a47"},{"name":"Transfers","item":[{"name":"transfers/transfer_offers","id":"b9294865-5d82-4a10-bd6e-6c88ba47e69b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"startLocationCode\": \"CDG\",\n \"endAddressLine\": \"Avenue Anatole France, 5\",\n \"endCityName\": \"Paris\",\n \"endZipCode\": \"75007\",\n \"endCountryCode\": \"FR\",\n \"endName\": \"Souvenirs De La Tour\",\n \"endGeoCode\": \"48.859466,2.2976965\",\n \"transferType\": \"PRIVATE\",\n \"startDateTime\": \"2025-04-25T10:30:00\",\n \"passengers\": 2,\n \"stopOvers\": [\n {\n \"duration\": \"PT2H30M\",\n \"sequenceNumber\": 1,\n \"addressLine\": \"Avenue de la Bourdonnais, 19\",\n \"countryCode\": \"FR\",\n \"cityName\": \"Paris\",\n \"zipCode\": \"75007\",\n \"name\": \"De La Tours\",\n \"geoCode\": \"48.859477,2.2976985\",\n \"stateCode\": \"FR\"\n }\n ],\n \"startConnectedSegment\": {\n \"transportationType\": \"FLIGHT\",\n \"transportationNumber\": \"AF380\",\n \"departure\": {\n \"localDateTime\": \"2025-04-25T09:00:00\",\n \"iataCode\": \"NCE\"\n },\n \"arrival\": {\n \"localDateTime\": \"2025-04-25T10:00:00\",\n \"iataCode\": \"CDG\"\n }\n },\n \"passengerCharacteristics\": [\n {\n \"passengerTypeCode\": \"ADT\",\n \"age\": 20\n },\n {\n \"passengerTypeCode\": \"CHD\",\n \"age\": 10\n }\n ]\n}\n","options":{"raw":{"language":"json"}}},"url":"{{baseUrl}}/transfers/transfer_offers","description":"The endpoint allows you to create transfer offers by making an HTTP POST request to the specified URL. The request should include a payload in raw JSON format, containing details such as start location, end location, transfer type, start date and time, passengers, stop overs, start connected segment, and passenger characteristics.
\nThe response to the request is a JSON object with a \"data\" array containing transfer offer details. To document the response as a JSON schema, you can use the provided response data as the schema definition for the \"data\" array. This will help consumers understand the structure and properties of the response data.
\nHere is an example of how the response data can be used to define the JSON schema for the \"data\" array:
\n{\n \"type\": \"object\",\n \"properties\": {\n \"data\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"object\",\n \"properties\": {\n \"cancellationRules\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"object\",\n \"properties\": {\n \"feeType\": {\"type\": \"string\"},\n \"feeValue\": {\"type\": \"string\"},\n \"metricMax\": {\"type\": \"string\"},\n \"metricType\": {\"type\": \"string\"},\n \"ruleDescription\": {\"type\": \"string\"}\n }\n }\n },\n \"converted\": {\n \"type\": \"object\",\n \"properties\": {\n \"base\": {\n \"type\": \"object\",\n \"properties\": {\n \"monetaryAmount\": {\"type\": \"string\"}\n }\n },\n \"currencyCode\": {\"type\": \"string\"},\n \"monetaryAmount\": {\"type\": \"string\"},\n \"taxes\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"object\",\n \"properties\": {\n \"monetaryAmount\": {\"type\": \"string\"}\n }\n }\n },\n \"totalFees\": {\n \"type\": \"object\",\n \"properties\": {\n \"monetaryAmount\": {\"type\": \"string\"}\n }\n },\n \"totalTaxes\": {\n \"type\": \"object\",\n \"properties\": {\n \"monetaryAmount\": {\"type\": \"string\"}\n }\n }\n }\n },\n // ... (continue defining other properties based on the response data)\n }\n }\n }\n }\n}\n\nThis is for Car Transfers
\n","_postman_id":"31d07f59-f7f6-4bec-ada6-3b6c6d615e6a"},{"name":"Payments","item":[{"name":"Fincra Payment Endpoints","item":[{"name":"fincra/initialize_payment","id":"05f5e483-4e58-464d-81c0-9b5a4b93cedd","protocolProfileBehavior":{"disableBodyPruning":true,"disabledSystemHeaders":{}},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{vault:authorization-secret}}"}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"amount\": 1000,\n \"currency\": \"NGN\",\n \"description\": \"Payment for order #123\",\n \"email\" : \"praiseordu@gmail.com\",\n \"phone_number\" : \"09033063223\"\n}\n","options":{"raw":{"language":"json"}}},"url":"{{baseUrl}}/fincra/initialize_payment","description":"This endpoint is used to initialize a payment for an order.
\nMethod: POST
\nBase URL: {{baseUrl}}
\nEndpoint: /fincra/initialize_payment
\nBody:
\namount (number, required): The amount to be paid.
\ncurrency (string, required): The currency in which the payment is to be made.
\ndescription (string, required): A description of the payment.
\nemail (string, required): The email of the payer.
\nphone_number (string, required): The phone number of the payer.
\nThe response for this request is in JSON format and follows the schema below:
\n{\n \"type\": \"object\",\n \"properties\": {\n \"Hermex transaction_fee\": {\n \"type\": \"number\"\n },\n \"message\": {\n \"type\": \"string\"\n },\n \"note\": {\n \"type\": \"string\"\n },\n \"payment_link\": {\n \"type\": \"string\"\n }\n }\n}\n\nStatus: 200
\nContent-Type: application/json
\nThe response contains the following fields:
\nHermex transaction_fee (number): The transaction fee for the payment.
\nmessage (string): A message related to the payment initialization.
\nnote (string): Additional notes related to the payment.
\npayment_link (string): The link to proceed with the payment.
\nThis endpoint retrieves the verification status of a FinCra payment transaction. The response contains a JSON schema with the details of the transaction status and data.
\n{\n \"type\": \"object\",\n \"properties\": {\n \"message\": {\n \"type\": \"string\"\n },\n \"transaction_data\": {\n \"type\": \"object\",\n \"properties\": {\n \"data\": {\n \"type\": \"object\",\n \"properties\": {\n \"amount\": {\n \"type\": \"number\"\n },\n \"amountReceived\": {\n \"type\": \"number\"\n },\n \"business\": {\n \"type\": \"object\",\n \"properties\": {\n \"_id\": {\n \"type\": \"string\"\n },\n \"businessKey\": {\n \"type\": \"string\"\n },\n \"businessTag\": {\n \"type\": \"number\"\n },\n \"businessType\": {\n \"type\": \"string\"\n },\n \"checkoutSettings\": {\n \"type\": \"object\",\n \"properties\": {\n \"backgroundColor\": {\n \"type\": \"string\"\n },\n \"backgroundTextColor\": {\n \"type\": \"string\"\n },\n \"buttonColor\": {\n \"type\": \"string\"\n },\n \"buttonTextColor\": {\n \"type\": \"string\"\n },\n \"fontColor\": {\n \"type\": \"string\"\n },\n \"fontFamily\": {\n \"type\": \"string\"\n },\n \"useBrandLogo\": {\n \"type\": \"boolean\"\n }\n }\n },\n \"country\": {\n \"type\": \"string\"\n },\n \"countryCallingCode\": {\n \"type\": \"string\"\n },\n \"createdAt\": {\n \"type\": \"string\"\n },\n \"email\": {\n \"type\": \"string\"\n },\n \"emailSettings\": {\n \"type\": \"object\",\n \"properties\": {\n \"collectionNotification\": {\n \"type\": \"boolean\"\n },\n \"paymentReceiptNotification\": {\n \"type\": \"boolean\"\n },\n \"settlementNotification\": {\n \"type\": \"boolean\"\n },\n \"topupNotification\": {\n \"type\": \"boolean\"\n }\n }\n },\n \"isBlocked\": {\n \"type\": \"boolean\"\n },\n \"isKYCApproved\": {\n \"type\": \"boolean\"\n },\n \"mobile\": {\n \"type\": \"string\"\n },\n \"name\": {\n \"type\": \"string\"\n },\n \"settings\": {\n \"type\": \"object\",\n \"properties\": {\n \"acceptMispayments\": {\n \"type\": \"boolean\"\n },\n \"enableWebhook\": {\n \"type\": \"boolean\"\n },\n \"feeBearer\": {\n \"type\": \"string\"\n },\n \"settlementDestination\": {\n \"type\": \"string\"\n }\n }\n },\n \"settlementSettings\": {\n \"type\": \"null\"\n },\n \"status\": {\n \"type\": \"string\"\n },\n \"updatedAt\": {\n \"type\": \"string\"\n }\n }\n },\n \"businessId\": {\n \"type\": \"string\"\n },\n \"convertedAmount\": {\n \"type\": \"number\"\n },\n \"convertedCurrency\": {\n \"type\": \"string\"\n },\n \"createdAt\": {\n \"type\": \"string\"\n },\n \"currency\": {\n \"type\": \"string\"\n },\n \"customUrl\": {\n \"type\": \"null\"\n },\n \"customer\": {\n \"type\": \"object\",\n \"properties\": {\n \"email\": {\n \"type\": \"string\"\n },\n \"name\": {\n \"type\": \"string\"\n },\n \"phoneNumber\": {\n \"type\": \"null\"\n }\n }\n },\n \"defaultPaymentMethod\": {\n \"type\": \"string\"\n },\n \"feeBearer\": {\n \"type\": \"string\"\n },\n \"id\": {\n \"type\": \"number\"\n },\n \"isDisabled\": {\n \"type\": \"boolean\"\n },\n \"merchantReference\": {\n \"type\": \"string\"\n },\n \"metadata\": {\n \"type\": \"null\"\n },\n \"paymentLinkId\": {\n \"type\": \"null\"\n },\n \"paymentMethods\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"string\"\n }\n },\n \"quoteReference\": {\n \"type\": \"null\"\n },\n \"redirectUrl\": {\n \"type\": \"string\"\n },\n \"reference\": {\n \"type\": \"string\"\n },\n \"settlementDestination\": {\n \"type\": \"string\"\n },\n \"status\": {\n \"type\": \"string\"\n },\n \"successMessage\": {\n \"type\": \"null\"\n },\n \"updatedAt\": {\n \"type\": \"string\"\n }\n }\n },\n \"message\": {\n \"type\": \"string\"\n },\n \"status\": {\n \"type\": \"boolean\"\n }\n }\n },\n \"transaction_status\": {\n \"type\": \"boolean\"\n }\n }\n}\n\n{\n \"message\": \"\",\n \"transaction_data\": {\n \"data\": {\n \"amount\": 0,\n \"amountReceived\": 0,\n \"business\": {\n \"_id\": \"\",\n \"businessKey\": \"\",\n \"businessTag\": 0,\n \"businessType\": \"\",\n \"checkoutSettings\": {\n \"backgroundColor\": null,\n \"backgroundTextColor\": null,\n \"buttonColor\": null,\n \"buttonTextColor\": null,\n \"fontColor\": null,\n \"fontFamily\": null,\n \"useBrandLogo\": true\n },\n \"country\": \"\",\n \"countryCallingCode\": \"\",\n \"createdAt\": \"\",\n \"email\": \"\",\n \"emailSettings\": {\n \"collectionNotification\": true,\n \"paymentReceiptNotification\": true,\n \"settlementNotification\": true,\n \"topupNotification\": true\n },\n \"isBlocked\": true,\n \"isKYCApproved\": true,\n \"mobile\": \"\",\n \"name\": \"\",\n \"settings\": {\n \"acceptMispayments\": true,\n \"enableWebhook\": true,\n \"feeBearer\": \"\",\n \"settlementDestination\": \"\"\n },\n \"settlementSettings\": null,\n \"status\": \"\",\n \"updatedAt\": \"\"\n },\n \"businessId\": \"\",\n \"convertedAmount\": 0,\n \"convertedCurrency\": \"\",\n \"createdAt\": \"\",\n \"currency\": \"\",\n \"customUrl\": null,\n \"customer\": {\n \"email\": \"\",\n \"name\": \"\",\n \"phoneNumber\": null\n },\n \"defaultPaymentMethod\": \"\",\n \"feeBearer\": \"\",\n \"id\": 0,\n \"isDisabled\": true,\n \"merchantReference\": \"\",\n \"metadata\": null,\n \"paymentLinkId\": null,\n \"paymentMethods\": [\"\"],\n \"quoteReference\": null,\n \"redirectUrl\": \"\",\n \"reference\": \"\",\n \"settlementDestination\": \"\",\n \"status\": \"\",\n \"successMessage\": null,\n \"updatedAt\": \"\"\n },\n \"message\": \"\",\n \"status\": true\n },\n \"transaction_status\": true\n}\n\nFor Fincra Payment Platform
\n","_postman_id":"cb82bf0d-3dda-4bf1-a852-5ec342f7bd22"},{"name":"Flutterwave Payment Endpoint","item":[{"name":"payments/flutterwave/initialize_payment","id":"111c1a15-c66b-4bd5-aab6-393f601c2ff2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{vault:authorization-secret}}"}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"amount\": 249.20,\r\n \"email\": \"boronicle@gmail.com\",\r\n \"phone_number\": \"+123456789\",\r\n \"booking_type\": \"FLIGHT\",\r\n \"currency\": \"USD\",\r\n \"booking_id\": \"c7b19685-a837-44cb-a4e1-05ca624cf1d1\",\r\n \"order_id\": \"HeX_#-250401248518\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{baseUrl}}/payments/flutterwave/initialize_payment","description":"This document outlines the initialize_payment route of the Flask backend for integrating payment transactions using Flutterwave. It is intended to guide the frontend and mobile teams on how to consume this endpoint.
URL: /initialize_payment
Method: POST
Authorization: Bearer Token (JWT)
Content-Type: application/json
Initializes a payment transaction with Flutterwave, including a 3% transaction fee. The response provides a breakdown of the fee, making customers aware of the extra charge.
\nThe request body should be in JSON format and include the following fields:
\n{\n \"amount\": 100.00,\n \"currency\": \"USD\",\n \"email\": \"john.doe@example.com\",\n \"phone_number\": \"1234567890\",\n \"booking_type\": \"HOTEL\",\n \"order_id\": \"ORD123456\",\n \"booking_id\": \"BKG987654\"\n}\n\n{\n \"message\": \"Payment initialized\",\n \"payment_link\": \"https://flutterwave.com/pay/xyz123\",\n \"transaction_fee\": 3.00,\n \"note\": \"A 3% transaction fee has been added to your payment\"\n}\n\nJWT Authentication:
\nEnsure the JWT token is passed in the Authorization header.
Redirect to login if a 401 Unauthorized error is returned.
Handling Responses:
\nCheck the response code to handle success and error scenarios.
\nDisplay the payment_link to the user upon success.
Show a notification or alert if an error occurs.
\nPayment Link Navigation:
\npayment_link in a new browser tab or WebView on mobile.Transaction Fee Display:
\nThe payment gateway supports multiple options, including card, USSD, bank transfer, M-PESA, Google Pay, Apple Pay, and OPay.
\nIn case of rate limiting, the API will retry automatically.
\nMake sure to log payment initialization and transaction details to enhance troubleshooting.
\nThis endpoint is used to receive webhook notifications from the Flutterwave payment gateway. The HTTP POST request to {{baseUrl}}/payments/flutterwave/flutterwave_webhook includes a payload in the raw request body type, containing information about a completed charge event. The response to the request is a JSON object with a \"message\" key.
\nevent: (string) The type of event, in this case, \"charge.completed\"
\ndata: (object) Contains detailed information about the completed charge, including id, tx_ref, flw_ref, device_fingerprint, amount, currency, charged_amount, app_fee, merchant_fee, processor_response, auth_model, ip, narration, status, payment_type, created_at, account_id, customer, and card details.
\nThe response to the request is a JSON object with a \"message\" key. The value of the \"message\" key will provide additional information about the processing of the webhook notification.
\n","urlObject":{"path":["payments","flutterwave","flutterwave_webhook"],"host":["{{baseUrl}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"c3db91f2-2dff-4283-929f-e95abe8b3b8c"}],"id":"d78a2de6-5871-4273-8f4b-40f59fd498ca","_postman_id":"d78a2de6-5871-4273-8f4b-40f59fd498ca","description":""},{"name":"Paystack Payment Endpoint","item":[{"name":"paystack","id":"4b34cbdc-0514-4d07-8ffa-9b4518af7328","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{vault:authorization-secret}}"}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"amount\": 42.22,\r\n \"email\": \"amffloreseteresa5@gmail.com\",\r\n \"phone_number\": \"+123456789\",\r\n \"booking_type\": \"HOTEL\",\r\n \"currency\": \"GHS\",\r\n \"order_id\": \"HeX_#-250330926311\",\r\n \"booking_id\": \"b8178354-067c-459f-a6f5-d8702b6abba3\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{baseUrl}}/payments/paystack/initiate-payment","urlObject":{"path":["payments","paystack","initiate-payment"],"host":["{{baseUrl}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"4b34cbdc-0514-4d07-8ffa-9b4518af7328"}],"id":"52b55656-0214-4b27-99ea-239f24a1b8a0","_postman_id":"52b55656-0214-4b27-99ea-239f24a1b8a0","description":""}],"id":"742ab498-582b-4824-b5d8-717550493437","_postman_id":"742ab498-582b-4824-b5d8-717550493437","description":""},{"name":"Reviews","item":[{"name":"/post_reviews","id":"6f0bcfbb-0fa5-43e7-80b2-d4344010dd53","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{vault:authorization-secret}}"}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"booking_id\": \"f0a22f1d-fafb-4cbd-ab9a-76f0eeb5d131\",\r\n \"rating\": 3,\r\n \"comment\": \"Nice and cozy experience\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{baseUrl}}/reviews/post_reviews","description":"StartFragment
\nPOST /reviews/post_reviews\n\nThis endpoint allows authenticated users to submit a review for a booking.
\nThe JWT must include a \"uuid\" claim containing the user’s UUID. The backend extracts the user identifier from this claim.
\nThe request body should be sent in JSON format:
\n{\n \"booking_id\": \"string\",\n \"rating\": 5,\n \"comment\": \"Great experience!\"\n}\n\nThe review was submitted successfully.
\n{\n \"message\": \"Review submitted successfully\"\n}\n\n400 - Bad Request
\n{ \"message\": \"Missing required fields\" }
{ \"error\": \"Rating must be between 1 and 5.\" }
{ \"error\": \"Rating must be a valid integer between 1 and 5.\" }
{ \"msg\": \"Missing Authorization Header\" }
This endpoint requires the user to be authenticated using a JWT token.
\nThe token should be included as a Bearer Token in the Authorization header.
bashCopyEditcurl -X POST \"http://localhost:5000/reviews/post_reviews\" \\\n -H \"Authorization: Bearer <your_jwt_token>\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"booking_id\": \"123456\",\n \"rating\": 5,\n \"comment\": \"Great service, highly recommended!\"\n }'\n\n{\n \"message\": \"Review submitted successfully\"\n}\n\nStartFragment
\nGET /reviews/get_reviews\n\nThis endpoint retrieves a list of all reviews or filters reviews by a specific booking ID.
\nThe reviews were retrieved successfully.
\n{\n \"message\": \"Reviews retrieved successfully\",\n \"review_data\": [\n {\n \"id\": 1,\n \"user_id\": \"123456\",\n \"booking_id\": \"789012\",\n \"rating\": 5,\n \"comment\": \"Great experience!\",\n \"created_at\": \"2025-03-24T00:28:59\",\n \"updated_at\": \"2025-03-24T00:28:59\"\n },\n {\n \"id\": 2,\n \"user_id\": \"654321\",\n \"booking_id\": \"456789\",\n \"rating\": 4,\n \"comment\": \"Good service!\",\n \"created_at\": \"2025-03-23T12:10:00\",\n \"updated_at\": \"2025-03-23T12:10:00\"\n }\n ]\n}\n\n{\n \"message\": \"Reviews retrieved successfully\",\n \"review_data\": [\n {\n \"id\": 3,\n \"user_id\": \"112233\",\n \"booking_id\": \"789012\",\n \"rating\": 5,\n \"comment\": \"Amazing booking experience!\",\n \"created_at\": \"2025-03-22T11:50:00\",\n \"updated_at\": \"2025-03-22T11:50:00\"\n }\n ]\n}\n\n404 - Not Found
\nIf no reviews are found:
\n{\n \"message\": \"No reviews found.\"\n}\n\ncURL
\ncurl -X GET \"http://localhost:5000/reviews/get_reviews\"\n\ncURL
\ncurl -X GET \"http://localhost:5000/reviews/get_reviews?booking_id=789012\"\n\nEndpoint:GET /get_bookings
Description:
\nRetrieves all bookings associated with the authenticated user, including flights, hotels, car rentals, activities, and events.
\nThis endpoint requires a JWT token for authentication targeting the user_id.
\nAuthorization: Bearer
\nSuccess (200 OK)
\nReturns a list of bookings associated with the user.
\nExample Response:
\n{\n \"message\": \"My bookings retrieved successfully\",\n \"data\": {\n \"flights\": [\n {\n \"flight_id\": \"123\",\n \"destination\": \"New York\",\n \"departure_date\": \"2025-04-01\",\n \"status\": \"Confirmed\"\n }\n ],\n \"hotels\": [\n {\n \"hotel_id\": \"456\",\n \"name\": \"Grand Plaza\",\n \"check_in_date\": \"2025-04-02\",\n \"check_out_date\": \"2025-04-05\"\n }\n ],\n \"car_rentals\": [\n {\n \"car_id\": \"789\",\n \"car_name\": \"Tesla Model X\",\n \"rental_date\": \"2025-04-03\",\n \"status\": \"Reserved\"\n }\n ],\n \"activities\": [\n {\n \"activity_id\": \"321\",\n \"activity_name\": \"City Tour\",\n \"date\": \"2025-04-04\"\n }\n ],\n \"events\": [\n {\n \"event_id\": \"654\",\n \"event_name\": \"Music Festival\",\n \"event_date\": \"2025-04-06\"\n }\n ]\n }\n}\n\nError Responses:
\n{ \"message\": \"Missing or invalid token\" }
{ \"message\": \"User not found\" }
{ \"message\": \"An error occurred while retrieving bookings\" }
Request:
\nGET /get_bookings \nAuthorization: {{vault:bearer-token}}\n\nDescription:
\nRetrieves all bookings associated with the authenticated user, including flights, hotels, car rentals, activities, and events.
\nvisa/schengenvisa/applyEndpoint: visa/schengenvisa/apply
Method: POST
Authentication: JWT Token Required
Content-Type: multipart/form-data
Submits a Schengen visa application for the authenticated user. This endpoint processes form data, uploads a scanned passport, creates a visa booking record, and returns booking and application details.
\nAuthentication: Extracts the user ID from the JWT token.
\nValidation: Ensures all required fields are present.
\nPassport Upload:
\nSecures and renames the uploaded file.
\nSaves it to the server upload directory.
\nBooking Creation:
\nGenerates an order ID.
\nSets booking type to VISA.
Sets pricing (NGN 500,000).
Stores pricing metadata (original & markup).
\nVisa Application Creation:
\nResponse: Returns application and booking details including booking_id, order_id, and visa_price.
Code: 201 Created
Content:
{\n \"message\": \"Visa application booked ready for payment\",\n \"booking_id\": 101,\n \"order_id\": \"ORD-168754902345\",\n \"booking_type\": \"VISA\",\n \"visa_id\": 44,\n \"visa_email\": \"user@example.com\",\n \"visa_price\": 500000\n}\n\nExample Error Response:
\n{\n \"error\": \"Missing required field\"\n}\n\n{\n \"error\": \"Internal server error\"\n}\n\nStartFragment
\nEndpoint: visa/schengenvisa/confirm
Method: GET
Authentication: JWT Token Required
Content-Type: application/json
Purpose: Confirms a visa application after verifying a successful payment.
This endpoint confirms a Schengen visa booking after verifying payment using a transaction reference. It updates the booking and visa records, sends email notifications to both the admin and the applicant, and returns the finalized application ID.
\nAuthentication: Verifies and extracts the user ID from the JWT token.
\nInput Validation: Ensures required query parameters are present.
\nData Retrieval:
\nRetrieves booking by order_id.
Retrieves visa application by visa_id.
Retrieves payment transaction by tx_ref.
Payment Verification:
\nSUCCESSFUL.Booking Update:
\nChanges booking status to CONFIRMED.
Saves confirmation number and updates user spending.
\nVisa Application Update:
\nMarks application as paid.
\nAssigns a formatted application ID.
\nEmail Notifications:
\nSends a detailed email to admins.
\nSends a confirmation email to the applicant.
\nResponse:
\napplication_id.Code: 200 OK
Content:
{\n \"message\": \"Visa application payment successfully and in processing.\",\n \"application_id\": \"SCH-2025-00123\"\n}\n\nExamples:
\n{\n \"error\": \"Missing requirements in request args\"\n}\n\n{\n \"error\": \"Payment not made or not successful for this transaction. Please head back to complete your payment!\"\n}\n\nRecipients:
praise.ordu@hermextravels.com, rhemaimerhion@gmail.com
Subject:
New Visa Application Received - SCH-2025-00123
Template:
admin_email.html
Context Includes:
\nFull Name
\nDate of Birth
\nNationality
\nApplication ID
\nOrder ID
\nSubmission Date
\nSubject:
Your Visa Application Has Been Received
Template:
user_email.html
Recipient:
\n Applicant's email (visa_email)