AIRBNB

FRONTEND GUIDE FOR AI CODING AGENTS - PART 8 - BookingManagement Service

This document is a part of a REST API guide for the airbnb project. It is designed for AI agents that will generate frontend code to consume the project’s backend.

This document provides extensive instruction for the usage of bookingManagement

Service Access

BookingManagement service management is handled through service specific base urls.

BookingManagement service may be deployed to the preview server, staging server, or production server. Therefore,it has 3 access URLs. The frontend application must support all deployment environments during development, and the user should be able to select the target API server on the login page (already handled in first part.).

For the bookingManagement service, the base URLs are:

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

Scope

BookingManagement Service Description

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.

BookingManagement service provides apis and business logic for following data objects in airbnb application. Each data object may be either a central domain of the application data structure or a related helper data object for a central concept. Note that data object concept is equal to table concept in the database, in the service database each data object is represented as a db table scheme and the object instances as table rows.

reservation Data Object: Represents a guest's booking for a property listing, including dates, participants, approval/payment/dispute status, and iCal sync info...

paymentRecord Data Object: 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.

dispute Data Object: 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.

sys_reservationPayment Data Object: 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_paymentCustomer Data Object: A payment storage object to store the customer values of the payment platform

sys_paymentMethod Data Object: A payment storage object to store the payment methods of the platform customers

API Structure

Object Structure of a Successful Response

When the service processes requests successfully, it wraps the requested resource(s) within a JSON envelope. This envelope includes the data and essential metadata such as configuration details and pagination information, providing context to the client.

HTTP Status Codes:

• 200 OK: Returned for successful GET, LIST, UPDATE, or DELETE operations, indicating that the request was processed successfully.
• 201 Created: Returned for CREATE operations, indicating that the resource was created successfully.

Success Response Format:

For successful operations, the response includes a "status": "OK" property, signaling that the request executed successfully. 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.

Additional Data

Each API may include additional data besides the main data object, depending on the business logic of the API. These will be provided in each API’s response signature.

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 indicates the nature of the error, using commonly recognized codes for clarity:

• 400 Bad Request: The request was improperly formatted or contained invalid parameters.
• 401 Unauthorized: The request lacked a valid authentication token; login is required.
• 403 Forbidden: The current token does 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.

Each error response is structured to provide meaningful insight into the problem, assisting in efficient diagnosis and resolution.

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

Bucket Management

(This information is also given in PART 1 prompt.)

This application has a bucket service used to store user files and other object-related files. The bucket service is login-agnostic, so for write operations or private reads, include a bucket token (provided by services) in the request’s Authorization header as a Bearer token.

Please note that all other business services require the access token in the Bearer header, while the bucket service expects a bucket token because it is login-agnostic. Ensure you manage the required token injection properly; any auth interceptor should not replace the bucket token with the access token.

User Bucket This bucket stores public user files for each user.

When a user logs in—or in the /currentuser response—there is a userBucketToken to use when sending user-related public files to the bucket service.

{
  //...
  "userBucketToken": "e56d...."
}

To upload a file

POST {baseUrl}/bucket/upload

The request body is form-data which includes the bucketId and the file binary in the files field.

{
    bucketId: "{userId}-public-user-bucket",
    files: {binary}
}

Response status is 200 on success, e.g., body:

{
    "success": true,
    "data": [
        {
            "fileId": "9da03f6d-0409-41ad-bb06-225a244ae408",
            "originalName": "test (10).png",
            "mimeType": "image/png",
            "size": 604063,
            "status": "uploaded",
            "bucketName": "f7103b85-fcda-4dec-92c6-c336f71fd3a2-public-user-bucket",
            "isPublic": true,
            "downloadUrl": "https://babilcom.mindbricks.co/bucket/download/9da03f6d-0409-41ad-bb06-225a244ae408"
        }
    ]
}

To download a file from the bucket, you need its fileId. If you upload an avatar or other asset, ensure the download URL or the fileId is stored in the backend.

Buckets are mostly used in object creations that require an additional file, such as a product image or user avatar. After uploading your image to the bucket, insert the returned download URL into the related property of the target object record.

Application Bucket

This Airbnb application also includes a common public bucket that anyone can read, but only users with the superAdmin, admin, or saasAdmin roles can write (upload) to it.

