Fikäfi APIs
  1. Your Webhooks
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. Your Webhooks

paymentEvent webhook

POST
https://crmapi.jawartaibah.com/api/webhook/fikafi/payment

📡 Payment Event Webhook#

This webhook notifies your system whenever a payment-related update occurs for a booking. It helps you stay in sync with real-time status changes — such as payment completion, partial payments, cancellations, or declines — without needing to poll the API.
The payload contains the latest payment status and a full breakdown of payments received against a booking.

🛠 What You Need to Do#

Expose an endpoint in your system to receive POST requests from Fikäfi.
Verify the signature (if enabled) to ensure the request is from a trusted source.
Parse the payload and update your records accordingly.
Respond with HTTP 200 OK within 5 seconds to acknowledge receipt.

🔐 Webhook Headers#

Header NameTypeRequiredDescription
Content-Typestring✅ YesMust be application/json
X-Signaturestring✅ YesHMAC signature for verifying payload authenticity (if security is enabled)

Request

Header Params

Body Params application/json

Examples

Responses

🟢200OK
Webhook received
This response does not have a body.
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://crmapi.jawartaibah.com/api/webhook/fikafi/payment' \
--header 'x-api-secret: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiIzMmVkOTI0OC1kNTc4LTQ3NzUtODYwYS1iZGZkOGExM2Y0MzciLCJ1bmlxdWVfbmFtZSI6IkFkbWluIiwiVXNlcklEIjoiMSIsIm5iZiI6MTc0MDM5Mzg4NywiZXhwIjoxNzQwNDgwMjg3LCJpYXQiOjE3NDAzOTM4ODd9.J6oPTYH9x5ia_a7OUBj9K038o8gu04gL4kLuVyJ8RQo' \
--header 'Content-Type: application/json' \
--data-raw '{
    "bookingRefNum": "string",
    "fikafiRefNum": "string",
    "payment": {
        "status": "string",
        "isCardCaptured": true,
        "currency": "string",
        "amount": 0,
        "paidAt": "2019-08-24T14:15:22.123Z"
    }
}'
Modified at 2025-09-05 10:17:04
Previous
getPayments API
Next
paymentDetails Webhook
Built with