REST API GUIDE

airbnb-bookingmanagement-service

Orchestrates booking, payment, calendar, changewsand dispute flows for Airbnb-style short-term rental marketplace...test Handles reservations, approval, Stripe payments, iCal sync, payment records, and the dispute/refund lifecycle with host/guest/admin visibility.

Architectural Design Credit and Contact Information

The architectural design of this microservice is credited to . For inquiries, feedback, or further information regarding the architecture, please direct your communication to:

Email:

We encourage open communication and welcome any questions or discussions related to the architectural aspects of this microservice.

Documentation Scope

Welcome to the official documentation for the BookingManagement Service's REST API. This document is designed to provide a comprehensive guide to interfacing with our BookingManagement Service exclusively through RESTful API endpoints.

Intended Audience

This documentation is intended for developers and integrators who are looking to interact with the BookingManagement Service via HTTP requests for purposes such as creating, updating, deleting and querying BookingManagement objects.

Overview

Within these pages, you will find detailed information on how to effectively utilize the REST API, including authentication methods, request and response formats, endpoint descriptions, and examples of common use cases.

Beyond REST It's important to note that the BookingManagement Service also supports alternative methods of interaction, such as gRPC and messaging via a Message Broker. These communication methods are beyond the scope of this document. For information regarding these protocols, please refer to their respective documentation.

Authentication And Authorization

To ensure secure access to the BookingManagement service's protected endpoints, a project-wide access token is required. This token serves as the primary method for authenticating requests to our service. However, it's important to note that access control varies across different routes:

Protected API: Certain API (routes) require specific authorization levels. Access to these routes is contingent upon the possession of a valid access token that meets the route-specific authorization criteria. Unauthorized requests to these routes will be rejected.

**Public API **: The service also includes public API (routes) that are accessible without authentication. These public endpoints are designed for open access and do not require an access token.

Token Locations

When including your access token in a request, ensure it is placed in one of the following specified locations. The service will sequentially search these locations for the token, utilizing the first one it encounters.

Please ensure the token is correctly placed in one of these locations, using the appropriate label as indicated. The service prioritizes these locations in the order listed, processing the first token it successfully identifies.

Api Definitions

This section outlines the API endpoints available within the BookingManagement service. Each endpoint can receive parameters through various methods, meticulously described in the following definitions. It's important to understand the flexibility in how parameters can be included in requests to effectively interact with the BookingManagement service.

This service is configured to listen for HTTP requests on port 3001, serving both the main API interface and default administrative endpoints.

The following routes are available by default:

• API Test Interface (API Face): /
• Swagger Documentation: /swagger
• Postman Collection Download: /getPostmanCollection
• Health Checks: /health and /admin/health
• Current Session Info: /currentuser
• Favicon: /favicon.ico

This service is accessible via the following environment-specific URLs:

• Preview: https://airbnb3.prw.mindbricks.com/bookingmanagement-api
• Staging: https://airbnb3-stage.mindbricks.co/bookingmanagement-api
• Production: https://airbnb3.mindbricks.co/bookingmanagement-api

Parameter Inclusion Methods: Parameters can be incorporated into API requests in several ways, each with its designated location. Understanding these methods is crucial for correctly constructing your requests:

Query Parameters: Included directly in the URL's query string.

Path Parameters: Embedded within the URL's path.

Body Parameters: Sent within the JSON body of the request.

Session Parameters: Automatically read from the session object. This method is used for parameters that are intrinsic to the user's session, such as userId. When using an API that involves session parameters, you can omit these from your request. The service will automatically bind them to the API layer, provided that a session is associated with your request.

Note on Session Parameters: Session parameters represent a unique method of parameter inclusion, relying on the context of the user's session. A common example of a session parameter is userId, which the service automatically associates with your request when a session exists. This feature ensures seamless integration of user-specific data without manual input for each request.

By adhering to the specified parameter inclusion methods, you can effectively utilize the BookingManagement service's API endpoints. For detailed information on each endpoint, including required parameters and their accepted locations, refer to the individual API definitions below.

Common Parameters

The BookingManagement service's business API support several common parameters designed to modify and enhance the behavior of API requests. These parameters are not individually listed in the API route definitions to avoid repetition. Instead, refer to this section to understand how to leverage these common behaviors across different routes. Note that all common parameters should be included in the query part of the URL.

Supported Common Parameters:

• getJoins (BOOLEAN): Controls whether to retrieve associated objects along with the main object. By default, getJoins is assumed to be true. Set it to false if you prefer to receive only the main fields of an object, excluding its associations.

• excludeCQRS (BOOLEAN): Applicable only when getJoins is true. By default, excludeCQRS is set to false. Enabling this parameter (true) omits non-local associations, which are typically more resource-intensive as they require querying external services like ElasticSearch for additional information. Use this to optimize response times and resource usage.

• requestId (String): Identifies a request to enable tracking through the service's log chain. A random hex string of 32 characters is assigned by default. If you wish to use a custom requestId, simply include it in your query parameters.

• caching (BOOLEAN): Determines the use of caching for query API. By default, caching is enabled (true). To ensure the freshest data directly from the database, set this parameter to false, bypassing the cache.

• cacheTTL (Integer): Specifies the Time-To-Live (TTL) for query caching, in seconds. This is particularly useful for adjusting the default caching duration (5 minutes) for get list queries. Setting a custom cacheTTL allows you to fine-tune the cache lifespan to meet your needs.

• pageNumber (Integer): For paginated get list API's, this parameter selects which page of results to retrieve. The default is 1, indicating the first page. To disable pagination and retrieve all results, set pageNumber to 0.

• pageRowCount (Integer): In conjunction with paginated API's, this parameter defines the number of records per page. The default value is 25. Adjusting pageRowCount allows you to control the volume of data returned in a single request.

By utilizing these common parameters, you can tailor the behavior of API requests to suit your specific requirements, ensuring optimal performance and usability of the BookingManagement service.

Error Response

If a request encounters an issue, whether due to a logical fault or a technical problem, the service responds with a standardized JSON error structure. The HTTP status code within this response indicates the nature of the error, utilizing commonly recognized codes for clarity:

• 400 Bad Request: The request was improperly formatted or contained invalid parameters, preventing the server from processing it.
• 401 Unauthorized: The request lacked valid authentication credentials or the credentials provided do not grant access to the requested resource.
• 404 Not Found: The requested resource was not found on the server.
• 500 Internal Server Error: The server encountered an unexpected condition that prevented it from fulfilling the request.

Each error response is structured to provide meaningful insight into the problem, assisting in diagnosing and resolving issues efficiently.

{
  "result": "ERR",
  "status": 400,
  "message": "errMsg_organizationIdisNotAValidID",
  "errCode": 400,
  "date": "2024-03-19T12:13:54.124Z",
  "detail": "String"
}

Object Structure of a Successfull Response

When the BookingManagement service processes requests successfully, it wraps the requested resource(s) within a JSON envelope. This envelope not only contains the data but also includes essential metadata, such as configuration details and pagination information, to enrich the response and provide context to the client.

Key Characteristics of the Response Envelope:

• Data Presentation: Depending on the nature of the request, the service returns either a single data object or an array of objects encapsulated within the JSON envelope.

  • Creation and Update API: These API routes return the unmodified (pure) form of the data object(s), without any associations to other data objects.
  • Delete API: Even though the data is removed from the database, the last known state of the data object(s) is returned in its pure form.
  • Get Requests: A single data object is returned in JSON format.
  • Get List Requests: An array of data objects is provided, reflecting a collection of resources.

• Data Structure and Joins: The complexity of the data structure in the response can vary based on the API's architectural design and the join options specified in the request. The architecture might inherently limit join operations, or they might be dynamically controlled through query parameters.

  • Pure Data Forms: In some cases, the response mirrors the exact structure found in the primary data table, without extensions.
  • Extended Data Forms: Alternatively, responses might include data extended through joins with tables within the same service or aggregated from external sources, such as ElasticSearch indices related to other services.
  • Join Varieties: The extensions might involve one-to-one joins, resulting in single object associations, or one-to-many joins, leading to an array of objects. In certain instances, the data might even feature nested inclusions from other data objects.

Design Considerations: The structure of a API's response data is meticulously crafted during the service's architectural planning. This design ensures that responses adequately reflect the intended data relationships and service logic, providing clients with rich and meaningful information.