When a user with one of these admin roles is logged in, the /login response or the /currentuser response also returns an applicationBucketToken field, which is used when uploading any file to the application bucket.

{
  //...
  "applicationBucketToken": "e23fd...."
}

The common public application bucket ID is

"airbnb3-public-common-bucket"

In certain admin areas—such as product management pages—since the user already has the application bucket token, they will be able to upload related object images.

Please configure your UI to upload files to the application bucket using this bucket token whenever needed.

Object Buckets Some objects may also return a bucket token for uploading or accessing files related to that object. For example, in a project management application, when you fetch a project’s data, a public or private bucket token may be provided to upload or download project-related files.

These buckets will be used as described in the relevant object definitions.

Reservation Data Object

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

Reservation Data Object Properties

Reservation data object has got following properties that are represented as table fields in the database scheme. These properties don't stand just for data storage, but each may have different settings to manage the business logic.

• Required properties are mandatory for creating objects and must be provided in the request body if no default value, formula or session bind is set.

Enum Properties

Enum properties are defined with a set of allowed values, ensuring that only valid options can be assigned to them. The enum options value will be stored as strings in the database, but when a data object is created an additional property with the same name plus an idx suffix will be created, which will hold the index of the selected enum option. You can use the {fieldName_idx} property to sort by the enum value or when your enum options represent a hiyerarchy of values. In the frontend input components, enum type properties should only accept values from an option component that lists the enum options.

• approvalType: [instant, manual]

• bookingStatus: [pending, confirmed, complete, cancelled, declined]

• disputeStatus: [none, requested, active, resolved]

• _paymentConfirmation: [pending, processing, paid, canceled]

Relation Properties

listingId hostId

Mindbricks supports relations between data objects, allowing you to define how objects are linked together. The relations may reference to a data object either in this service or in another service. Id the reference is remote, backend handles the relations through service communication or elastic search. These relations should be respected in the frontend so that instaead of showing the related objects id, the frontend should list human readable values from other data objects. If the relation points to another service, frontend should use the referenced service api in case it needs related data. The relation logic is montly handled in backend so the api responses feeds the frontend about the relational data. In mmost cases the api response will provide the relational data as well as the main one.

In frontend, please ensure that,

1- instaead of these relational ids you show the main human readable field of the related target data (like name), 2- if this data object needs a user input of these relational ids, you should provide a combobox with the list of possible records or (a searchbox) to select with the realted target data object main human readable field.

• listingId: ID Relation to listing.id

The target object is a parent object, meaning that the relation is a one-to-many relationship from target to this object.

Required: Yes

• hostId: ID Relation to user.id

The target object is a parent object, meaning that the relation is a one-to-many relationship from target to this object.

Required: Yes

Filter Properties

listingId approvalType bookingStatus hostId guestId checkIn _paymentConfirmation

Filter properties are used to define parameters that can be used in query filters, allowing for dynamic data retrieval based on user input or predefined criteria. These properties are automatically mapped as API parameters in the listing API's.

• listingId: ID has a filter named listingId

• approvalType: Enum has a filter named approvalType

• bookingStatus: Enum has a filter named bookingStatus

• hostId: ID has a filter named hostId

• guestId: ID has a filter named guestId

• checkIn: Date has a filter named checkIn

• _paymentConfirmation: Enum has a filter named _paymentConfirmation

PaymentRecord Data Object

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 Data Object Properties

PaymentRecord data object has got following properties that are represented as table fields in the database scheme. These properties don't stand just for data storage, but each may have different settings to manage the business logic.

• Required properties are mandatory for creating objects and must be provided in the request body if no default value, formula or session bind is set.

Enum Properties

Enum properties are defined with a set of allowed values, ensuring that only valid options can be assigned to them. The enum options value will be stored as strings in the database, but when a data object is created an additional property with the same name plus an idx suffix will be created, which will hold the index of the selected enum option. You can use the {fieldName_idx} property to sort by the enum value or when your enum options represent a hiyerarchy of values. In the frontend input components, enum type properties should only accept values from an option component that lists the enum options.

• paymentStatus: [pending, paid, refunded, failed]

Relation Properties

reservationId

