Events

List of Comfi events

This is a list of all the types of events we currently send. We may add more at any time, so in developing and maintaining your code, you should not assume that only these types exist.

Event types

Event	Meaning
deal.created	Occurs whenever a new deal is created
deal.updated	Occurs whenever a deal is updated
deal.approved	Occurs whenever a deal is approved by Comfi and is ready for a fullfilment
deal.delivered	Occurs whenever a deal is fulfillment (status has changed to delivered)

Body sample

{
  "id": "string",
  "type": "event.type",
  "data": {
    "billingDate": "2024-04-17",
    "collections": [
      {
        "due_date": "2024-04-17",
        "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "status": "COLLECTED"
      }
    ],
    "created_at": "2024-04-17",
    "created_by": {
      "email": "string",
      "first_name": "string",
      "id": "string",
      "last_name": "string"
    },
    "currency": "string",
    "customer_info": {
      "address": "string",
      "beneficiary": "string",
      "city": "string",
      "contact_email": "string",
      "contact_phone": "string",
      "country": "AE",
      "customer_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "iban": "string",
      "legal_name_ar": "string",
      "legal_name_en": "string",
      "license_expiry_date": "2024-04-17",
      "license_issue_date": "2024-04-17",
      "license_number": "string",
      "name": "string",
      "website": "string"
    },
    "ddas": [
      {
        "createdAt": "2024-04-17",
        "fab_dda_unique_reference_number": "string",
        "fab_unique_reference_number": "string",
        "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "rejection_reason": "string",
        "status": "APPROVAL_PENDING"
      }
    ],
    "due_at": "2024-04-17",
    "expiry_date": "2024-04-17",
    "failure_url": "string",
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "invoice_number": "string",
    "invoice_url": "string",
    "merchant_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "merchant_logo": "string",
    "merchant_name": "string",
    "meta": {
      "additional_prop_1": "string",
      "additional_prop_2": "string",
      "additional_prop_3": "string"
    },
    "paymentPlans": [
      {
        "commission": {
          "country": {
            "country_name": "AE",
            "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
          },
          "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
          "percent": 0,
          "platform_fee": 0,
          "type": "BANK_ACCOUNT"
        },
        "days": 0,
        "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
      }
    ],
    "products": [
      {
        "count": 0,
        "image_url": "string",
        "name": "string",
        "price": 0,
        "tax_rate_percentage": 0
      }
    ],
    "selected_payment_plan": {
      "commission": {
        "country": {
          "country_name": "AE",
          "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
        },
        "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "percent": 0,
        "platform_fee": 0,
        "type": "BANK_ACCOUNT"
      },
      "days": 0,
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
    },
    "status": "APPROVAL_PENDING",
    "success_url": "string",
    "tax_amount": 0,
    "total_amount": 0,
    "updated_at": "2024-04-17",
    "url": "string"
  }
}