Brief Data: Certain API's return a condensed version of the object data, intentionally selecting only specific fields deemed useful for that request. In such instances, the API documentation will detail the properties included in the response, guiding developers on what to expect.

API Response Structure

The API utilizes a standardized JSON envelope to encapsulate responses. This envelope is designed to consistently deliver both the requested data and essential metadata, ensuring that clients can efficiently interpret and utilize the response.

HTTP Status Codes:

• 200 OK: This status code is returned for successful GET, LIST, UPDATE, or DELETE operations, indicating that the request has been processed successfully.
• 201 Created: This status code is specific to CREATE operations, signifying that the requested resource has been successfully created.

Success Response Format:

For successful operations, the response includes a "status": "OK" property, signaling the successful execution of the request. The structure of a successful response is outlined below:

{
  "status":"OK",
  "statusCode": 200,   
  "elapsedMs":126,
  "ssoTime":120,
  "source": "db",
  "cacheKey": "hexCode",
  "userId": "ID",
  "sessionId": "ID",
  "requestId": "ID",
  "dataName":"products",
  "method":"GET",
  "action":"list",
  "appVersion":"Version",
  "rowCount":3
  "products":[{},{},{}],
  "paging": {
    "pageNumber":1, 
    "pageRowCount":25, 
    "totalRowCount":3,
    "pageCount":1
  },
  "filters": [],
  "uiPermissions": []
}

• products: In this example, this key contains the actual response content, which may be a single object or an array of objects depending on the operation performed.

Handling Errors:

For details on handling error scenarios and understanding the structure of error responses, please refer to the "Error Response" section provided earlier in this documentation. It outlines how error conditions are communicated, including the use of HTTP status codes and standardized JSON structures for error messages.

Resources

BookingManagement service provides the following resources which are stored in its own database as a data object. Note that a resource for an api access is a data object for the service.

Reservation resource

Resource Definition : Represents a guest's booking for a property listing, including dates, participants, approval/payment/dispute status, and iCal sync info... Reservation Resource Properties

Enum Properties

Enum properties are represented as strings in the database. The values are mapped to their corresponding names in the application layer.

approvalType Enum Property

Property Definition : Reservation requires instant approval (0) or host/manual (1).Enum Options

bookingStatus Enum Property

Property Definition : Current status of reservation (0: pending, 1: confirmed, 2: complete, 3: cancelled, 4: declined).Enum Options

disputeStatus Enum Property

Property Definition : Current dispute status on reservation (0: none, 1: requested, 2: active, 3: resolved).Enum Options

_paymentConfirmation Enum Property

Property Definition : An automatic property that is used to check the confirmed status of the payment set by webhooks.Enum Options

PaymentRecord resource

Resource Definition : Stores payment and payout records (Stripe-driven) linked to a reservation (guest booking), including platform fees, taxes, host payouts, and status updates. Immutable after creation, never hard deleted. PaymentRecord Resource Properties

Enum Properties

Enum properties are represented as strings in the database. The values are mapped to their corresponding names in the application layer.

paymentStatus Enum Property

Property Definition : Status of payment (0: pending, 1: paid, 2: refunded, 3: failed).Enum Options

Dispute resource

Resource Definition : Represents a dispute, refund request, or booking issue reported by guest/host/admin for a reservation. Flows to admin for handling, resolves with resolutionStatus and reference to any refund/payment involved. Dispute Resource Properties

Enum Properties

Enum properties are represented as strings in the database. The values are mapped to their corresponding names in the application layer.

resolutionStatus Enum Property

Property Definition : Dispute resolution state (0: pending, 1: reviewing, 2: resolved, 3: rejected).Enum Options

Sys_reservationPayment resource

Resource Definition : A payment storage object to store the payment life cyle of orders based on reservation object. It is autocreated based on the source object's checkout config Sys_reservationPayment Resource Properties

Sys_paymentCustomer resource

Resource Definition : A payment storage object to store the customer values of the payment platform Sys_paymentCustomer Resource Properties

Sys_paymentMethod resource

Resource Definition : A payment storage object to store the payment methods of the platform customers Sys_paymentMethod Resource Properties

Business Api

Update Dispute API

API Definition : Updates dispute fields like status, admin assignment, resolution notes. Only admin or assigned party can update (enforced by membership/role checks).

API Crud Type : update

Default access route : PATCH /v1/disputes/:disputeId

Parameters

The updateDispute api has got 7 parameters

To access the api you can use the REST controller with the path PATCH /v1/disputes/:disputeId

  axios({
    method: 'PATCH',
    url: `/v1/disputes/${disputeId}`,
    data: {
            adminId:"ID",  
            issueType:"String",  
            description:"Text",  
            resolutionStatus:"Enum",  
            resolvedAt:"Date",  
            refundApproved:"Boolean",  
    
    },
    params: {
    
    }
  });

The API response is encapsulated within a JSON envelope. Successful operations return an HTTP status code of 200 for get, list, update, or delete requests, and 201 for create requests. Each successful response includes a "status": "OK" property. For error handling, refer to the "Error Response" section.

Following JSON represents the most comprehensive form of the dispute object in the respones. However, some properties may be omitted based on the object's internal logic.

{"status":"OK","statusCode":"200","elapsedMs":126,"ssoTime":120,"source":"db","cacheKey":"hexCode","userId":"ID","sessionId":"ID","requestId":"ID","dataName":"dispute","method":"PATCH","action":"update","appVersion":"Version","rowCount":1,"dispute":{"id":"ID","reportedAt":"Date","reservationId":"ID","raisedBy":"ID","adminId":"ID","issueType":"String","description":"Text","relatedPaymentId":"ID","resolutionStatus":"Enum","resolutionStatus_idx":"Integer","resolvedAt":"Date","refundApproved":"Boolean","isActive":true,"recordVersion":"Integer","createdAt":"Date","updatedAt":"Date","_owner":"ID"}}

For a detailed description of the `` api with its internal and inter-service logic please refer to the Business API Specification Document For Update Dispute.

Get Paymentrecord API

API Definition : Get a payment record by ID (owner or admin only). No selectJoin for privacy. Returned for auditing or user view.

API Crud Type : get

Default access route : GET /v1/paymentrecords/:paymentRecordId

Parameters

The getPaymentRecord api has got 1 parameter

To access the api you can use the REST controller with the path GET /v1/paymentrecords/:paymentRecordId

  axios({
    method: 'GET',
    url: `/v1/paymentrecords/${paymentRecordId}`,
    data: {
    
    },
    params: {
    
    }
  });

The API response is encapsulated within a JSON envelope. Successful operations return an HTTP status code of 200 for get, list, update, or delete requests, and 201 for create requests. Each successful response includes a "status": "OK" property. For error handling, refer to the "Error Response" section.

Following JSON represents the most comprehensive form of the paymentRecord object in the respones. However, some properties may be omitted based on the object's internal logic.

{"status":"OK","statusCode":"200","elapsedMs":126,"ssoTime":120,"source":"db","cacheKey":"hexCode","userId":"ID","sessionId":"ID","requestId":"ID","dataName":"paymentRecord","method":"GET","action":"get","appVersion":"Version","rowCount":1,"paymentRecord":{"id":"ID","reservationId":"ID","stripeChargeId":"String","payoutAmountHost":"Double","paymentIntentId":"String","currency":"String","cityTax":"Double","refundAmount":"Double","amountPaid":"Double","paymentStatus":"Enum","paymentStatus_idx":"Integer","platformFee":"Double","paymentDate":"Date","isActive":true,"recordVersion":"Integer","createdAt":"Date","updatedAt":"Date","_owner":"ID"}}

For a detailed description of the `` api with its internal and inter-service logic please refer to the Business API Specification Document For Get Paymentrecord.

Get Reservation API

API Definition : Fetch a single reservation (for guest, host, or admin). Auto-includes related listing and payments via selectJoin.

API Crud Type : get

Default access route : GET /v1/reservations/:reservationId

Parameters

The getReservation api has got 1 parameter

To access the api you can use the REST controller with the path GET /v1/reservations/:reservationId

  axios({
    method: 'GET',
    url: `/v1/reservations/${reservationId}`,
    data: {
    
    },
    params: {
    
    }
  });

The API response is encapsulated within a JSON envelope. Successful operations return an HTTP status code of 200 for get, list, update, or delete requests, and 201 for create requests. Each successful response includes a "status": "OK" property. For error handling, refer to the "Error Response" section.