Mindbricks supports relations between data objects, allowing you to define how objects are linked together. The relations may reference to a data object either in this service or in another service. Id the reference is remote, backend handles the relations through service communication or elastic search. These relations should be respected in the frontend so that instaead of showing the related objects id, the frontend should list human readable values from other data objects. If the relation points to another service, frontend should use the referenced service api in case it needs related data. The relation logic is montly handled in backend so the api responses feeds the frontend about the relational data. In mmost cases the api response will provide the relational data as well as the main one.

In frontend, please ensure that,

1- instaead of these relational ids you show the main human readable field of the related target data (like name), 2- if this data object needs a user input of these relational ids, you should provide a combobox with the list of possible records or (a searchbox) to select with the realted target data object main human readable field.

• reservationId: ID Relation to reservation.id

The target object is a parent object, meaning that the relation is a one-to-many relationship from target to this object.

Required: Yes

Dispute Data Object

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 Data Object Properties

Dispute data object has got following properties that are represented as table fields in the database scheme. These properties don't stand just for data storage, but each may have different settings to manage the business logic.

• Required properties are mandatory for creating objects and must be provided in the request body if no default value, formula or session bind is set.

Enum Properties

Enum properties are defined with a set of allowed values, ensuring that only valid options can be assigned to them. The enum options value will be stored as strings in the database, but when a data object is created an additional property with the same name plus an idx suffix will be created, which will hold the index of the selected enum option. You can use the {fieldName_idx} property to sort by the enum value or when your enum options represent a hiyerarchy of values. In the frontend input components, enum type properties should only accept values from an option component that lists the enum options.

• resolutionStatus: [pending, reviewing, resolved, rejected]

Relation Properties

reservationId raisedBy adminId relatedPaymentId

Mindbricks supports relations between data objects, allowing you to define how objects are linked together. The relations may reference to a data object either in this service or in another service. Id the reference is remote, backend handles the relations through service communication or elastic search. These relations should be respected in the frontend so that instaead of showing the related objects id, the frontend should list human readable values from other data objects. If the relation points to another service, frontend should use the referenced service api in case it needs related data. The relation logic is montly handled in backend so the api responses feeds the frontend about the relational data. In mmost cases the api response will provide the relational data as well as the main one.

In frontend, please ensure that,

1- instaead of these relational ids you show the main human readable field of the related target data (like name), 2- if this data object needs a user input of these relational ids, you should provide a combobox with the list of possible records or (a searchbox) to select with the realted target data object main human readable field.

• reservationId: ID Relation to reservation.id

The target object is a parent object, meaning that the relation is a one-to-many relationship from target to this object.

Required: Yes

• raisedBy: ID Relation to user.id

The target object is a parent object, meaning that the relation is a one-to-many relationship from target to this object.

Required: Yes

• adminId: ID Relation to user.id

The target object is a parent object, meaning that the relation is a one-to-many relationship from target to this object.

Required: No

• relatedPaymentId: ID Relation to paymentRecord.id

The target object is a parent object, meaning that the relation is a one-to-many relationship from target to this object.

Required: No

Sys_reservationPayment Data Object

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 Data Object Properties

Sys_reservationPayment data object has got following properties that are represented as table fields in the database scheme. These properties don't stand just for data storage, but each may have different settings to manage the business logic.

• Required properties are mandatory for creating objects and must be provided in the request body if no default value, formula or session bind is set.

Filter Properties

ownerId orderId paymentId paymentStatus statusLiteral redirectUrl

Filter properties are used to define parameters that can be used in query filters, allowing for dynamic data retrieval based on user input or predefined criteria. These properties are automatically mapped as API parameters in the listing API's.

• ownerId: ID has a filter named ownerId

• orderId: ID has a filter named orderId

• paymentId: String has a filter named paymentId

• paymentStatus: String has a filter named paymentStatus

• statusLiteral: String has a filter named statusLiteral

• redirectUrl: String has a filter named redirectUrl

Sys_paymentCustomer Data Object

A payment storage object to store the customer values of the payment platform

Sys_paymentCustomer Data Object Properties

Sys_paymentCustomer data object has got following properties that are represented as table fields in the database scheme. These properties don't stand just for data storage, but each may have different settings to manage the business logic.

