getPayments API
GET
http://sandbox.fikafi.com/FikafiApi/api/payment/getPayments
📚 Get All Payments
🔐 Required Headers
| Header Name | Type | Required | Description |
|---|---|---|---|
Authorization | string | ✅ Yes | Bearer token for API access |
Content-Type | string | ✅ Yes | Must be application/json |
📤 Request Format
POST request to retrieve a list of payments across all bookings.📘 Status Values
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. |
Partial when:payments[] has status Complete, orisCardCaptured flag is true.🧪 Mock Testing
http://sandbox.fikafi.com/FikafiApiRequest
Query Params
Header Params
Responses
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET 'http://sandbox.fikafi.com/FikafiApi/api/payment/getPayments?hotel=Sunset Resort&fromDate=2025-04-01&toDate=2025-02-01' \
--header 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiIzMmVkOTI0OC1kNTc4LTQ3NzUtODYwYS1iZGZkOGExM2Y0MzciLCJ1bmlxdWVfbmFtZSI6IkFkbWluIiwiVXNlcklEIjoiMSIsIm5iZiI6MTc0MDM5Mzg4NywiZXhwIjoxNzQwNDgwMjg3LCJpYXQiOjE3NDAzOTM4ODd9.J6oPTYH9x5ia_a7OUBj9K038o8gu04gL4kLuVyJ8RQo'Response Response Example
{
"totalpayments": 2,
"propertyName": "Sunset Resort",
"allPayments": [
{
"bookingRefNum": "BKG20250401",
"fikafiRefNum": "FIK987654",
"paymentStatus": {
"status": "Completed",
"isCardCaptured": true,
"currency": "USD",
"totalAmountReq": 1500,
"totalAmountPaid": 1500,
"numOfPaymentsReq": 1,
"numOfPaymentsPaid": 1
},
"payments": [
{
"paymentNumber": 1,
"amount": 1500,
"date": "2025-04-01",
"status": "Paid",
"paidAt": "2025-04-01T10:00:00Z"
}
]
},
{
"bookingRefNum": "BKG20250402",
"fikafiRefNum": "FIK987655",
"paymentStatus": {
"status": "Partial",
"isCardCaptured": true,
"currency": "USD",
"totalAmountReq": 3000,
"totalAmountPaid": 1000,
"numOfPaymentsReq": 3,
"numOfPaymentsPaid": 1
},
"payments": [
{
"paymentNumber": 1,
"amount": 1000,
"date": "2025-04-02",
"status": "Paid",
"paidAt": "2025-04-02T09:00:00Z"
},
{
"paymentNumber": 2,
"amount": 1000,
"date": "2025-04-03",
"status": "Pending",
"paidAt": null
},
{
"paymentNumber": 3,
"amount": 1000,
"date": "2025-04-04",
"status": "Pending",
"paidAt": null
}
]
}
]
}Modified at 2025-06-18 07:21:51