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

takePaymentAction API

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

🔁 Take Payment Action#

This endpoint allows hotels to cancel a payment link or resend it to the guest, using either the hotel’s booking reference or the Fikäfi transaction reference.
Fikäfi processes the requested action and responds with the updated payment status.

🔐 Required Headers#

Include the following headers in your request:
Header NameTypeRequiredDescription
Authorizationstring✅ YesBearer token for API access
Content-Typestring✅ YesMust be application/json

📤 Request Format#

Make a POST request to perform an action (such as cancel or resend) on an existing payment link. The request should include either the bookingReference or fikafiReference, along with the desired action.

🧪 Mock Testing#

You can test this endpoint without any backend integration by using our mock server.
Mock URL:
http://sandbox.fikafi.com/FikafiApi

Request

Query Params

Header Params

Body Params application/json

Examples

Responses

🟢200OK
application/json
Action taken
Body

🟠400Invalid input
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST 'http://sandbox.fikafi.com/FikafiApi/api/payment/takePaymentAction?bookingRefNum=BKG123&fikafiRefNum=FIK7890&action=cancel' \
--header 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiIzMmVkOTI0OC1kNTc4LTQ3NzUtODYwYS1iZGZkOGExM2Y0MzciLCJ1bmlxdWVfbmFtZSI6IkFkbWluIiwiVXNlcklEIjoiMSIsIm5iZiI6MTc0MDM5Mzg4NywiZXhwIjoxNzQwNDgwMjg3LCJpYXQiOjE3NDAzOTM4ODd9.J6oPTYH9x5ia_a7OUBj9K038o8gu04gL4kLuVyJ8RQo' \
--header 'Content-Type: application/json' \
--data-raw '{}'
Response Response Example
200 - Success Response
{
    "bookingRefNum": "BKG123",
    "fikafiRefNum": "FIK7890",
    "action": "cancelled"
}
Modified at 2025-06-18 07:21:14
Previous
createPayment API
Next
createOnlinePayment API
Built with