Webhook event

`payment.paid`

A Payment was recorded as paid.

Payload schema

api_versionanyrequired
contextobject
Present only when source is api. Identifies the acting project and API key.
- developer_platform_api_key_idstring | null · uuid
- developer_platform_project_idstring | null · uuid
created_atstring · date-timerequired
An ISO 8601 timestamp in UTC, with a Z suffix. For example, 2026-07-01T09:00:00Z.
dataobjectrequired
- objectobjectrequired
  - amountintegerrequired
    The Payment amount in minor currency units.
  - created_atstring · date-timerequired
    An ISO 8601 timestamp in UTC, with a Z suffix. For example, 2026-07-01T09:00:00Z.
  - currencystring | nullrequired
    The ISO 4217 currency code.
  - idstring · uuidrequired
    The resource's unique identifier, formatted as an RFC 4122 version 4 UUID.
  - internal_notesstring | nullrequired
    Internal notes recorded with the Payment.
  - invoice_idstring | null · uuidrequired
    The Invoice this Payment is allocated to, when one is assigned.
  - linksobjectrequired
    URLs to related resources.
    - patientstring | null · urirequired
      The full URL of a related resource.
  - objectanyrequired
    Discriminator value emitted at object.
  - paid_atstring | null · date-timerequired
    An ISO 8601 timestamp in UTC, with a Z suffix. For example, 2026-07-01T09:00:00Z.
  - patient_idstring | null · uuidrequired
    The Patient associated with the Payment.
  - payment_method_typestring | nullrequired
    How the Payment was collected.
    Allowed values: bacs_debit | bank_transfer | card | card_external | cash | cheque | klarna | other | standing_order | null
  - payor_typestring | nullrequired
    The type of party who made the Payment.
    Allowed values: alternative_payor | insurance_company | location | patient | null
  - refundsarrayrequired
    Refunds issued against this Payment, if any. Ordered by created_at.
    - itemsobject
      - amountintegerrequired
        The refunded amount in minor currency units.
      - created_atstring · date-timerequired
        An ISO 8601 timestamp in UTC, with a Z suffix. For example, 2026-07-01T09:00:00Z.
      - currencystring | nullrequired
        The ISO 4217 currency code.
      - errorstring | nullrequired
        The failure message when the Refund did not complete.
      - idstring · uuidrequired
        The resource's unique identifier, formatted as an RFC 4122 version 4 UUID.
      - invoice_idstring | null · uuidrequired
        The Invoice associated with the refunded Payment, when one is assigned.
      - linksobjectrequired
        URLs to related resources.
        patientstring | null · urirequired
        The full URL of a related resource.
      - notesstring | nullrequired
        Internal notes recorded with the Refund.
      - objectanyrequired
        Discriminator value emitted at object.
      - patient_idstring | null · uuidrequired
        The Patient associated with the Refund.
      - payment_idstring | null · uuidrequired
        The Payment this Refund was issued against.
      - reasonstring | nullrequired
        The reason the Refund was issued.
        Allowed values: other | other_party_will_pay | overcharged | overpaid | service_not_delivered | null
      - refund_sourcestring | nullrequired
        How the Refund is paid.
        Allowed values: bank_account | deduction_from_balance | payment_account | null
      - statusstring | nullrequired
        The Refund's current status.
        Allowed values: canceled | failed | processing | requires_action | succeeded | null
      - succeeded_atstring | null · date-timerequired
        An ISO 8601 timestamp in UTC, with a Z suffix. For example, 2026-07-01T09:00:00Z.
      - updated_atstring · date-timerequired
        An ISO 8601 timestamp in UTC, with a Z suffix. For example, 2026-07-01T09:00:00Z.
  - statusstring | nullrequired
    The Payment's current status.
    Allowed values: awaiting_authentication | being_processed | canceled | failed | paid | partially_refunded | refunded | scheduled | unpaid | null
  - updated_atstring · date-timerequired
    An ISO 8601 timestamp in UTC, with a Z suffix. For example, 2026-07-01T09:00:00Z.
developer_platform_project_idstring | null · uuidrequired
The project ID whose credential caused the change. Null for dashboard events.
idstringrequired
Event identifier prefixed with evt_.
livemodebooleanrequired
false for test-event deliveries.
objectanyrequired
sourcestringrequired
Origin of the change. api means a Developer Platform mutation; dashboard means a Carebit-initiated change.
Allowed values: api | dashboard
typeanyrequired

Example

{
  "id": "evt_00000000-0000-4000-8000-000000000012",
  "object": "event",
  "api_version": "v1",
  "created_at": "2026-01-01T09:00:00Z",
  "data":  … }
    "object":  … }
      "id": "00000000-0000-4000-8000-000000000026",
      "object": "payment",
      "amount": 25000,
      "created_at": "2026-01-01T09:00:00Z",
      "currency": "gbp",
      "internal_notes": "Paid in full.",
      "invoice_id": "00000000-0000-4000-8000-000000000027",
      "links":  … }
        "patient": "https://api.carebit.co/v1/patients/00000000-0000-4000-8000-000000000004"
      },
      "paid_at": "2026-01-01T09:00:00Z",
      "patient_id": "00000000-0000-4000-8000-000000000004",
      "payment_method_type": "bank_transfer",
      "payor_type": "patient",
      "refunds": [],
      "status": "paid",
      "updated_at": "2026-01-01T09:00:00Z"
    }
  },
  "developer_platform_project_id": null,
  "livemode": false,
  "source": "dashboard",
  "type": "payment.paid"
}

Prefer plain text? Append ?format=md or send Accept: text/markdown to receive this page as raw Markdown.