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

Check Status

🔍 Overview#

Allow the hotel’s PMS or booking system to check the status of a guest’s payment at any time by calling Fikäfi’s getPaymentStatus API.
This provides real-time visibility into the current payment status, total paid vs. due amounts, and a breakdown of individual payments — enabling your system to make timely decisions such as sending reminders, retrying a failed payment, or closing a booking.

🧭 Step-by-Step Workflow#

After a payment is requested:
1.
The PMS or booking system can trigger a GET call to Fikäfi’s /getPaymentStatus API with these parameters:
bookingRefNum: Reference number used by the hotel
fikafiRefNum: Unique reference returned by Fikäfi in the /createPayment API response

2.
Fikäfi responds with up-to-date details including:
status: Current state of the payment (Pending, Partial, Complete, etc.)
totalAmountReq: Total amount expected
totalAmountPaid: Amount received so far
isCardCaptured: Indicates if a card has been securely saved
numOfPaymentsReq: Expected number of payments
numOfPaymentsPaid: Number of payments received
payments: Breakdown of each payment with amount, status and timestamp

3.
Based on this data, the PMS or booking system can:
Retry or resend a payment link
Notify the front desk or staff for follow-up
Mark a booking as expired or close it manually
Continue polling periodically to monitor payment progress

📤 Sample Request#


📤 Sample Response#


📤 Relevant API#

GET /getPaymentStatus Use this to track payment progress for a particular booking.
You can also use GET /getPayments for the records of all payments for multiple bookings.
Modified at 2025-06-15 06:50:38
Previous
Request Payments
Next
Payment Failures
Built with