Following JSON represents the most comprehensive form of the reservation object in the respones. However, some properties may be omitted based on the object's internal logic.

{"status":"OK","statusCode":"200","elapsedMs":126,"ssoTime":120,"source":"db","cacheKey":"hexCode","userId":"ID","sessionId":"ID","requestId":"ID","dataName":"reservation","method":"GET","action":"get","appVersion":"Version","rowCount":1,"reservation":{"id":"ID","listingId":"ID","approvalType":"Enum","approvalType_idx":"Integer","bookingStatus":"Enum","bookingStatus_idx":"Integer","hostId":"ID","checkOut":"Date","guestId":"ID","checkIn":"Date","currency":"String","guestCount":"Integer","totalPrice":"Double","iCalExportUrl":"String","disputeStatus":"Enum","disputeStatus_idx":"Integer","bookingPoliciesSnapshot":"Object","iCalImportSource":"String","cancellationPolicySnapshot":"Object","_paymentConfirmation":"Enum","_paymentConfirmation_idx":"Integer","isActive":true,"recordVersion":"Integer","createdAt":"Date","updatedAt":"Date","_owner":"ID"}}

For a detailed description of the `` api with its internal and inter-service logic please refer to the Business API Specification Document For Get Reservation.

Create Dispute API

API Definition : Guest/host opens a formal dispute related to a reservation. Admin is only assigned after initial review. Can only be created by guest/host of reservation (enforced in logic).

API Crud Type : create

Default access route : POST /v1/disputes

Parameters

The createDispute api has got 10 parameters

To access the api you can use the REST controller with the path POST /v1/disputes

  axios({
    method: 'POST',
    url: '/v1/disputes',
    data: {
            reportedAt:"Date",  
            reservationId:"ID",  
            raisedBy:"ID",  
            adminId:"ID",  
            issueType:"String",  
            description:"Text",  
            relatedPaymentId:"ID",  
            resolutionStatus:"Enum",  
            resolvedAt:"Date",  
            refundApproved:"Boolean",  
    
    },
    params: {
    
    }
  });

The API response is encapsulated within a JSON envelope. Successful operations return an HTTP status code of 200 for get, list, update, or delete requests, and 201 for create requests. Each successful response includes a "status": "OK" property. For error handling, refer to the "Error Response" section.

Following JSON represents the most comprehensive form of the dispute object in the respones. However, some properties may be omitted based on the object's internal logic.

{"status":"OK","statusCode":"201","elapsedMs":126,"ssoTime":120,"source":"db","cacheKey":"hexCode","userId":"ID","sessionId":"ID","requestId":"ID","dataName":"dispute","method":"POST","action":"create","appVersion":"Version","rowCount":1,"dispute":{"id":"ID","reportedAt":"Date","reservationId":"ID","raisedBy":"ID","adminId":"ID","issueType":"String","description":"Text","relatedPaymentId":"ID","resolutionStatus":"Enum","resolutionStatus_idx":"Integer","resolvedAt":"Date","refundApproved":"Boolean","isActive":true,"recordVersion":"Integer","createdAt":"Date","updatedAt":"Date","_owner":"ID"}}

For a detailed description of the `` api with its internal and inter-service logic please refer to the Business API Specification Document For Create Dispute.

List Reservations API

API Definition : List reservations (bookings) for guest, host, or admin. Includes selectJoin for listing/guest/host info. Filterable by guestId, hostId, status, etc.

API Crud Type : list

Default access route : GET /v1/reservations

The listReservations api has got no parameters.

To access the api you can use the REST controller with the path GET /v1/reservations

  axios({
    method: 'GET',
    url: '/v1/reservations',
    data: {
    
    },
    params: {
    
    }
  });

The API response is encapsulated within a JSON envelope. Successful operations return an HTTP status code of 200 for get, list, update, or delete requests, and 201 for create requests. Each successful response includes a "status": "OK" property. For error handling, refer to the "Error Response" section.

Following JSON represents the most comprehensive form of the reservations object in the respones. However, some properties may be omitted based on the object's internal logic.

{"status":"OK","statusCode":"200","elapsedMs":126,"ssoTime":120,"source":"db","cacheKey":"hexCode","userId":"ID","sessionId":"ID","requestId":"ID","dataName":"reservations","method":"GET","action":"list","appVersion":"Version","rowCount":"\"Number\"","reservations":[{"id":"ID","listingId":"ID","approvalType":"Enum","approvalType_idx":"Integer","bookingStatus":"Enum","bookingStatus_idx":"Integer","hostId":"ID","checkOut":"Date","guestId":"ID","checkIn":"Date","currency":"String","guestCount":"Integer","totalPrice":"Double","iCalExportUrl":"String","disputeStatus":"Enum","disputeStatus_idx":"Integer","bookingPoliciesSnapshot":"Object","iCalImportSource":"String","cancellationPolicySnapshot":"Object","_paymentConfirmation":"Enum","_paymentConfirmation_idx":"Integer","isActive":true,"recordVersion":"Integer","createdAt":"Date","updatedAt":"Date","_owner":"ID","listingJoins":[{"title":"String","amenityIds":"ID","hostId":"ID","mainPhoto":"String","photos":"String","address":"String","propertyType":"Enum","propertyType_idx":"Integer","location":"Object"},{},{}],"hostDetails":[{"email":"String","fullname":"String","avatar":"String"},{},{}]},{},{}],"paging":{"pageNumber":"Number","pageRowCount":"NUmber","totalRowCount":"Number","pageCount":"Number"},"filters":[],"uiPermissions":[]}

For a detailed description of the `` api with its internal and inter-service logic please refer to the Business API Specification Document For List Reservations.

Create Reservation API

API Definition : Guest initiates a reservation for a listing (instant or manual). Handles calendar check, approvalType, payment intent, and booking policies. Triggers Stripe checkout. Only allowed if dates are available and not conflicting. Guest is current user.

API Crud Type : create

Default access route : POST /v1/reservations

Parameters

The createReservation api has got 14 parameters

To access the api you can use the REST controller with the path POST /v1/reservations

  axios({
    method: 'POST',
    url: '/v1/reservations',
    data: {
            listingId:"ID",  
            approvalType:"Enum",  
            bookingStatus:"Enum",  
            hostId:"ID",  
            checkOut:"Date",  
            checkIn:"Date",  
            currency:"String",  
            guestCount:"Integer",  
            totalPrice:"Double",  
            iCalExportUrl:"String",  
            disputeStatus:"Enum",  
            bookingPoliciesSnapshot:"Object",  
            iCalImportSource:"String",  
            cancellationPolicySnapshot:"Object",  
    
    },
    params: {
    
    }
  });

The API response is encapsulated within a JSON envelope. Successful operations return an HTTP status code of 200 for get, list, update, or delete requests, and 201 for create requests. Each successful response includes a "status": "OK" property. For error handling, refer to the "Error Response" section.

Following JSON represents the most comprehensive form of the reservation object in the respones. However, some properties may be omitted based on the object's internal logic.

{"status":"OK","statusCode":"201","elapsedMs":126,"ssoTime":120,"source":"db","cacheKey":"hexCode","userId":"ID","sessionId":"ID","requestId":"ID","dataName":"reservation","method":"POST","action":"create","appVersion":"Version","rowCount":1,"reservation":{"id":"ID","listingId":"ID","approvalType":"Enum","approvalType_idx":"Integer","bookingStatus":"Enum","bookingStatus_idx":"Integer","hostId":"ID","checkOut":"Date","guestId":"ID","checkIn":"Date","currency":"String","guestCount":"Integer","totalPrice":"Double","iCalExportUrl":"String","disputeStatus":"Enum","disputeStatus_idx":"Integer","bookingPoliciesSnapshot":"Object","iCalImportSource":"String","cancellationPolicySnapshot":"Object","_paymentConfirmation":"Enum","_paymentConfirmation_idx":"Integer","isActive":true,"recordVersion":"Integer","createdAt":"Date","updatedAt":"Date","_owner":"ID"}}

For a detailed description of the `` api with its internal and inter-service logic please refer to the Business API Specification Document For Create Reservation.

Create Paymentrecord API

API Definition : Creates or logs payment record for a reservation (from payment success or admin/manual trigger). Populates from Stripe events/webhooks. Only creates; no update/delete (for compliance/audit).

API Crud Type : create

Default access route : POST /v1/paymentrecords

Parameters

