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

paymentDetails Webhook

POST
http://sandbox.fikafi.com/FikafiApi/api/payment/paymentDetails

📡 Payment Details Webhook#

This webhook provides your system with the full and latest payment details for a booking whenever a relevant update occurs. Unlike the paymentEvent webhook — which focuses on status changes — this webhook delivers a complete snapshot of all payment records, amounts, and breakdowns tied to the booking.
It ensures your internal systems always have the most up-to-date and detailed view of payment activity.
This webhook is optional — you can rely solely on the paymentEvent webhook in combination with the getPaymentStatus API if preferred.

🛠 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 internal payment 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 'http://sandbox.fikafi.com/FikafiApi/api/payment/paymentDetails' \
--header 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiIzMmVkOTI0OC1kNTc4LTQ3NzUtODYwYS1iZGZkOGExM2Y0MzciLCJ1bmlxdWVfbmFtZSI6IkFkbWluIiwiVXNlcklEIjoiMSIsIm5iZiI6MTc0MDM5Mzg4NywiZXhwIjoxNzQwNDgwMjg3LCJpYXQiOjE3NDAzOTM4ODd9.J6oPTYH9x5ia_a7OUBj9K038o8gu04gL4kLuVyJ8RQo' \
--header 'Content-Type: application/json' \
--data-raw '{
    "bookingRefNum": "BKG20250401",
    "fikafiRefNum": "FIK987654",
    "paymentStatus": {
        "status": "Completed",
        "isCardCaptured": true,
        "currency": "USD",
        "totalAmountReq": 1000,
        "totalAmountPaid": 1000,
        "numOfPaymentsReq": 2,
        "numOfPaymentsPaid": 2
    },
    "payments": [
        {
            "paymentNumber": 1,
            "amount": 500,
            "date": "2025-04-01",
            "status": "Paid",
            "paidAt": "2025-04-01T10:00:00Z"
        },
        {
            "paymentNumber": 2,
            "amount": 500,
            "date": "2025-04-15",
            "status": "Paid",
            "paidAt": "2025-04-15T11:30:00Z"
        }
    ]
}'
Modified at 2025-06-18 07:22:15
Previous
paymentEvent webhook
Next
Request Payments
Built with