• Required properties are mandatory for creating objects and must be provided in the request body if no default value, formula or session bind is set.

Filter Properties

userId customerId platform

Filter properties are used to define parameters that can be used in query filters, allowing for dynamic data retrieval based on user input or predefined criteria. These properties are automatically mapped as API parameters in the listing API's.

• userId: ID has a filter named userId

• customerId: String has a filter named customerId

• platform: String has a filter named platform

Sys_paymentMethod Data Object

A payment storage object to store the payment methods of the platform customers

Sys_paymentMethod Data Object Properties

Sys_paymentMethod data object has got following properties that are represented as table fields in the database scheme. These properties don't stand just for data storage, but each may have different settings to manage the business logic.

• Required properties are mandatory for creating objects and must be provided in the request body if no default value, formula or session bind is set.

Filter Properties

paymentMethodId userId customerId cardHolderName cardHolderZip platform cardInfo

Filter properties are used to define parameters that can be used in query filters, allowing for dynamic data retrieval based on user input or predefined criteria. These properties are automatically mapped as API parameters in the listing API's.

• paymentMethodId: String has a filter named paymentMethodId

• userId: ID has a filter named userId

• customerId: String has a filter named customerId

• cardHolderName: String has a filter named cardHolderName

• cardHolderZip: String has a filter named cardHolderZip

• platform: String has a filter named platform

• cardInfo: Object has a filter named cardInfo

API Reference

Update Dispute API

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

Rest Route

The updateDispute API REST controller can be triggered via the following route:

/v1/disputes/:disputeId

Rest Request Parameters

The updateDispute api has got 7 request parameters

REST Request 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: {
    
    }
  });

REST Response

{
	"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"
	}
}

Get Paymentrecord API

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

Rest Route

The getPaymentRecord API REST controller can be triggered via the following route:

/v1/paymentrecords/:paymentRecordId

Rest Request Parameters

The getPaymentRecord api has got 1 request parameter

REST Request 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: {
    
    }
  });

REST Response

{
	"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"
	}
}

Get Reservation API

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

Rest Route

The getReservation API REST controller can be triggered via the following route:

/v1/reservations/:reservationId

Rest Request Parameters

The getReservation api has got 1 request parameter

REST Request 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: {
    
    }
  });

REST Response

{
	"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"
	}
}

Create Dispute API

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).

Rest Route

The createDispute API REST controller can be triggered via the following route:

/v1/disputes

Rest Request Parameters

The createDispute api has got 10 request parameters

REST Request 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: {
    
    }
  });

REST Response

{
	"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"
	}
}

List Reservations API

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

Rest Route

The listReservations API REST controller can be triggered via the following route:

/v1/reservations

Rest Request Parameters The listReservations api has got no request parameters.

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

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

REST Response

{
	"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": []
}

Create Reservation API

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.

Rest Route

The createReservation API REST controller can be triggered via the following route:

/v1/reservations

Rest Request Parameters

The createReservation api has got 14 request parameters

REST Request 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: {
    
    }
  });

REST Response

{
	"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"
	}
}

Create Paymentrecord API

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).

Rest Route

The createPaymentRecord API REST controller can be triggered via the following route:

/v1/paymentrecords

Rest Request Parameters

The createPaymentRecord api has got 11 request parameters

REST Request 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: {
    
    }
  });

REST Response

{
	"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"
	}
}

List Paymentrecords API

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

Rest Route

The listPaymentRecords API REST controller can be triggered via the following route:

/v1/paymentrecords

Rest Request Parameters The listPaymentRecords api has got no request parameters.

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

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

REST Response

{
	"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": []
}

Delete Reservation API

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

Rest Route

The deleteReservation API REST controller can be triggered via the following route:

/v1/reservations/:reservationId

Rest Request Parameters

The deleteReservation api has got 1 request parameter

REST Request 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: {
    
    }
  });

REST Response

{
	"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"
	}
}

Update Reservation API

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.

Rest Route

The updateReservation API REST controller can be triggered via the following route:

/v1/reservations/:reservationId

Rest Request Parameters

The updateReservation api has got 5 request parameters

REST Request 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: {
    
    }
  });

REST Response

{
	"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"
	}
}

List Disputes API

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.

Rest Route