The createPaymentRecord api has got 11 parameters

To access the api you can use the REST controller with the path POST /v1/paymentrecords

  axios({
    method: 'POST',
    url: '/v1/paymentrecords',
    data: {
            reservationId:"ID",  
            stripeChargeId:"String",  
            payoutAmountHost:"Double",  
            paymentIntentId:"String",  
            currency:"String",  
            cityTax:"Double",  
            refundAmount:"Double",  
            amountPaid:"Double",  
            paymentStatus:"Enum",  
            platformFee:"Double",  
            paymentDate:"Date",  
    
    },
    params: {
    
    }
  });

The API response is encapsulated within a JSON envelope. Successful operations return an HTTP status code of 200 for get, list, update, or delete requests, and 201 for create requests. Each successful response includes a "status": "OK" property. For error handling, refer to the "Error Response" section.

Following JSON represents the most comprehensive form of the paymentRecord object in the respones. However, some properties may be omitted based on the object's internal logic.

{"status":"OK","statusCode":"201","elapsedMs":126,"ssoTime":120,"source":"db","cacheKey":"hexCode","userId":"ID","sessionId":"ID","requestId":"ID","dataName":"paymentRecord","method":"POST","action":"create","appVersion":"Version","rowCount":1,"paymentRecord":{"id":"ID","reservationId":"ID","stripeChargeId":"String","payoutAmountHost":"Double","paymentIntentId":"String","currency":"String","cityTax":"Double","refundAmount":"Double","amountPaid":"Double","paymentStatus":"Enum","paymentStatus_idx":"Integer","platformFee":"Double","paymentDate":"Date","isActive":true,"recordVersion":"Integer","createdAt":"Date","updatedAt":"Date","_owner":"ID"}}

For a detailed description of the `` api with its internal and inter-service logic please refer to the Business API Specification Document For Create Paymentrecord.

List Paymentrecords API

API Definition : List payment records (reservation/guest/host or admin, includes filters if needed). Used for financial histories/exports. No selectJoin, for privacy and performance.

API Crud Type : list

Default access route : GET /v1/paymentrecords

The listPaymentRecords api has got no parameters.

To access the api you can use the REST controller with the path GET /v1/paymentrecords

  axios({
    method: 'GET',
    url: '/v1/paymentrecords',
    data: {
    
    },
    params: {
    
    }
  });

The API response is encapsulated within a JSON envelope. Successful operations return an HTTP status code of 200 for get, list, update, or delete requests, and 201 for create requests. Each successful response includes a "status": "OK" property. For error handling, refer to the "Error Response" section.

Following JSON represents the most comprehensive form of the paymentRecords object in the respones. However, some properties may be omitted based on the object's internal logic.

{"status":"OK","statusCode":"200","elapsedMs":126,"ssoTime":120,"source":"db","cacheKey":"hexCode","userId":"ID","sessionId":"ID","requestId":"ID","dataName":"paymentRecords","method":"GET","action":"list","appVersion":"Version","rowCount":"\"Number\"","paymentRecords":[{"id":"ID","reservationId":"ID","stripeChargeId":"String","payoutAmountHost":"Double","paymentIntentId":"String","currency":"String","cityTax":"Double","refundAmount":"Double","amountPaid":"Double","paymentStatus":"Enum","paymentStatus_idx":"Integer","platformFee":"Double","paymentDate":"Date","isActive":true,"recordVersion":"Integer","createdAt":"Date","updatedAt":"Date","_owner":"ID"},{},{}],"paging":{"pageNumber":"Number","pageRowCount":"NUmber","totalRowCount":"Number","pageCount":"Number"},"filters":[],"uiPermissions":[]}

For a detailed description of the `` api with its internal and inter-service logic please refer to the Business API Specification Document For List Paymentrecords.

Delete Reservation API

API Definition : Cancels or removes a reservation (soft-delete). Guest, host or admin may delete (ownership enforced). Used for cancellations before stay begins or admin moderation.

API Crud Type : delete

Default access route : DELETE /v1/reservations/:reservationId

Parameters

The deleteReservation api has got 1 parameter

To access the api you can use the REST controller with the path DELETE /v1/reservations/:reservationId

  axios({
    method: 'DELETE',
    url: `/v1/reservations/${reservationId}`,
    data: {
    
    },
    params: {
    
    }
  });

The API response is encapsulated within a JSON envelope. Successful operations return an HTTP status code of 200 for get, list, update, or delete requests, and 201 for create requests. Each successful response includes a "status": "OK" property. For error handling, refer to the "Error Response" section.

Following JSON represents the most comprehensive form of the reservation object in the respones. However, some properties may be omitted based on the object's internal logic.

{"status":"OK","statusCode":"200","elapsedMs":126,"ssoTime":120,"source":"db","cacheKey":"hexCode","userId":"ID","sessionId":"ID","requestId":"ID","dataName":"reservation","method":"DELETE","action":"delete","appVersion":"Version","rowCount":1,"reservation":{"id":"ID","listingId":"ID","approvalType":"Enum","approvalType_idx":"Integer","bookingStatus":"Enum","bookingStatus_idx":"Integer","hostId":"ID","checkOut":"Date","guestId":"ID","checkIn":"Date","currency":"String","guestCount":"Integer","totalPrice":"Double","iCalExportUrl":"String","disputeStatus":"Enum","disputeStatus_idx":"Integer","bookingPoliciesSnapshot":"Object","iCalImportSource":"String","cancellationPolicySnapshot":"Object","_paymentConfirmation":"Enum","_paymentConfirmation_idx":"Integer","isActive":false,"recordVersion":"Integer","createdAt":"Date","updatedAt":"Date","_owner":"ID"}}

For a detailed description of the `` api with its internal and inter-service logic please refer to the Business API Specification Document For Delete Reservation.

Update Reservation API

API Definition : Update an existing reservation (allowed fields: only those which do not affect core identity/relations—e.g., guestCount if update allowed, NOT dates/listingId). Used for confirming cancellation, updating status by host/guest, or marking as completed. Permission: must be guest, host, or admin.

API Crud Type : update

Default access route : PATCH /v1/reservations/:reservationId

Parameters

The updateReservation api has got 5 parameters

To access the api you can use the REST controller with the path PATCH /v1/reservations/:reservationId

  axios({
    method: 'PATCH',
    url: `/v1/reservations/${reservationId}`,
    data: {
            bookingStatus:"Enum",  
            iCalExportUrl:"String",  
            disputeStatus:"Enum",  
            iCalImportSource:"String",  
    
    },
    params: {
    
    }
  });

The API response is encapsulated within a JSON envelope. Successful operations return an HTTP status code of 200 for get, list, update, or delete requests, and 201 for create requests. Each successful response includes a "status": "OK" property. For error handling, refer to the "Error Response" section.

Following JSON represents the most comprehensive form of the reservation object in the respones. However, some properties may be omitted based on the object's internal logic.

{"status":"OK","statusCode":"200","elapsedMs":126,"ssoTime":120,"source":"db","cacheKey":"hexCode","userId":"ID","sessionId":"ID","requestId":"ID","dataName":"reservation","method":"PATCH","action":"update","appVersion":"Version","rowCount":1,"reservation":{"id":"ID","listingId":"ID","approvalType":"Enum","approvalType_idx":"Integer","bookingStatus":"Enum","bookingStatus_idx":"Integer","hostId":"ID","checkOut":"Date","guestId":"ID","checkIn":"Date","currency":"String","guestCount":"Integer","totalPrice":"Double","iCalExportUrl":"String","disputeStatus":"Enum","disputeStatus_idx":"Integer","bookingPoliciesSnapshot":"Object","iCalImportSource":"String","cancellationPolicySnapshot":"Object","_paymentConfirmation":"Enum","_paymentConfirmation_idx":"Integer","isActive":true,"recordVersion":"Integer","createdAt":"Date","updatedAt":"Date","_owner":"ID"}}

For a detailed description of the `` api with its internal and inter-service logic please refer to the Business API Specification Document For Update Reservation.

List Disputes API

API Definition : List disputes visible to the user (as guest, host, or admin). Used for admin screening and user support view. No joins for privacy. Filterable by reservationId, raisedBy, status, etc.

API Crud Type : list

Default access route : GET /v1/disputes

The listDisputes api has got no parameters.

To access the api you can use the REST controller with the path GET /v1/disputes

  axios({
    method: 'GET',
    url: '/v1/disputes',
    data: {
    
    },
    params: {
    
    }
  });

