Maxxton External API
The document comprises RESTful web services which refers to the methods (GET, POST, PUT, DELETE), endpoints of the APIs, required fields and explains what services consumes and produces. It also tells what data is to be sent in request body and what will be returned in response body. The dates that are being entered along with time depicts the UTC time zone and the one without time represents just that day.
Base URL
Production:
https://api.maxxton.net
Accommodation Types
A collection of similar units grouped together.
AddOn
A product or extra that can be booked optionally in a reservation or will be added mandatory to the reservation. Examples of optional addons are: bedlinnen, breakfast, baby cot. Example of mandatory addons are: cleaning, tourist tax
Admin Organisation
A main level to funnel the companies, locations, employees, accounts and other properties that exclusively belongs to that Admin organisation.
Allotment
The allocation of a certain number of accommodation types or units for a specific period or purpose per distribution channel.
Amenity
A feature or service provided to enhance the guest experience, such as a pool, gym, or Wi-Fi.
Authentication
Authenticate to get access to the API. Authentication details can be provided by the Maxxton client who would like to give access to their environment using the API.
Brands
A distinctive name associated with a specific product or service.
Cash Clearance
The process of reconciling and recording cash transactions to ensure accurate financial records.
Contracts
A formal agreement outlining the terms and conditions between an owner and an organisation about renting his unit.
Countries
All available countries, the countries are configured in Maxxton.
Currency
The type of money used in financial transactions, such as USD or EUR.
Customer Status
A certain label that is given to a customer. This can be assigned automatically or manually.
Customers
An individual or entity that purchases or uses accommodations or services.
DistributionChannels
The sales channel through which products or services are delivered to customers.
Employee
An individual working for an organization, responsible for various tasks or roles.
Events
When certain entities are changed this will result in an event. This event can be used to update/refresh the data in the external system.
Facilities
A physical location or infrastructure used to support operations or services.
Groups
Grouping of certain entities such as marketing groups, location groups in Maxxton.
Housekeeping
A specific job or duty that needs to be done on an accommodation on a specified date and time.
Icals
Ical calendar file to show reservations made for a certain unit. Mostly used for owners to show the usage of their unit.
Infotexts
A piece of informative text visible to the customer.
Languages
The choice of language for user interfaces, or communication within the system.
Ledgers
A comprehensive record of all financial transactions, including accounts and balances.
Locations
A physical place or address where accommodations or services are provided like a location.
Locks
A lock will make the accommodationtype or unit unavailable to book because of a certain reason like maintenance.
Memos
A remark or informative text added to an entity.
Offer
A discount or additional product/service that can be added to a reservation.
Operations
Technical services which handles tasks to fix issues or maintenance in units.
Owners
An individual or entity that holds a contractual agreement with the admin organization. Based on this agreement, the owner earns income when specific accommodations they control are utilized in reservations.
Packages
Multiple add-ons which can be booked together.
Payment Term Set
Conditions like when and in how many times to pay the full reservation. The payment term sets will result in the instalments, with the actual amount to pay, when chosen in the reservation.
Points Of Interests
Certain interesting features around the location such as cities, airports, theme parks.
Predefined Memo
A brief written message or note used for communication or record-keeping within the software.
Rate Types
The category or classification of rates based on their application and currency such as BAR rate or tour operator rate.
Region
A geographical area or division used for organizing and managing locations or data.
Rentability
The rules and conditions that define how an accommodation, product or services property can be booked or used. For example, the allowed arrival and departure date for an accommodation type.
Representation
Triangle view of rentability, accommodation type, and distribution channel. Representations exist to connect a (set) of rentability rules to a (group) of distribution channels.
Resellers
An individual or entity that sells products or services on behalf of another company.
Reservability
Actual count of available units per period or date without considering if it's allowed to arrive or depart on the certain date.
Reservations
An arrangement to secure an accommodation or service for a specific time and date.
Creates a new reservation
Creates a new reservation based on given criteria. Reservation with multiple AccommodationType does not support VoucherCode, and in case codes are provided then an error is thrown.
Header Parameters
The name field in bill and reservedResources along with the infoTexts will be translated according to the locale passed, example for possible values: en(English), nl(Dutch), fr(French) etc.
Query Parameters
The customer bill will be returned when the value is set to true
The instalments will be returned when the value is set to true
This parameter will skip the check on availability based on the Elastic search availability index. This can be used if a reservation needs to be made when you can't wait for the index to be updated. It's recommended to not use this parameter in case you are not really sure what you are doing. By default, this check is always there because it's giving better performance in case of no availability. When this parameter is true - unitId is mandatory in request.
Body Parameters
Unique code associated with distribution channel.
Unique code associated with reservation category.
It contains the details of the accommodationtype for which the reservation is made.
Show child attributes
If guest wants to specify some feedback to the location, then the feedback given by the customer is displayed.
If the tour operator wants to store their reservation reference number, then it is displayed under this field.
This is not changing the employee who created the reservation, as this is still the employee linked to the API key. This field will set the initials in the reservation.
This field specifies how the guest can be communicated to i.e via email or post
This field hold the status, in which reservation will create. We create reservation with OPTIONAL or QUOTATION or PROVISIONAL or PRE_BOOKING or REQUEST status. Note: To create a confirm booking this field should not be passed. The fields statusValue and status are the same and they are here for legacy reasons.
PROVISIONALDELETEDDEF_CANCELLEDCANCELLEDEXPIREDDECLINEDQUOTATIONCHOICEBASKETINITIAL... 7 other enums
Unique id associated with the customer. In case a reservation for an existing/logged in customer is created this field can be used. The customer Id is provided when the customer login using POST /maxxton/v2/customers/login.
details related to the customer. This entity will create a new customer, in case the customer needs to login use customerId field instead.
Show child attributes
Unique id of the rate types, for which the cashflow is applicable.
Response
Response Attributes
Unique id of newly created reservation.
Represent the unique number of newly created reservation.
The date on which customer/guest will arrive. Date should be added using ISO 8601 standard(yyyy-MM-dd)
Unique code represent the currency in which the reservation payment is done.
The date on which customer/guest will leave the accommodation. Date should be added using ISO 8601 standard(yyyy-MM-dd)
Date on which the reservation is created.
This field holds the status, in which reservation is created. Possible status can be: OPTIONAL, QUOTATION, PROVISIONAL, REQUEST
PROVISIONALDELETEDDEF_CANCELLEDCANCELLEDEXPIREDDECLINEDQUOTATIONCHOICEBASKETINITIAL... 7 other enums
The unique id represents the location in which the accommodationtype is located.
It represents the tour operator's reservation reference number.
The unique id represents the the customer/guest who requested for the reservation.
The bill of the customer for which the reservation is created.
Show child attributes
The bill of agent or tour operator or any third party who made the reservation on behalf of the customer.
Show child attributes
The list of resources which are booked as part of the reservation.
Show child attributes
Represent any information that is related to the location.
Show child attributes
As per the payment terms configuration , installments are generated for the entire bill.
Show child attributes
Possible values for reservation status DELETED(-99), DEFINITIVE_CANCELLED(-13), CANCELLED(-12), EXPIRED(-11), DECLINED(-10), QUOTATION(-5), INITIAL(0 ), REQUEST(10), OPTIONAL(11), PROVISIONAL(12), DEFINITIVE(21), CHECKED_IN(31), CHECKED_OUT(41)
Response
{
"reservationId": 0,
"reservationNumber": "string",
"arrivalDate": "2025-05-21",
"currencyCode": "string",
"departureDate": "2025-05-21",
"reservationDate": "2025-05-21T05:11:30.765Z",
"statusValue": "PROVISIONAL",
"locationId": 0,
"externalBookingReference": "string",
"customerId": 0,
"customerBill": [
{
"resourceId": 0,
"name": "string",
"endDate": "2025-05-21",
"startDate": "2025-05-21",
"billLineType": 10,
"total": 0,
"vatRate": 0,
"redeemedLoyaltyPoints": 0,
"redeemedLoyaltyNights": 0,
"reservedResourceId": 0
}
],
"agentBill": [
{
"resourceId": 0,
"name": "string",
"endDate": "2025-05-21",
"startDate": "2025-05-21",
"billLineType": 10,
"total": 0,
"vatRate": 0,
"redeemedLoyaltyPoints": 0,
"redeemedLoyaltyNights": 0,
"reservedResourceId": 0
}
],
"reservedResources": [
{
"type": "ACCOMMODATIONTYPE",
"resourceId": 0,
"reservedResourceId": 0,
"parentId": 0,
"name": "string",
"startDate": "2025-05-21",
"endDate": "2025-05-21",
"price": 0,
"quantity": 0,
"shortDescription": "string",
"description": "string",
"unitId": 0,
"hasPriceOverride": true,
"removable": true,
"infotexts": [
{
"description": "string",
"code": "string",
"categoryCode": "string"
}
],
"offerType": "GENERAL_SPECIAL",
"code": "string",
"imply": true
}
],
"locationInfotexts": [
{
"description": "string",
"code": "string",
"categoryCode": "string"
}
],
"instalments": [
{
"term": "string",
"value": 0,
"payerType": "string",
"dueDate": "2025-05-21",
"status": "string",
"issueDate": "2025-05-21",
"taxValue": 0,
"due": 0,
"autopay": true
}
],
"status": 0,
"paymentTermSetId": 0
}Creates a reservation proposal
Creates a reservation proposal based on given criteria. The endpoint provides the availability for a particular property for particular duration. It also provides a virtual bill to the user which contains all the possible additions for a reservation, the currency code is displayed in which the bill will be calculated, customers arrival and departure date, customer bill, installments etc. We can specify the information that we want to view in response i.e there are different query parameters to filter the response. The additions displayed in reservation proposal are displayed on the basis of show moments. There are four show moments for additions i.e mobile, internet, my environment and newyse. The show moments is displayed in the reservation proposal only if the show moment is internet. Reservation with multiple AccommodationType does not support VoucherCode, and in case codes are provided then an error is thrown.
Header Parameters
The name field in bill and reservedResources along with the infoTexts will be translated according to the locale passed, example for possible values: en(English), nl(Dutch), fr(French) etc.
Query Parameters
The applicable additions will be returned when the value is set to true
The customer bill will be returned when the value is set to true
The instalments of reservation will be returned when the value is set to true
This parameter will provide all possible payment term sets available, including the instalments for the provided criteria. The payment term set id can be provided in the “paymenttermsetid“ in the request to use the payment option. In case no payment option is set, it will take the one with the highest priority.
The list of available unit will be returned when the value is set to true.
This parameter will skip the check on availability based on the Elastic search availability index. This can be used if a reservation needs to be made when you can't wait for the index to be updated. It's recommended to not use this parameter in case you are not really sure what you are doing. By default, this check is always there because it's giving better performance in case of no availability. When this parameter is true - unitId is mandatory in the request.
Body Parameters
Unique code of distribution-channel.
Unique code of reservation-category.
It contains the details of the accommodationtype for which the reservation is made.
Show child attributes
Unique id of the rate types for which the cashflow is applicable.
Response
Response Attributes
Unique code represent the currency in which the reservation payment is done.
The date on which customer/guest will arrive.
The date on which customer/guest will leave the accommodation.
The bill of the customer for which the reservation is created.
Show child attributes
The bill of agent or tour opertor or any third party who made the reservation on behalf of customer.
Show child attributes
As per the payment terms configuration , installments are generated for the entire bill.
Show child attributes
The list of resources, which are booked as part of the reservation.
Show child attributes
Represent the any information that is related to the accommodationtype.
Show child attributes
This field shows whether if it's a pre-booking or not
Provide all possible payment term sets available, including the instalments for the provided criteria. The payment term set id can be provided in the “paymenttermsetid“ in the request to use the payment option in instalments. In case no payment option is set, it will take the one with the highest priority for the instalments.
Show child attributes
List of addition and unitIds per accommodation types
Show child attributes
Response
{
"currencyCode": "string",
"arrivalDate": "2025-05-21",
"departureDate": "2025-05-21",
"customerBill": [
{
"resourceId": 0,
"reservedResourceProposalId": 0,
"name": "string",
"vatRate": 0,
"billLineType": 10,
"value": 0,
"quantity": 0,
"multiplier": 0,
"total": 0,
"redeemedLoyaltyPoints": 0,
"redeemedLoyaltyNights": 0,
"startDate": "2025-05-21",
"endDate": "2025-05-21"
}
],
"agentBill": [
{
"resourceId": 0,
"reservedResourceProposalId": 0,
"name": "string",
"vatRate": 0,
"billLineType": 10,
"value": 0,
"quantity": 0,
"multiplier": 0,
"total": 0,
"redeemedLoyaltyPoints": 0,
"redeemedLoyaltyNights": 0,
"startDate": "2025-05-21",
"endDate": "2025-05-21"
}
],
"instalments": [
{
"term": "string",
"value": 0,
"payerType": "string",
"dueDate": "2025-05-21",
"status": "string",
"issueDate": "2025-05-21",
"taxValue": 0,
"due": 0,
"autopay": true
}
],
"reservedResources": [
{
"resourceId": 0,
"reservedResourceProposalId": 0,
"offerType": "GENERAL_SPECIAL",
"code": "string",
"type": "string",
"infotexts": [
{
"name": "string",
"display": "string",
"description": "string",
"code": "string",
"categoryCode": "string"
}
],
"name": "string",
"shortDescription": "string",
"description": "string",
"startDate": "2025-05-21",
"endDate": "2025-05-21",
"price": 0,
"quantity": 0,
"unitId": 0,
"hasPriceOverride": true,
"removable": true,
"imply": true,
"impliesId": 0,
"internetAdditionalCost": true,
"addOnMetricDescription": "string"
}
],
"locationInfotexts": [
{
"name": "string",
"display": "string",
"description": "string",
"code": "string",
"categoryCode": "string"
}
],
"preBooking": true,
"paymentOptions": [
{
"paymentTermSetId": 0,
"name": "string",
"description": "string",
"priority": 0,
"autoPay": true,
"nonRefundable": true,
"customerInstalments": [
{
"name": "string",
"priority": 0,
"dueDate": "2025-05-21",
"dueAmount": 0
}
],
"agentInstalments": [
{
"name": "string",
"priority": 0,
"dueDate": "2025-05-21",
"dueAmount": 0
}
]
}
],
"accommodationTypes": [
{
"resourceId": 0,
"additions": [
{
"additionResourceId": 0,
"name": "string",
"code": "string",
"price": 0,
"type": "string",
"description": "string",
"shortDescription": "string",
"currency": "string",
"maxQuantity": 0,
"minQuantity": 0,
"maxReservable": 0,
"startDate": "2025-05-21",
"endDate": "2025-05-21",
"locationArticle": true,
"addonType": "string",
"stockType": "string",
"dayAddon": true,
"perSubject": true,
"dayProductBookableDates": [
""
],
"linkedWithSupplier": true
}
],
"unitIds": [
""
]
}
]
}Get all reservations
Get all the reservations for particular concern as per the access token and if dc is null then all the reservations of all the dcs are fetched in response.
Query Parameters
Filter reservations on customer name. Customer name should be provided in the format specified as: {first name} {middle name} {last name}. Ex: first name = x, middle name = y and last name = z, then the filter field will be passed as: customerName=x y z.
If DC is present in the access token then the reservations of that DC will be retrieved. If DC is null in access token then the DC entered in filter will be considered. If both DCs are null then all the reservations from all the dc will be fetched.
The unitId for filtering the reservations
Page number
Size of the current page
Sort parameter
Following fields can be used for filtering response.
reservationId:0,
arrivalDate:2025-05-21,
customerId:0,
departureDate:2025-05-21,
distributionChannelId:0,
modifiedDate:2025-05-21T05:11:30.794Z,
reservationCategoryId:0,
reservationDate:2025-05-21T05:11:30.794Z,
reservationNumber:String,
locationId:0,
status:0,
supplierVoucher:String,
tncSigned:true,
tncSignedDate:2025-05-21,
tncSigneeCustomerName:String,
type:String,...
Response
Response Attributes
Total number of elements available in the whole response.
Total number of pages the response has.
Boolean field to specify if its the first page or not.
Boolean field to specify if its the last page or not.
Size of the current page.
Show child attributes
Page number currently accessed.
Show child attributes
Total number of elements in the current page.
Response
{
"totalElements": 0,
"totalPages": 0,
"first": true,
"last": true,
"size": 0,
"content": [
{
"reservationId": 0,
"categoryName": "string",
"categoryCode": "string",
"arrivalDate": "2025-05-21",
"customerId": 0,
"departureDate": "2025-05-21",
"distributionChannelId": 0,
"modifiedDate": "2025-05-21T05:11:30.764Z",
"reservationCategoryId": 0,
"reservationDate": "2025-05-21T05:11:30.764Z",
"reservationNumber": "string",
"locationId": 0,
"status": 0,
"supplierVoucher": "string",
"tncSigned": true,
"tncSignedDate": "2025-05-21",
"tncSigneeCustomerName": "string",
"type": "string",
"expectedArrivalDateTime": "2025-05-21T05:11:30.764Z",
"expectedDepartureDateTime": "2025-05-21T05:11:30.764Z",
"validationStatus": -101,
"voucher": "string",
"parentId": 0,
"cancelDate": "2025-05-21",
"originId": "string",
"origin": "string",
"expireDate": "2025-05-21T05:11:30.764Z",
"printedDate": "2025-05-21",
"resellerId": 0,
"statusValue": "PROVISIONAL",
"sendMethodId": 0,
"paymentTermSetId": 0,
"reservationKind": "ACCOMMODATION_RESERVATION",
"payingCustomerId": 0,
"externalBookingReference": "string"
}
],
"number": 0,
"sort": [
{
"direction": "string",
"nullHandling": "string",
"ascending": true,
"property": "string",
"ignoreCase": true
}
],
"numberOfElements": 0,
"empty": true
}Get reservation
Get a single Reservation by reservation id. You can use other calls, like /content or /customers to gather more detailed information.
Path Parameters
The identifier of the reservation.
Response
Response Attributes
Possible values for reservation status DELETED(-99), DEFINITIVE_CANCELLED(-13), CANCELLED(-12), EXPIRED(-11), DECLINED(-10), QUOTATION(-5), INITIAL(0 ), REQUEST(10), OPTIONAL(11), PROVISIONAL(12), DEFINITIVE(21), CHECKED_IN(31), CHECKED_OUT(41)
If a location is linked to a supplier system, then creating a booking on this location will also create a reservation in supplier system and the supplier booking reference number will be available in this field.
Possible values for reservation type 1.RESERVATION:The RESERVATION is a regular reservation. 2.INVOICE:The INVOICE is used to create an invoice for example for owners. 3.CASH:CASH is a cash transaction done on location for example in a shop. 4.ALLOTMENT:ALLOTMENT is an open stay for allotment, this needs to be booked as a regular booking by a channel that is based on this allotment.
PARK 111(-101) PARK 222(-99) PARK 333(-86) PARK 444(-42) PARK 555(-23) PARK 666(-22) PARK 777(-21) PARK 888(-20) PARK 999(-19) NEVER TO BE SENT(-5) UNVALIDATED(0) VALIDATING(11) TO BE PROCESSED(15) SEMI AUTOMATICALLY VALIDATED(16) TO BE VALIDATED(20) VALID(21) AUTOMATICALLY VALIDATED(22) SENT(31) TO BE INVOICED(41) INFORMATION NOT SEND(51) INFORMATION SEND(55)
It's an external booking reference number of the system, from where the reservation was made.
PROVISIONALDELETEDDEF_CANCELLEDCANCELLEDEXPIREDDECLINEDQUOTATIONCHOICEBASKETINITIAL... 7 other enums
Possible values for reservation kind ACCOMMODATION_RESERVATION("acco"), ADDON_RESERVATION("addon"), GROUP_RESERVATION("group")
ACCOMMODATION_RESERVATIONADDON_RESERVATIONGROUP_RESERVATIONResponse
{
"reservationId": 0,
"categoryName": "string",
"categoryCode": "string",
"arrivalDate": "2025-05-21",
"customerId": 0,
"departureDate": "2025-05-21",
"distributionChannelId": 0,
"modifiedDate": "2025-05-21T05:11:30.764Z",
"reservationCategoryId": 0,
"reservationDate": "2025-05-21T05:11:30.764Z",
"reservationNumber": "string",
"locationId": 0,
"status": 0,
"supplierVoucher": "string",
"tncSigned": true,
"tncSignedDate": "2025-05-21",
"tncSigneeCustomerName": "string",
"type": "string",
"expectedArrivalDateTime": "2025-05-21T05:11:30.764Z",
"expectedDepartureDateTime": "2025-05-21T05:11:30.764Z",
"validationStatus": -101,
"voucher": "string",
"parentId": 0,
"cancelDate": "2025-05-21",
"originId": "string",
"origin": "string",
"expireDate": "2025-05-21T05:11:30.764Z",
"printedDate": "2025-05-21",
"resellerId": 0,
"statusValue": "PROVISIONAL",
"sendMethodId": 0,
"paymentTermSetId": 0,
"reservationKind": "ACCOMMODATION_RESERVATION",
"payingCustomerId": 0,
"externalBookingReference": "string"
}Update reservation
Update an existing reservation based on given details. The user can change the status of the reservation as per the below status flow specified: QUOTATION(-5) -> CONFIRM(10), DECLINE(-10) OPTIONAL(11) -> CONFIRM(10), DECLINE(-10) REQUEST(10)->DECLINE(-10), CONFIRM(12) PROVISIONAL(12) -> CANCEL(-12), DECLINE(-10) DEFINITIVE(21)->CANCEL(-12), CHECKED_IN(31) CHECKED_IN(31)->CHECKED_OUT(41). The expectedArrivalDateTime and expectedDepartureDateTime should be passed in the below format: 'YYYY-MM-DDThh:mm:ss' The above fields are mainly used by the receptionist of the location, by maintenance department and housekeeping.
Path Parameters
Id of the reservation which needs to be updated.
Body Parameters
Reservation status can be change from existing status to the provided status. Possible reservation status that can be provided, are : CANCEL(-12), DECLINE(-10), CHECKED_IN(31), CONFIRM(33), CHECKED_OUT(41).
CANCELDECLINEQUOTATIONINITIALPRE_BOOKINGREQUESTOPTIONALPROVISIONALDEFINITIVECHECKED_IN... 2 other enums
The list of reserved resources customer expects to change
Show child attributes
The reason why the reservation is being cancelled or declined. This field is only used when the status is set and updated to CANCEL or DECLINE.
Response
Response Attributes
Unique id associated with reservation.
The reservation status after update process. Possible status values can be: DELETED, CANCELLED, DECLINED, PROVISIONAL, DEFINITIVE
PROVISIONALDELETEDDEF_CANCELLEDCANCELLEDEXPIREDDECLINEDQUOTATIONCHOICEBASKETINITIAL... 7 other enums
The list of reserved resources customer expects to change
Show child attributes
Id of the payment term set selected for the reservation.
Show child attributes
Response
{
"reservationId": 0,
"statusValue": "PROVISIONAL",
"reservedResources": [
{
"reservedResourceId": 0,
"expectedArrivalDateTime": "2025-05-21T05:11:30.766Z",
"expectedDepartureDateTime": "2025-05-21T05:11:30.766Z"
}
],
"paymentTermSetId": 0,
"infotexts": [
{
"description": "string",
"code": "string",
"categoryCode": "string"
}
]
}Amenities
Bills
Categories
Content
Creditcardauthorisations
Details
Doorlocks
Emergencycontacts
Infotexts
A piece of informative text visible to the customer.
Instalments
Journals
Memos
A remark or informative text added to an entity.
Paymentlink
Get paymentlink for a reservation
Generate a PSP(payment service provider) payment link to pay for the reservation. This will provide a url which can be used by the customer to make the payment from the hosted payment page of the psp. When the payment is succesful it will automatically be added to the reservation in the Maxxton system.
Header Parameters
The name field in paymentPage generate along with the infoTexts will be translated according to the locale passed, example for possible values: en(English), nl(Dutch), fr(French) etc.
Query Parameters
URL where the customer should be redirected to in case of a successful payment. This parameter is only supported in legacy Ingenico and not supported in Ingenico Direct
URL where the customer should be redirected to in case of a canceled payment. This parameter is only supported in legacy Ingenico and not supported in Ingenico Direct
CountryCode(e.g. NL/FR) required to fetch the correct payment methods from Ingenico to be used with paymentMethods parameter. This countrycode is not impacting the actual language or locale of the Ingenico page
Code of currency in which payment will be charged
URL where the customer should be redirected to in case of a declined payment. This parameter is only supported in legacy Ingenico and not supported in Ingenico Direct
URL where the customer should be redirected to in case of a failed payment. This parameter is only supported in legacy Ingenico and not supported in Ingenico Direct
Home Url of website. This parameter is only supported in legacy Ingenico and not supported in Ingenico Direct
Payer type of payment
PAYING_CUSTOMERAGENTCUSTOMERPayment methods list which will be shown on payment page. Incase not provided all configured payment methods will be shown. To restrict the payment methods, take the paymentMethod field values from the following endpoint https://developers.maxxton.com/rest-api/reservations-2/paymentmethods-1/get-all-paymentmethods-for-a-reservation Then, pass the paymentMethod obtained from this endpoint in the generatePaymentLink requestParam.
Amount to be paid, this can be the full reservation amount or part of it.
The returnUrl parameter specifies the URL to which a customer is redirected after completing a transaction on the Ingenico Direct payment page. This parameter is specific to Ingenico Direct and simplifies the redirection process by consolidating multiple URL parameters used in the legacy Ingenico platform into a single parameter. In the legacy platform, separate URLs (such as declineUrl, acceptUrl, cancelUrl, homeUrl, and exceptionUrl) are used based on the transaction result. These...
When the value is set to true, the customer's credit card details will be saved, and a reservation payment token will be generated for further payments
Path Parameters
The reservation id defines the reservation the payment goes to. When a payment comes in from Ingenico the open amount of this reservation will be deducted with the amount paid at Ingenico.
Response
Response Attributes
Response
{
"url": "string"
}Paymentmethods
Payments
Paymenttermsets
Preferences
Proposals
Reminders
Reservedresources
Sources
Subjects
A classification of individuals, pets, travel methods, or equipment based on specific criteria such as age, size, etc.
Termsandconditions
Room Types
The classification of rooms based on their characteristics, such as bedroom, bathroom, or living area.
Rooms
A distinct space within a unit provided for guests to stay.
Send Methods
Defines how to communicate with the customer.
Subjects
A classification of individuals, pets, travel methods, or equipment based on specific criteria such as age, size, etc.
Suppliers
An integration with Maxxton to make it possible to to book external inventory from the Maxxton system
Units
A place where guests stay, such as a hotel room, apartment, or vacation rental.