The listDisputes API REST controller can be triggered via the following route:

/v1/disputes

Rest Request Parameters The listDisputes api has got no request parameters.

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

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

REST Response

{
	"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": []
}

Get Dispute API

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

Rest Route

The getDispute API REST controller can be triggered via the following route:

/v1/disputes/:disputeId

Rest Request Parameters

The getDispute api has got 1 request parameter

REST Request 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: {
    
    }
  });

REST Response

{
	"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"
	}
}

Get Reservationpayment2 API

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

Rest Route

The getReservationPayment2 API REST controller can be triggered via the following route:

/v1/reservationpayment2/:sys_reservationPaymentId

Rest Request Parameters

The getReservationPayment2 api has got 1 request parameter

REST Request 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: {
    
    }
  });

REST Response

{
	"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"
	}
}

List Reservationpayments2 API

This route is used to list all payments.

Rest Route

The listReservationPayments2 API REST controller can be triggered via the following route:

/v1/reservationpayments2

Rest Request Parameters The listReservationPayments2 api has got no request parameters.

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

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

REST Response

{
	"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": []
}

Create Reservationpayment API

This route is used to create a new payment.

Rest Route

The createReservationPayment API REST controller can be triggered via the following route:

/v1/reservationpayment

Rest Request Parameters

The createReservationPayment api has got 5 request parameters

REST Request 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: {
    
    }
  });

REST Response

{
	"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"
	}
}

Update Reservationpayment API

This route is used to update an existing payment.

Rest Route

The updateReservationPayment API REST controller can be triggered via the following route:

/v1/reservationpayment/:sys_reservationPaymentId

Rest Request Parameters

The updateReservationPayment api has got 5 request parameters

REST Request 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: {
    
    }
  });

REST Response

{
	"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"
	}
}

Delete Reservationpayment API

This route is used to delete a payment.

Rest Route

The deleteReservationPayment API REST controller can be triggered via the following route:

/v1/reservationpayment/:sys_reservationPaymentId

Rest Request Parameters

The deleteReservationPayment api has got 1 request parameter

REST Request 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: {
    
    }
  });

REST Response

{
	"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"
	}
}

List Reservationpayments2 API

This route is used to list all payments.

Rest Route

The listReservationPayments2 API REST controller can be triggered via the following route:

/v1/reservationpayments2

Rest Request Parameters The listReservationPayments2 api has got no request parameters.

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

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

REST Response

{
	"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": []
}

Get Reservationpaymentbyorderid API

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

Rest Route

The getReservationPaymentByOrderId API REST controller can be triggered via the following route:

/v1/reservationpaymentbyorderid/:orderId

Rest Request Parameters

The getReservationPaymentByOrderId api has got 2 request parameters

REST Request 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: {
    
    }
  });

REST Response

{
	"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"
	}
}

Get Reservationpaymentbypaymentid API

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

Rest Route

The getReservationPaymentByPaymentId API REST controller can be triggered via the following route:

/v1/reservationpaymentbypaymentid/:paymentId

Rest Request Parameters

The getReservationPaymentByPaymentId api has got 2 request parameters

REST Request 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: {
    
    }
  });

REST Response

{
	"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"
	}
}

Get Reservationpayment2 API

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

Rest Route

The getReservationPayment2 API REST controller can be triggered via the following route:

/v1/reservationpayment2/:sys_reservationPaymentId

Rest Request Parameters

The getReservationPayment2 api has got 1 request parameter

REST Request 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: {
    
    }
  });

REST Response

{
	"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"
	}
}

Start Reservationpayment API

Start payment for reservation

Rest Route

The startReservationPayment API REST controller can be triggered via the following route:

/v1/startreservationpayment/:reservationId

Rest Request Parameters

The startReservationPayment api has got 2 request parameters

REST Request 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: {
    
    }
  });

REST Response

{
	"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"
	}
}

Refresh Reservationpayment API

Refresh payment info for reservation from Stripe

Rest Route

The refreshReservationPayment API REST controller can be triggered via the following route:

/v1/refreshreservationpayment/:reservationId

Rest Request Parameters

The refreshReservationPayment api has got 2 request parameters

REST Request 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: {
    
    }
  });

REST Response

{
	"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"
	}
}