The API response is encapsulated within a JSON envelope. Successful operations return an HTTP status code of 200 for get, list, update, or delete requests, and 201 for create requests. Each successful response includes a "status": "OK" property. For error handling, refer to the "Error Response" section.

Following JSON represents the most comprehensive form of the disputes object in the respones. However, some properties may be omitted based on the object's internal logic.

{"status":"OK","statusCode":"200","elapsedMs":126,"ssoTime":120,"source":"db","cacheKey":"hexCode","userId":"ID","sessionId":"ID","requestId":"ID","dataName":"disputes","method":"GET","action":"list","appVersion":"Version","rowCount":"\"Number\"","disputes":[{"id":"ID","reportedAt":"Date","reservationId":"ID","raisedBy":"ID","adminId":"ID","issueType":"String","description":"Text","relatedPaymentId":"ID","resolutionStatus":"Enum","resolutionStatus_idx":"Integer","resolvedAt":"Date","refundApproved":"Boolean","isActive":true,"recordVersion":"Integer","createdAt":"Date","updatedAt":"Date","_owner":"ID"},{},{}],"paging":{"pageNumber":"Number","pageRowCount":"NUmber","totalRowCount":"Number","pageCount":"Number"},"filters":[],"uiPermissions":[]}

For a detailed description of the `` api with its internal and inter-service logic please refer to the Business API Specification Document For List Disputes.

Get Dispute API

API Definition : Fetch a dispute by ID (guest, host, assigned admin, or admin role). No joins for privacy. Used for support/moderation flows.

API Crud Type : get

Default access route : GET /v1/disputes/:disputeId

Parameters

The getDispute api has got 1 parameter

To access the api you can use the REST controller with the path GET /v1/disputes/:disputeId

  axios({
    method: 'GET',
    url: `/v1/disputes/${disputeId}`,
    data: {
    
    },
    params: {
    
    }
  });

The API response is encapsulated within a JSON envelope. Successful operations return an HTTP status code of 200 for get, list, update, or delete requests, and 201 for create requests. Each successful response includes a "status": "OK" property. For error handling, refer to the "Error Response" section.

Following JSON represents the most comprehensive form of the dispute object in the respones. However, some properties may be omitted based on the object's internal logic.

{"status":"OK","statusCode":"200","elapsedMs":126,"ssoTime":120,"source":"db","cacheKey":"hexCode","userId":"ID","sessionId":"ID","requestId":"ID","dataName":"dispute","method":"GET","action":"get","appVersion":"Version","rowCount":1,"dispute":{"id":"ID","reportedAt":"Date","reservationId":"ID","raisedBy":"ID","adminId":"ID","issueType":"String","description":"Text","relatedPaymentId":"ID","resolutionStatus":"Enum","resolutionStatus_idx":"Integer","resolvedAt":"Date","refundApproved":"Boolean","isActive":true,"recordVersion":"Integer","createdAt":"Date","updatedAt":"Date","_owner":"ID"}}

For a detailed description of the `` api with its internal and inter-service logic please refer to the Business API Specification Document For Get Dispute.

Get Reservationpayment2 API

API Definition : This route is used to get the payment information by ID.

API Crud Type : get

Default access route : GET /v1/reservationpayment2/:sys_reservationPaymentId

Parameters

The getReservationPayment2 api has got 1 parameter

To access the api you can use the REST controller with the path GET /v1/reservationpayment2/:sys_reservationPaymentId

  axios({
    method: 'GET',
    url: `/v1/reservationpayment2/${sys_reservationPaymentId}`,
    data: {
    
    },
    params: {
    
    }
  });

The API response is encapsulated within a JSON envelope. Successful operations return an HTTP status code of 200 for get, list, update, or delete requests, and 201 for create requests. Each successful response includes a "status": "OK" property. For error handling, refer to the "Error Response" section.

Following JSON represents the most comprehensive form of the sys_reservationPayment object in the respones. However, some properties may be omitted based on the object's internal logic.

{"status":"OK","statusCode":"200","elapsedMs":126,"ssoTime":120,"source":"db","cacheKey":"hexCode","userId":"ID","sessionId":"ID","requestId":"ID","dataName":"sys_reservationPayment","method":"GET","action":"get","appVersion":"Version","rowCount":1,"sys_reservationPayment":{"id":"ID","ownerId":"ID","orderId":"ID","paymentId":"String","paymentStatus":"String","statusLiteral":"String","redirectUrl":"String","isActive":true,"recordVersion":"Integer","createdAt":"Date","updatedAt":"Date","_owner":"ID"}}

For a detailed description of the `` api with its internal and inter-service logic please refer to the Business API Specification Document For Get Reservationpayment2.

List Reservationpayments2 API

API Definition : This route is used to list all payments.

API Crud Type : list

Default access route : GET /v1/reservationpayments2

The listReservationPayments2 api has got no parameters.

To access the api you can use the REST controller with the path GET /v1/reservationpayments2

  axios({
    method: 'GET',
    url: '/v1/reservationpayments2',
    data: {
    
    },
    params: {
    
    }
  });

The API response is encapsulated within a JSON envelope. Successful operations return an HTTP status code of 200 for get, list, update, or delete requests, and 201 for create requests. Each successful response includes a "status": "OK" property. For error handling, refer to the "Error Response" section.

Following JSON represents the most comprehensive form of the sys_reservationPayments object in the respones. However, some properties may be omitted based on the object's internal logic.

{"status":"OK","statusCode":"200","elapsedMs":126,"ssoTime":120,"source":"db","cacheKey":"hexCode","userId":"ID","sessionId":"ID","requestId":"ID","dataName":"sys_reservationPayments","method":"GET","action":"list","appVersion":"Version","rowCount":"\"Number\"","sys_reservationPayments":[{"id":"ID","ownerId":"ID","orderId":"ID","paymentId":"String","paymentStatus":"String","statusLiteral":"String","redirectUrl":"String","isActive":true,"recordVersion":"Integer","createdAt":"Date","updatedAt":"Date","_owner":"ID"},{},{}],"paging":{"pageNumber":"Number","pageRowCount":"NUmber","totalRowCount":"Number","pageCount":"Number"},"filters":[],"uiPermissions":[]}

For a detailed description of the `` api with its internal and inter-service logic please refer to the Business API Specification Document For List Reservationpayments2.

Create Reservationpayment API

API Definition : This route is used to create a new payment.

API Crud Type : create

Default access route : POST /v1/reservationpayment

Parameters

The createReservationPayment api has got 5 parameters

To access the api you can use the REST controller with the path POST /v1/reservationpayment

  axios({
    method: 'POST',
    url: '/v1/reservationpayment',
    data: {
            orderId:"ID",  
            paymentId:"String",  
            paymentStatus:"String",  
            statusLiteral:"String",  
            redirectUrl:"String",  
    
    },
    params: {
    
    }
  });

The API response is encapsulated within a JSON envelope. Successful operations return an HTTP status code of 200 for get, list, update, or delete requests, and 201 for create requests. Each successful response includes a "status": "OK" property. For error handling, refer to the "Error Response" section.

Following JSON represents the most comprehensive form of the sys_reservationPayment object in the respones. However, some properties may be omitted based on the object's internal logic.

{"status":"OK","statusCode":"201","elapsedMs":126,"ssoTime":120,"source":"db","cacheKey":"hexCode","userId":"ID","sessionId":"ID","requestId":"ID","dataName":"sys_reservationPayment","method":"POST","action":"create","appVersion":"Version","rowCount":1,"sys_reservationPayment":{"id":"ID","ownerId":"ID","orderId":"ID","paymentId":"String","paymentStatus":"String","statusLiteral":"String","redirectUrl":"String","isActive":true,"recordVersion":"Integer","createdAt":"Date","updatedAt":"Date","_owner":"ID"}}

For a detailed description of the `` api with its internal and inter-service logic please refer to the Business API Specification Document For Create Reservationpayment.

Update Reservationpayment API

API Definition : This route is used to update an existing payment.

API Crud Type : update

Default access route : PATCH /v1/reservationpayment/:sys_reservationPaymentId

Parameters

The updateReservationPayment api has got 5 parameters

