Before your hotel can be integrated and go live on the BioduxPMS API, you must provide the following information. Each item is required to configure your hotel profile, populate the booking platform, and enable payment processing.📩 Submit all materials to the customer care representative or developer. Incomplete submissions will delay onboarding.
This information powers the GET /Hotel/Detail endpoint and is displayed across your booking platform.| Item | Format / Notes | API Field |
|---|
| Company full name | Text | name |
| Primary phone number | Include country code | phone |
| Secondary phone number (optional) | Include country code | phone2 |
| Email address | Official business email | email |
| Website URL | Full URL e.g. https://www.hotel.com | website |
| Hotel slogan / tagline (optional) | Short, one-line | slogan |
| Full address (line 1) | Street name and number | address |
| Full address (line 2) (optional) | Area, landmark, etc. | address2 |
| City | | city |
| State | | state |
| Country | | country |
| Instagram handle (optional) | Username only, e.g. @hotelname | instagram |
| Facebook page link (optional) | Full URL | facebook |
| X (Twitter) handle (optional) | Username only, e.g. @hotelname | x |
| WhatsApp number (optional) | Include country code | — |
Logo#
Provide a high-resolution logo in any of the following formats:PNG · PDF · CDR · PSD · AI · SVG · WEBP✅ Preferred formats: SVG or PNG with transparent background.
General Hotel Images#
Provide high-quality photographs of the following areas:Luxury or signature spaces
Any other key areas (restaurant, pool, gym, etc.)
📐 Minimum resolution: 1920 × 1080px. Landscape orientation preferred.
2. Legal & Policy Documents#
These are served via the GET /Term/Detail, GET /Privacy/Detail, and GET /CancelPolicy/Detail endpoints and displayed to guests during the booking process.| Document | Required | Notes |
|---|
| Terms & Conditions | ✅ Yes | Displayed before booking confirmation |
| Privacy Policy | ✅ Yes | Linked from guest registration form |
| Cancellation Policy | ✅ Yes | Shown before and during cancellation flow |
📄 Documents can be submitted as Word (.docx), PDF, or plain HTML. They will be rendered as formatted text on the booking platform.
Each room type must be submitted with the following. This data populates GET /RoomType/DetailList, GET /RoomType/Detail, and POST /Reservation/Availability.Per Room Type#
| Item | Required | Notes |
|---|
| Room type name | ✅ Yes | e.g. First Class Suite, Economy Room |
| Room description | ✅ Yes | Full write-up for the room detail page |
| List of amenities | ✅ Yes | See amenity checklist below |
| Maximum number of adults | ✅ Yes | Integer, e.g. 2 |
| Maximum number of children | ✅ Yes | Integer, e.g. 2 |
| Room rate per night | ✅ Yes | In local currency (NGN) |
| Room images | ✅ Yes | Minimum 4 images per room type |
Room Images#
Minimum 4 high-quality images per room type in landscape format
Each image should show a distinct area of the room:Kitchen or kitchenette (if applicable)
Sitting area (if applicable)
🗂️ Organise images into separate folders named after each room type before submitting.
e.g. First_Class_Suite/, Economy_Room/, Business_Suite/
📐 Minimum resolution: 1920 × 1080px. Landscape orientation required.
Amenity Checklist#
Include all that apply for each room type:
4. Payment Integration#
Required to enable online payment via Paystack on the booking platform. Used to configure POST /Paystack/Initialize and GET /Paystack/Verify.| Item | Required | Notes |
|---|
| Paystack Test Public Key | ✅ Yes | Starts with pk_test_... |
| Paystack Test Secret Key | ✅ Yes | Starts with sk_test_... |
| Paystack Live Public Key | ✅ Yes | Starts with pk_live_... |
| Paystack Live Secret Key | ✅ Yes | Starts with sk_live_... |
💡 To obtain your Paystack keys, log in to your Paystack Dashboard → Settings → API Keys & Webhooks.
5. Booking Configuration#
These settings are used to configure GET /Rule/Detail and control what reservations guests are allowed to make.| Item | Required | Description | Example |
|---|
| Check-in Time | ✅ Yes | Standard time a guest is officially allowed to check in. | 01:00 PM |
| Check-out Time | ✅ Yes | Standard time a guest must vacate the room. | 12:00 PM |
| Early Check-in Time | ❌ Optional | Earliest time a guest can check in before the standard check-in time. May incur an extra fee or be subject to room availability. | 10:00 AM |
| Late Check-out End | ❌ Optional | Latest time a guest is permitted to check out after the standard check-out time. May incur an extra fee. | 02:00 PM |
| Minimum Check-in Window | ✅ Yes | Minimum number of days from today that a booking can start. Prevents same-day or last-minute bookings if required. | 1 |
| Maximum Check-out Window | ✅ Yes | Maximum number of days into the future a guest is allowed to book. Limits how far ahead reservations can be made. | 120 |
| Minimum Stay Length | ✅ Yes | Minimum number of nights a guest must stay per reservation. Bookings below this threshold will be rejected. | 1 |
| Maximum Stay Length | ✅ Yes | Maximum number of nights allowed per single booking. Reservations exceeding this limit will not be permitted. | 30 |
| All Day Front Desk | ✅ Yes | Indicates whether the front desk operates 24 hours a day, 7 days a week. If No, provide opening and closing times below. | Yes / No |
| Front Desk Open | ❌ Conditional | Time the front desk begins operations each day. Required only if All Day Front Desk is No. | 07:00 AM |
| Front Desk Close | ❌ Conditional | Time the front desk stops operations each day. Required only if All Day Front Desk is No. | 10:00 PM |
Submission Checklist#
Use this checklist to confirm everything is ready before submitting:Once all items above are received and verified, onboarding and integration setup will be completed within the agreed timeline.
Modified at 2026-03-16 16:50:11
