Skip to main content
WEBHOOK
TRANSACTION_CLEARED
{
  "event":       "TRANSACTION_CLEARED",
  "eventId":     "evt_01HXY123456ABCDEF",
  "businessId":  "BUS1A2B3C4D5E6F",
  "environment": "LIVE",
  "timestamp":   "2026-05-22T12:00:00Z",
  "data": {
    "transactionId":        "txn_01HXYZ7777ABCDEF9999",
    "cardId":               "crd_01HXYZ5555ABCDEF1111",
    "programId":            "prg_01HXYZ9876ABCDEF0000",
    "cardholderId":         "chl_01HXYZ1234ABCDEF5678",
    "externalId":           "my-user-id-789",
    "type":                 "CLEARING",
    "status":               "SETTLED",
    "amountCents":          2999,
    "currency":             "USD",
    "billingAmountCents":   2999,
    "billingCurrency":      "USD",
    "exchangeRate":         null,
    "relatedTransactionId": "txn_01HXYZ8888ABCDEF9999",
    "merchant": {
      "name":           "Amazon",
      "id":             "AMZN_MERCHANT_001",
      "city":           "Seattle",
      "country":        "US",
      "mcc":            "5999",
      "mccDescription": "Miscellaneous General Merchandise"
    }
  }
}
{}

Documentation Index

Fetch the complete documentation index at: https://docs.fyatu.com/llms.txt

Use this file to discover all available pages before exploring further.

Fires when a previously authorized transaction is settled by the merchant. The charge is now permanent. The relatedTransactionId links back to the original TRANSACTION_AUTHORIZED event.

Event Type

TRANSACTION_CLEARED

Payload

{
  "event":       "TRANSACTION_CLEARED",
  "eventId":     "evt_01HXY123456ABCDEF",
  "businessId":  "BUS1A2B3C4D5E6F",
  "environment": "LIVE",
  "timestamp":   "2026-05-22T12:00:00Z",
  "data": {
    "transactionId":        "txn_01HXYZ7777ABCDEF9999",
    "cardId":               "crd_01HXYZ5555ABCDEF1111",
    "programId":            "prg_01HXYZ9876ABCDEF0000",
    "cardholderId":         "chl_01HXYZ1234ABCDEF5678",
    "externalId":           "my-user-id-789",
    "type":                 "CLEARING",
    "status":               "SETTLED",
    "amountCents":          2999,
    "currency":             "USD",
    "billingAmountCents":   2999,
    "billingCurrency":      "USD",
    "exchangeRate":         null,
    "relatedTransactionId": "txn_01HXYZ8888ABCDEF9999",
    "merchant": {
      "name":           "Amazon",
      "id":             "AMZN_MERCHANT_001",
      "city":           "Seattle",
      "country":        "US",
      "mcc":            "5999",
      "mccDescription": "Miscellaneous General Merchandise"
    }
  }
}

Payload Fields

FieldTypeDescription
transactionIdstringUnique transaction ID for this clearing event
relatedTransactionIdstringThe original TRANSACTION_AUTHORIZED transaction ID
typestringAlways CLEARING for this event
statusstringAlways SETTLED for this event
amountCentsintegerFinal settled amount in cents — may differ slightly from the authorization amount
All other fields are the same as TRANSACTION_AUTHORIZED. See Transaction Events for the full field reference.
{
  "event":       "TRANSACTION_CLEARED",
  "eventId":     "evt_01HXY123456ABCDEF",
  "businessId":  "BUS1A2B3C4D5E6F",
  "environment": "LIVE",
  "timestamp":   "2026-05-22T12:00:00Z",
  "data": {
    "transactionId":        "txn_01HXYZ7777ABCDEF9999",
    "cardId":               "crd_01HXYZ5555ABCDEF1111",
    "programId":            "prg_01HXYZ9876ABCDEF0000",
    "cardholderId":         "chl_01HXYZ1234ABCDEF5678",
    "externalId":           "my-user-id-789",
    "type":                 "CLEARING",
    "status":               "SETTLED",
    "amountCents":          2999,
    "currency":             "USD",
    "billingAmountCents":   2999,
    "billingCurrency":      "USD",
    "exchangeRate":         null,
    "relatedTransactionId": "txn_01HXYZ8888ABCDEF9999",
    "merchant": {
      "name":           "Amazon",
      "id":             "AMZN_MERCHANT_001",
      "city":           "Seattle",
      "country":        "US",
      "mcc":            "5999",
      "mccDescription": "Miscellaneous General Merchandise"
    }
  }
}
{}

Authorizations

Authorization
string
header
required

API key from the FYATU CaaS portal. Pass as Authorization: Bearer <key>.

Body

application/json
event
string
Example:

"TRANSACTION_CLEARED"

eventId
string
businessId
string
environment
enum<string>
Available options:
LIVE,
SANDBOX
timestamp
string<date-time>
data
object

Response

200

Acknowledge the event.