To access the api you can use the REST controller with the path PATCH /v1/reservationpayment/:sys_reservationPaymentId

  axios({
    method: 'PATCH',
    url: `/v1/reservationpayment/${sys_reservationPaymentId}`,
    data: {
            paymentId:"String",  
            paymentStatus:"String",  
            statusLiteral:"String",  
            redirectUrl:"String",  
    
    },
    params: {
    
    }
  });

The API response is encapsulated within a JSON envelope. Successful operations return an HTTP status code of 200 for get, list, update, or delete requests, and 201 for create requests. Each successful response includes a "status": "OK" property. For error handling, refer to the "Error Response" section.

Following JSON represents the most comprehensive form of the sys_reservationPayment object in the respones. However, some properties may be omitted based on the object's internal logic.

{"status":"OK","statusCode":"200","elapsedMs":126,"ssoTime":120,"source":"db","cacheKey":"hexCode","userId":"ID","sessionId":"ID","requestId":"ID","dataName":"sys_reservationPayment","method":"PATCH","action":"update","appVersion":"Version","rowCount":1,"sys_reservationPayment":{"id":"ID","ownerId":"ID","orderId":"ID","paymentId":"String","paymentStatus":"String","statusLiteral":"String","redirectUrl":"String","isActive":true,"recordVersion":"Integer","createdAt":"Date","updatedAt":"Date","_owner":"ID"}}

For a detailed description of the `` api with its internal and inter-service logic please refer to the Business API Specification Document For Update Reservationpayment.

Delete Reservationpayment API

API Definition : This route is used to delete a payment.

API Crud Type : delete

Default access route : DELETE /v1/reservationpayment/:sys_reservationPaymentId

Parameters

The deleteReservationPayment api has got 1 parameter

To access the api you can use the REST controller with the path DELETE /v1/reservationpayment/:sys_reservationPaymentId

  axios({
    method: 'DELETE',
    url: `/v1/reservationpayment/${sys_reservationPaymentId}`,
    data: {
    
    },
    params: {
    
    }
  });

The API response is encapsulated within a JSON envelope. Successful operations return an HTTP status code of 200 for get, list, update, or delete requests, and 201 for create requests. Each successful response includes a "status": "OK" property. For error handling, refer to the "Error Response" section.

Following JSON represents the most comprehensive form of the sys_reservationPayment object in the respones. However, some properties may be omitted based on the object's internal logic.

{"status":"OK","statusCode":"200","elapsedMs":126,"ssoTime":120,"source":"db","cacheKey":"hexCode","userId":"ID","sessionId":"ID","requestId":"ID","dataName":"sys_reservationPayment","method":"DELETE","action":"delete","appVersion":"Version","rowCount":1,"sys_reservationPayment":{"id":"ID","ownerId":"ID","orderId":"ID","paymentId":"String","paymentStatus":"String","statusLiteral":"String","redirectUrl":"String","isActive":false,"recordVersion":"Integer","createdAt":"Date","updatedAt":"Date","_owner":"ID"}}

For a detailed description of the `` api with its internal and inter-service logic please refer to the Business API Specification Document For Delete Reservationpayment.

List Reservationpayments2 API

API Definition : This route is used to list all payments.

API Crud Type : list

Default access route : GET /v1/reservationpayments2

The listReservationPayments2 api has got no parameters.

To access the api you can use the REST controller with the path GET /v1/reservationpayments2

  axios({
    method: 'GET',
    url: '/v1/reservationpayments2',
    data: {
    
    },
    params: {
    
    }
  });

The API response is encapsulated within a JSON envelope. Successful operations return an HTTP status code of 200 for get, list, update, or delete requests, and 201 for create requests. Each successful response includes a "status": "OK" property. For error handling, refer to the "Error Response" section.

Following JSON represents the most comprehensive form of the sys_reservationPayments object in the respones. However, some properties may be omitted based on the object's internal logic.

{"status":"OK","statusCode":"200","elapsedMs":126,"ssoTime":120,"source":"db","cacheKey":"hexCode","userId":"ID","sessionId":"ID","requestId":"ID","dataName":"sys_reservationPayments","method":"GET","action":"list","appVersion":"Version","rowCount":"\"Number\"","sys_reservationPayments":[{"id":"ID","ownerId":"ID","orderId":"ID","paymentId":"String","paymentStatus":"String","statusLiteral":"String","redirectUrl":"String","isActive":true,"recordVersion":"Integer","createdAt":"Date","updatedAt":"Date","_owner":"ID"},{},{}],"paging":{"pageNumber":"Number","pageRowCount":"NUmber","totalRowCount":"Number","pageCount":"Number"},"filters":[],"uiPermissions":[]}

For a detailed description of the `` api with its internal and inter-service logic please refer to the Business API Specification Document For List Reservationpayments2.

Get Reservationpaymentbyorderid API

API Definition : This route is used to get the payment information by order id.

API Crud Type : get

Default access route : GET /v1/reservationpaymentbyorderid/:orderId

Parameters

The getReservationPaymentByOrderId api has got 2 parameters

To access the api you can use the REST controller with the path GET /v1/reservationpaymentbyorderid/:orderId

  axios({
    method: 'GET',
    url: `/v1/reservationpaymentbyorderid/${orderId}`,
    data: {
    
    },
    params: {
    
    }
  });

The API response is encapsulated within a JSON envelope. Successful operations return an HTTP status code of 200 for get, list, update, or delete requests, and 201 for create requests. Each successful response includes a "status": "OK" property. For error handling, refer to the "Error Response" section.

Following JSON represents the most comprehensive form of the sys_reservationPayment object in the respones. However, some properties may be omitted based on the object's internal logic.

{"status":"OK","statusCode":"200","elapsedMs":126,"ssoTime":120,"source":"db","cacheKey":"hexCode","userId":"ID","sessionId":"ID","requestId":"ID","dataName":"sys_reservationPayment","method":"GET","action":"get","appVersion":"Version","rowCount":1,"sys_reservationPayment":{"id":"ID","ownerId":"ID","orderId":"ID","paymentId":"String","paymentStatus":"String","statusLiteral":"String","redirectUrl":"String","isActive":true,"recordVersion":"Integer","createdAt":"Date","updatedAt":"Date","_owner":"ID"}}

For a detailed description of the `` api with its internal and inter-service logic please refer to the Business API Specification Document For Get Reservationpaymentbyorderid.

Get Reservationpaymentbypaymentid API

API Definition : This route is used to get the payment information by payment id.

API Crud Type : get

Default access route : GET /v1/reservationpaymentbypaymentid/:paymentId

Parameters

The getReservationPaymentByPaymentId api has got 2 parameters

To access the api you can use the REST controller with the path GET /v1/reservationpaymentbypaymentid/:paymentId

  axios({
    method: 'GET',
    url: `/v1/reservationpaymentbypaymentid/${paymentId}`,
    data: {
    
    },
    params: {
    
    }
  });

The API response is encapsulated within a JSON envelope. Successful operations return an HTTP status code of 200 for get, list, update, or delete requests, and 201 for create requests. Each successful response includes a "status": "OK" property. For error handling, refer to the "Error Response" section.

Following JSON represents the most comprehensive form of the sys_reservationPayment object in the respones. However, some properties may be omitted based on the object's internal logic.

{"status":"OK","statusCode":"200","elapsedMs":126,"ssoTime":120,"source":"db","cacheKey":"hexCode","userId":"ID","sessionId":"ID","requestId":"ID","dataName":"sys_reservationPayment","method":"GET","action":"get","appVersion":"Version","rowCount":1,"sys_reservationPayment":{"id":"ID","ownerId":"ID","orderId":"ID","paymentId":"String","paymentStatus":"String","statusLiteral":"String","redirectUrl":"String","isActive":true,"recordVersion":"Integer","createdAt":"Date","updatedAt":"Date","_owner":"ID"}}

For a detailed description of the `` api with its internal and inter-service logic please refer to the Business API Specification Document For Get Reservationpaymentbypaymentid.

Get Reservationpayment2 API

API Definition : This route is used to get the payment information by ID.

API Crud Type : get

Default access route : GET /v1/reservationpayment2/:sys_reservationPaymentId

Parameters

The getReservationPayment2 api has got 1 parameter

To access the api you can use the REST controller with the path GET /v1/reservationpayment2/:sys_reservationPaymentId

  axios({
    method: 'GET',
    url: `/v1/reservationpayment2/${sys_reservationPaymentId}`,
    data: {
    
    },
    params: {
    
    }
  });

