Fikäfi APIs
  1. Tutorials
Fikäfi APIs
  • Fikäfi APIs
    • Getting Started
    • Authentication
    • API Error Handling
    • APIs / Endpoints
      • Authentication API
        • token API
          POST
      • Payments APIs
        • createPayment API
          POST
        • takePaymentAction API
          POST
        • createOnlinePayment API
          POST
      • Status API
        • getPaymentStatus API
          GET
        • getPayments API
          GET
      • Your Webhooks
        • paymentEvent webhook
          POST
        • paymentDetails Webhook
          POST
    • Tutorials
      • Request Payments
      • Check Status
      • Payment Failures
  1. Tutorials

Request Payments

🔍 Overview#

Allow hotels to collect guest payments through Fikäfi by integrating the complete booking-to-payment flow using APIs and webhook callbacks.
The hotel’s PMS or booking system can easily connect with Fikäfi — as explained here.

🧭 Step-by-Step Workflow#

At the time of booking:
1.
Hotel staff collects guest and booking information via a form on the PMS or booking system, as usual.

2.
Hotel staff clicks "Submit" on the form, and the PMS or booking system triggers Fikäfi’s /createPayment API to create a payment request.

3.
Fikäfi responds to the API and returns the following:
bookingRefNum (echoed from the request)
fikafiRefNum (a unique identifier from Fikäfi)
token (a token for secure authentication on the payment request UI)
url (a link to the payment request UI offered by Fikäfi)

4.
The PMS or booking system opens this url in a new tab or window of the browser.

5.
Hotel staff views the booking and payment details on the Payment Request UI for a final check, and then clicks Create Payment.

The job of the hotel staff is done.

Fikäfi payment process:
6.
Fikäfi:
Sends a paymentEvent webhook (with status set to Pending) to the hotel’s PMS or booking system
Initiates the process of collecting the payment from the guest
Activates its internal revenue assurance and payment orchestration engine (behind the scenes)

7.
The guest completes the payment.

Fikäfi updates:
8.
Fikäfi sends real-time updates to the PMS or booking system via Webhooks, including status and payment information.

9.
Alternatively, the hotel’s PMS or booking system can query the payment status anytime using the provided Status APIs.

Modified at 2025-06-15 06:50:27
Previous
paymentDetails Webhook
Next
Check Status
Built with