getPaymentStatus API

📊 Get Payment Status

This endpoint allows you to retrieve the latest status of payments for a booking. You must provide both your original booking reference and the Fikäfi-generated reference.

The response includes details about the current status, amount paid, outstanding amounts, and breakdown of partial payments (if applicable).

🔐 Required Headers

Include the following headers in your request:

Header Name	Type	Required	Description
`Authorization`	string	✅ Yes	Bearer token for API access
`Content-Type`	string	✅ Yes	Must be `application/json`

📤 Request Format

Make a POST request to the payment status endpoint with the relevant booking and Fikäfi reference identifiers.

📘 Status Values

The paymentStatus.status and each payments[].status field may return one of the following values:

Status	Description
`Complete`	Payment has been successfully completed in full.
`Pending`	Payment is requested but no action has been taken by the customer yet.
`Partial`	Card has been captured on file OR some partial payments have been charged.
`Expired`	Payment window has expired; further payments are no longer accepted.
`Canceled`	Payment request was canceled by the hotel.
`Declined`	Payment was declined by the gateway or customer’s bank.
`Refunded`	Payment was refunded after successful completion.

✅ A payment is marked as Partial when:

At least one entry in payments[] has status Complete, or

The isCardCaptured flag is true.

🧪 Mock Testing

You can test this endpoint without any backend integration by using our mock server.

Mock URL:
http://sandbox.fikafi.com/FikafiApi

curl --location --request GET 'https://demo.encorepay.co/FikafiSandbox/FikafiApi/api/getPaymentStatus?bookingRefNum=BKG123&fikafiRefNum=FIK7890' \ --header 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiIzMmVkOTI0OC1kNTc4LTQ3NzUtODYwYS1iZGZkOGExM2Y0MzciLCJ1bmlxdWVfbmFtZSI6IkFkbWluIiwiVXNlcklEIjoiMSIsIm5iZiI6MTc0MDM5Mzg4NywiZXhwIjoxNzQwNDgwMjg3LCJpYXQiOjE3NDAzOTM4ODd9.J6oPTYH9x5ia_a7OUBj9K038o8gu04gL4kLuVyJ8RQo'

{ "bookingRefNum": "BKG123", "fikafiRefNum": "FIK7890", "paymentStatus": { "status": "Partial", "isCardCaptured": true, "currency": "AED", "totalAmountReq": 2000, "totalAmountPaid": 1000, "numOfPaymentsReq": 2, "numOfPaymentsPaid": 1 }, "payments": [ { "paymentNumber": 1, "amount": 1000, "date": "2025-07-01", "status": "Complete", "paidAt": "2025-07-01T10:00:00Z" }, { "paymentNumber": 2, "amount": 1000, "date": "2025-07-03", "status": "Pending", "paidAt": null } ] }