The API response is encapsulated within a JSON envelope. Successful operations return an HTTP status code of 200 for get, list, update, or delete requests, and 201 for create requests. Each successful response includes a "status": "OK" property. For error handling, refer to the "Error Response" section.

Following JSON represents the most comprehensive form of the sys_reservationPayment object in the respones. However, some properties may be omitted based on the object's internal logic.

{"status":"OK","statusCode":"200","elapsedMs":126,"ssoTime":120,"source":"db","cacheKey":"hexCode","userId":"ID","sessionId":"ID","requestId":"ID","dataName":"sys_reservationPayment","method":"GET","action":"get","appVersion":"Version","rowCount":1,"sys_reservationPayment":{"id":"ID","ownerId":"ID","orderId":"ID","paymentId":"String","paymentStatus":"String","statusLiteral":"String","redirectUrl":"String","isActive":true,"recordVersion":"Integer","createdAt":"Date","updatedAt":"Date","_owner":"ID"}}

For a detailed description of the `` api with its internal and inter-service logic please refer to the Business API Specification Document For Get Reservationpayment2.

Start Reservationpayment API

API Definition : Start payment for reservation

API Crud Type : update

Default access route : PATCH /v1/startreservationpayment/:reservationId

Parameters

The startReservationPayment api has got 2 parameters

To access the api you can use the REST controller with the path PATCH /v1/startreservationpayment/:reservationId

  axios({
    method: 'PATCH',
    url: `/v1/startreservationpayment/${reservationId}`,
    data: {
            paymentUserParams:"Object",  
    
    },
    params: {
    
    }
  });

The API response is encapsulated within a JSON envelope. Successful operations return an HTTP status code of 200 for get, list, update, or delete requests, and 201 for create requests. Each successful response includes a "status": "OK" property. For error handling, refer to the "Error Response" section.

Following JSON represents the most comprehensive form of the reservation object in the respones. However, some properties may be omitted based on the object's internal logic.

{"status":"OK","statusCode":"200","elapsedMs":126,"ssoTime":120,"source":"db","cacheKey":"hexCode","userId":"ID","sessionId":"ID","requestId":"ID","dataName":"reservation","method":"PATCH","action":"update","appVersion":"Version","rowCount":1,"reservation":{"id":"ID","listingId":"ID","approvalType":"Enum","approvalType_idx":"Integer","bookingStatus":"Enum","bookingStatus_idx":"Integer","hostId":"ID","checkOut":"Date","guestId":"ID","checkIn":"Date","currency":"String","guestCount":"Integer","totalPrice":"Double","iCalExportUrl":"String","disputeStatus":"Enum","disputeStatus_idx":"Integer","bookingPoliciesSnapshot":"Object","iCalImportSource":"String","cancellationPolicySnapshot":"Object","_paymentConfirmation":"Enum","_paymentConfirmation_idx":"Integer","isActive":true,"recordVersion":"Integer","createdAt":"Date","updatedAt":"Date","_owner":"ID"},"paymentResult":{"paymentTicketId":"ID","orderId":"ID","paymentId":"String","paymentStatus":"Enum","paymentIntentInfo":"Object","statusLiteral":"String","amount":"Double","currency":"String","success":true,"description":"String","metadata":"Object","paymentUserParams":"Object"}}

For a detailed description of the `` api with its internal and inter-service logic please refer to the Business API Specification Document For Start Reservationpayment.

Refresh Reservationpayment API

API Definition : Refresh payment info for reservation from Stripe

API Crud Type : update

Default access route : PATCH /v1/refreshreservationpayment/:reservationId

Parameters

The refreshReservationPayment api has got 2 parameters

To access the api you can use the REST controller with the path PATCH /v1/refreshreservationpayment/:reservationId

  axios({
    method: 'PATCH',
    url: `/v1/refreshreservationpayment/${reservationId}`,
    data: {
            paymentUserParams:"Object",  
    
    },
    params: {
    
    }
  });

The API response is encapsulated within a JSON envelope. Successful operations return an HTTP status code of 200 for get, list, update, or delete requests, and 201 for create requests. Each successful response includes a "status": "OK" property. For error handling, refer to the "Error Response" section.

Following JSON represents the most comprehensive form of the reservation object in the respones. However, some properties may be omitted based on the object's internal logic.

{"status":"OK","statusCode":"200","elapsedMs":126,"ssoTime":120,"source":"db","cacheKey":"hexCode","userId":"ID","sessionId":"ID","requestId":"ID","dataName":"reservation","method":"PATCH","action":"update","appVersion":"Version","rowCount":1,"reservation":{"id":"ID","listingId":"ID","approvalType":"Enum","approvalType_idx":"Integer","bookingStatus":"Enum","bookingStatus_idx":"Integer","hostId":"ID","checkOut":"Date","guestId":"ID","checkIn":"Date","currency":"String","guestCount":"Integer","totalPrice":"Double","iCalExportUrl":"String","disputeStatus":"Enum","disputeStatus_idx":"Integer","bookingPoliciesSnapshot":"Object","iCalImportSource":"String","cancellationPolicySnapshot":"Object","_paymentConfirmation":"Enum","_paymentConfirmation_idx":"Integer","isActive":true,"recordVersion":"Integer","createdAt":"Date","updatedAt":"Date","_owner":"ID"},"paymentResult":{"paymentTicketId":"ID","orderId":"ID","paymentId":"String","paymentStatus":"Enum","paymentIntentInfo":"Object","statusLiteral":"String","amount":"Double","currency":"String","success":true,"description":"String","metadata":"Object","paymentUserParams":"Object"}}

For a detailed description of the `` api with its internal and inter-service logic please refer to the Business API Specification Document For Refresh Reservationpayment.

Callback Reservationpayment API

API Definition : Refresh payment values by gateway webhook call for reservation

API Crud Type : update

Default access route : POST /v1/callbackreservationpayment

Parameters

The callbackReservationPayment api has got 1 parameter

To access the api you can use the REST controller with the path POST /v1/callbackreservationpayment

  axios({
    method: 'POST',
    url: '/v1/callbackreservationpayment',
    data: {
            reservationId:"ID",  
    
    },
    params: {
    
    }
  });

The API response is encapsulated within a JSON envelope. Successful operations return an HTTP status code of 200 for get, list, update, or delete requests, and 201 for create requests. Each successful response includes a "status": "OK" property. For error handling, refer to the "Error Response" section.

Following JSON represents the most comprehensive form of the reservation object in the respones. However, some properties may be omitted based on the object's internal logic.

{"status":"OK","statusCode":"200","elapsedMs":126,"ssoTime":120,"source":"db","cacheKey":"hexCode","userId":"ID","sessionId":"ID","requestId":"ID","dataName":"reservation","method":"POST","action":"update","appVersion":"Version","rowCount":1,"reservation":{"id":"ID","listingId":"ID","approvalType":"Enum","approvalType_idx":"Integer","bookingStatus":"Enum","bookingStatus_idx":"Integer","hostId":"ID","checkOut":"Date","guestId":"ID","checkIn":"Date","currency":"String","guestCount":"Integer","totalPrice":"Double","iCalExportUrl":"String","disputeStatus":"Enum","disputeStatus_idx":"Integer","bookingPoliciesSnapshot":"Object","iCalImportSource":"String","cancellationPolicySnapshot":"Object","_paymentConfirmation":"Enum","_paymentConfirmation_idx":"Integer","isActive":true,"recordVersion":"Integer","createdAt":"Date","updatedAt":"Date","_owner":"ID"},"paymentResult":{"paymentTicketId":"ID","orderId":"ID","paymentId":"String","paymentStatus":"Enum","paymentIntentInfo":"Object","statusLiteral":"String","amount":"Double","currency":"String","success":true,"description":"String","metadata":"Object","paymentUserParams":"Object"}}

For a detailed description of the `` api with its internal and inter-service logic please refer to the Business API Specification Document For Callback Reservationpayment.

Get Paymentcustomerbyuserid API

API Definition : This route is used to get the payment customer information by user id.

API Crud Type : get

Default access route : GET /v1/paymentcustomers/:userId

Parameters

The getPaymentCustomerByUserId api has got 2 parameters

To access the api you can use the REST controller with the path GET /v1/paymentcustomers/:userId

  axios({
    method: 'GET',
    url: `/v1/paymentcustomers/${userId}`,
    data: {
    
    },
    params: {
    
    }
  });

