API Reference

TestWebhook

This endpoint will help you test your Webhook implementation with all the events. You have to pass the event you want to receive webhook for in the body request to receive an exemple of data Fyatu will be sending you when the event occurs.

Use the data model to process data from your end. Below are list of expected payloads for all events:

Exemple Webhook Payload

{
  "event": "card.transaction",
  "version": "2.0",
  "sign": "bc7453be41fb1764eeb08a1ecbd4f98412f183594261a752579a15a4d8570b62",
  "data": {
    "cardId": "c3febacb3ebd756821909d7c1f933356cc95b6b3bdc27823bb1296d924d45100",
    "transactionId": "65251467-2321-a73b-b809-1af1512a4d20",
    "transactionType": "reversal",
    "merchantName": "QTRAR *F4D5S6A7J8",
    "merchantCountry": "QA",
    "amount": "66.48",
    "currency": "USD",
    "description": "Transaction reversed successfully",
    "date": "2025-04-01T23:10:29Z"
  }
}
{
  "event": "card.unloaded",
  "version": "2.0",
  "sign": "e3169907d1ca53f072caf67c265eb979fd3da4804d8c6c7cc5196b6620c3b8cc",
  "data": {
    "cardId": "68e389cb95d180d9b7f10500a98389aa0998f928845f00951d7ad589113a7316",
    "amount": "141.51",
    "fees": 0.70755,
    "status": "processed",
    "message": "Card Unloaded Successful"
  }
}
{
  "event": "card.terminated",
  "version": "2.0",
  "sign": "38bcadbd51f7f7d0636824e56f9e0aeb82bf6effee08c3609053aced89d2a5d6",
  "data": {
    "cardId": "27c80d5709f392204a370befe120b646017a619bc96e547a6a56bb3990f2c21e",
    "amount": "31.83",
    "fees": 0,
    "status": "processed",
    "message": "Card Terminated Successful"
  }
}
{
  "event": "card.maintenance",
  "version": "2.0",
  "sign": "6630e537b9f9c5966bfa6da2bab18784736e8cfc7ed438dfb1025b928a856b7d",
  "data": {
    "cardId": "8759c7fdcc59dd669d320639a955ff0115117098ab5a17e6a258e0926d407aa0",
    "status": "processed",
    "message": "Monthly card maintenance debited"
  }
}

📘

Best Practice

When you receive a Webhook, it's important to return a 200 OK status code so that Fyatu will not retry again to send the same payload.

Language
Credentials
OAuth2
Authenticate
Click Try It! to start a request and see the response here!