The API response is encapsulated within a JSON envelope. Successful operations return an HTTP status code of 200 for get, list, update, or delete requests, and 201 for create requests. Each successful response includes a "status": "OK" property. For error handling, refer to the "Error Response" section.

Following JSON represents the most comprehensive form of the sys_paymentCustomer object in the respones. However, some properties may be omitted based on the object's internal logic.

{"status":"OK","statusCode":"200","elapsedMs":126,"ssoTime":120,"source":"db","cacheKey":"hexCode","userId":"ID","sessionId":"ID","requestId":"ID","dataName":"sys_paymentCustomer","method":"GET","action":"get","appVersion":"Version","rowCount":1,"sys_paymentCustomer":{"id":"ID","userId":"ID","customerId":"String","platform":"String","isActive":true,"recordVersion":"Integer","createdAt":"Date","updatedAt":"Date","_owner":"ID"}}

For a detailed description of the `` api with its internal and inter-service logic please refer to the Business API Specification Document For Get Paymentcustomerbyuserid.

List Paymentcustomers API

API Definition : This route is used to list all payment customers.

API Crud Type : list

Default access route : GET /v1/paymentcustomers

The listPaymentCustomers api has got no parameters.

To access the api you can use the REST controller with the path GET /v1/paymentcustomers

  axios({
    method: 'GET',
    url: '/v1/paymentcustomers',
    data: {
    
    },
    params: {
    
    }
  });

The API response is encapsulated within a JSON envelope. Successful operations return an HTTP status code of 200 for get, list, update, or delete requests, and 201 for create requests. Each successful response includes a "status": "OK" property. For error handling, refer to the "Error Response" section.

Following JSON represents the most comprehensive form of the sys_paymentCustomers object in the respones. However, some properties may be omitted based on the object's internal logic.

{"status":"OK","statusCode":"200","elapsedMs":126,"ssoTime":120,"source":"db","cacheKey":"hexCode","userId":"ID","sessionId":"ID","requestId":"ID","dataName":"sys_paymentCustomers","method":"GET","action":"list","appVersion":"Version","rowCount":"\"Number\"","sys_paymentCustomers":[{"id":"ID","userId":"ID","customerId":"String","platform":"String","isActive":true,"recordVersion":"Integer","createdAt":"Date","updatedAt":"Date","_owner":"ID"},{},{}],"paging":{"pageNumber":"Number","pageRowCount":"NUmber","totalRowCount":"Number","pageCount":"Number"},"filters":[],"uiPermissions":[]}

For a detailed description of the `` api with its internal and inter-service logic please refer to the Business API Specification Document For List Paymentcustomers.

List Paymentcustomermethods API

API Definition : This route is used to list all payment customer methods.

API Crud Type : list

Default access route : GET /v1/paymentcustomermethods/:userId

Parameters

The listPaymentCustomerMethods api has got 1 parameter

To access the api you can use the REST controller with the path GET /v1/paymentcustomermethods/:userId

  axios({
    method: 'GET',
    url: `/v1/paymentcustomermethods/${userId}`,
    data: {
    
    },
    params: {
    
    }
  });

The API response is encapsulated within a JSON envelope. Successful operations return an HTTP status code of 200 for get, list, update, or delete requests, and 201 for create requests. Each successful response includes a "status": "OK" property. For error handling, refer to the "Error Response" section.

Following JSON represents the most comprehensive form of the sys_paymentMethods object in the respones. However, some properties may be omitted based on the object's internal logic.

{"status":"OK","statusCode":"200","elapsedMs":126,"ssoTime":120,"source":"db","cacheKey":"hexCode","userId":"ID","sessionId":"ID","requestId":"ID","dataName":"sys_paymentMethods","method":"GET","action":"list","appVersion":"Version","rowCount":"\"Number\"","sys_paymentMethods":[{"id":"ID","paymentMethodId":"String","userId":"ID","customerId":"String","cardHolderName":"String","cardHolderZip":"String","platform":"String","cardInfo":"Object","isActive":true,"recordVersion":"Integer","createdAt":"Date","updatedAt":"Date","_owner":"ID"},{},{}],"paging":{"pageNumber":"Number","pageRowCount":"NUmber","totalRowCount":"Number","pageCount":"Number"},"filters":[],"uiPermissions":[]}

For a detailed description of the `` api with its internal and inter-service logic please refer to the Business API Specification Document For List Paymentcustomermethods.

Authentication Specific Routes

Common Routes

Route: currentuser

Route Definition: Retrieves the currently authenticated user's session information.

Route Type: sessionInfo

Access Route: GET /currentuser

Parameters

This route does not require any request parameters.

Behavior

• Returns the authenticated session object associated with the current access token.
• If no valid session exists, responds with a 401 Unauthorized.

// Sample GET /currentuser call
axios.get("/currentuser", {
  headers: {
    "Authorization": "Bearer your-jwt-token"
  }
});

Success Response Returns the session object, including user-related data and token information.

{
  "sessionId": "9cf23fa8-07d4-4e7c-80a6-ec6d6ac96bb9",
  "userId": "d92b9d4c-9b1e-4e95-842e-3fb9c8c1df38",
  "email": "user@example.com",
  "fullname": "John Doe",
  "roleId": "user",
  "tenantId": "abc123",
  "accessToken": "jwt-token-string",
  ...
}

Error Response 401 Unauthorized: No active session found.

{
  "status": "ERR",
  "message": "No login found"
}

Notes

• This route is typically used by frontend or mobile applications to fetch the current session state after login.
• The returned session includes key user identity fields, tenant information (if applicable), and the access token for further authenticated requests.
• Always ensure a valid access token is provided in the request to retrieve the session.

Route: permissions

*Route Definition*: Retrieves all effective permission records assigned to the currently authenticated user.

*Route Type*: permissionFetch

Access Route: GET /permissions

Parameters

This route does not require any request parameters.

Behavior

• Fetches all active permission records (givenPermissions entries) associated with the current user session.
• Returns a full array of permission objects.
• Requires a valid session (access token) to be available.

// Sample GET /permissions call
axios.get("/permissions", {
  headers: {
    "Authorization": "Bearer your-jwt-token"
  }
});

Success Response

Returns an array of permission objects.

[
  {
    "id": "perm1",
    "permissionName": "adminPanel.access",
    "roleId": "admin",
    "subjectUserId": "d92b9d4c-9b1e-4e95-842e-3fb9c8c1df38",
    "subjectUserGroupId": null,
    "objectId": null,
    "canDo": true,
    "tenantCodename": "store123"
  },
  {
    "id": "perm2",
    "permissionName": "orders.manage",
    "roleId": null,
    "subjectUserId": "d92b9d4c-9b1e-4e95-842e-3fb9c8c1df38",
    "subjectUserGroupId": null,
    "objectId": null,
    "canDo": true,
    "tenantCodename": "store123"
  }
]

Each object reflects a single permission grant, aligned with the givenPermissions model:

• **permissionName**: The permission the user has.
• **roleId**: If the permission was granted through a role. - **subjectUserId**: If directly granted to the user.
• **subjectUserGroupId**: If granted through a group.
• **objectId**: If tied to a specific object (OBAC).
• **canDo**: True or false flag to represent if permission is active or restricted.

Error Responses

• 401 Unauthorized: No active session found.

{
  "status": "ERR",
  "message": "No login found"
}

• 500 Internal Server Error: Unexpected error fetching permissions.

Notes

• The /permissions route is available across all backend services generated by Mindbricks, not just the auth service.
• Auth service: Fetches permissions freshly from the live database (givenPermissions table).
• Other services: Typically use a cached or projected view of permissions stored in a common ElasticSearch store, optimized for faster authorization checks.

Tip: Applications can cache permission results client-side or server-side, but should occasionally refresh by calling this endpoint, especially after login or permission-changing operations.

Route: permissions/:permissionName

Route Definition: Checks whether the current user has access to a specific permission, and provides a list of scoped object exceptions or inclusions.

Route Type: permissionScopeCheck

Access Route: GET /permissions/:permissionName

Parameters

Behavior

• Evaluates whether the current user has access to the given permissionName.
• Returns a structured object indicating:
  • Whether the permission is generally granted (canDo)
  • Which object IDs are explicitly included or excluded from access (exceptions)
• Requires a valid session (access token).

// Sample GET /permissions/orders.manage
axios.get("/permissions/orders.manage", {
  headers: {
    "Authorization": "Bearer your-jwt-token"
  }
});