Skip to main content

Add Payment Info Using Link

The ADD_PAYMENT_INFO_USING_LINK event is triggered patient added their payment info via payment setup link.

Attributes​

eventstring
The name of the event that was triggered. For this webhook, the value will always be ADD_PAYMENT_INFO_USING_LINK.
payloadobject
Contains all the data associated with the payment information addition event.
Show child attributes
caseIdstring<UUID>
The unique identifier of the case associated with the payment information update.
paymentInfoobject
Details about the payment method and associated addresses that were added.
Show child attributes
maskedCardNumberstring
The masked card number, typically showing only the last 4 digits for security.
cardBrandstring
The brand of the card that was used.
shippingAddressobject
The shipping address associated with this payment method.
Show child attributes
addressLine1string
The primary address line, such as street address and number.
addressLine2string
An optional secondary address line, such as apartment or suite number.
citystring
The city for the shipping address.
statestring
The state, province, or region for the shipping address.
countrystring
The two‑letter ISO country code for the shipping address, for example `US`.
postalCodestring
The postal or ZIP code for the shipping address.
billingAddressobject
The billing address associated with this payment method.
Show child attributes
addressLine1string
The primary address line, such as street address and number.
addressLine2string
An optional secondary address line, such as apartment or suite number.
citystring
The city for the billing address.
statestring
The state, province, or region for the billing address.
countrystring
The two‑letter ISO country code for the billing address, for example `US`.
postalCodestring
The postal or ZIP code for the billing address.
activityobject
An object that describes the specific action that triggered this webhook.
Show child attributes
idstring<UUID>
The unique identifier for this activity log entry.
typestring
Allowed values:CREATE_CASE,CHANGE_CASE_STATUS,ADD_CASE_COMMENT,DELETE_CASE_COMMENT,ADD_CASE_DECISION,ARCHIVE_CASE,ESCALATE_CASE,DEESCALATE_CASE,ADD_CASE_ESCALATION,REMOVE_CASE_ESCALATION,UPDATE_CASE_ESCALATION,DECISION_DELETED,ADD_CASE_ATTACHMENT,ADD_CASE_ASSIGNEE,REMOVE_CASE_ASSIGNEE,IMPORT_CASE,ADD_FORM_RESPONSE,UPDATE_FORM_RESPONSE,ADD_HR_REP,REMOVE_HR_REP,DELETE_ATTACHMENT,FOLLOWUP_EMAIL,PAYMENT_ADDED,PAYMENT_COMPLETED,PAYMENT_DELETED,PAYMENT_UPDATED,ORDER_CREATED,TEXT_INFO,REOPEN_CASE,SMS_SENT,SMS_RECEIVED,INBOUND_EMAIL,OUTBOUND_EMAIL,FOLLOWUP_FORM,ORDER_STATUS_CHANGED,ORDER_TRACKING_ADDED,PAYMENT_INFO_LINK_SENT,ADD_PAYMENT_INFO_USING_LINK,CALENDAR_EVENT_CREATED,CALENDAR_EVENT_RESCHEDULED,CALENDAR_EVENT_CANCELED,CALENDAR_EVENT_NO_SHOW,CALENDAR_EVENT_NO_SHOW_REMOVED,SUPPORT_NOTE_ADDED,SUPPORT_NOTE_UPDATED,SUPPORT_NOTE_COMPLETED,COMMENT_ACKNOWLEDGED,NOTE_ACKNOWLEDGED,VISIT_TYPE_CHANGED,PAYMENT_PREAUTHORIZED,SUBSCRIPTION_ADDED,SUBSCRIPTION_ACTIVATED,SUBSCRIPTION_COMPLETED,SUBSCRIPTION_PAUSED,SUBSCRIPTION_RESUMED,SUBSCRIPTION_CANCELLED,SUBSCRIPTION_UPDATED
The type of activity.
isPHIboolean
Indicates if the activity contains Protected Health Information (PHI).
isRestrictedboolean
Indicates if the activity details are restricted to internal users due to sensitivity (for example, payment data).
valueBeforestring | null
The previous value before this activity, if any. For this event, usually `null`.
valueAfterstring | null
A short description of the result of the activity, such as `payment info has been added`.
timestampstring<date-time>
The exact timestamp when the activity occurred.
actorobject
The user who performed the action (i.e., who added the new assignee).
Show child attributes
idstring<UUID>
The ID of the actor.
firstNamestring
The first name of the actor.
lastNamestring
The last name of the actor.
emailstring
The email of the actor.
targetUserobject
The user who was the target of the action (i.e., the user who was assigned).
Show child attributes
idstring<UUID>
The ID of the assigned user.
firstNamestring
The first name of the assigned user.
lastNamestring
The last name of the assigned user.
emailstring
The email of the assigned user.

Response​

{
  "event": "ADD_PAYMENT_INFO_USING_LINK",
  "payload": {
    "caseId": "c747fe81-6b49-4d4e-9a87-81cb0ee026fd",
    "paymentInfo": {
      "maskedCardNumber": "4242",
      "cardBrand": "visa",
      "shippingAddress": {
        "addressLine1": "1600 Pennsylvania Avenue NW",
        "addressLine2": "",
        "city": "Washington",
        "state": "DC",
        "country": "US",
        "postalCode": "20500"
      },
      "billingAddress": {
        "addressLine1": "1600 Pennsylvania Avenue NW",
        "addressLine2": "",
        "city": "Washington",
        "state": "DC",
        "country": "US",
        "postalCode": "20500"
      }
    },
    "activity": {
      "id": "41c1eedd-67bb-4650-92b7-650248874c5e",
      "type": "ADD_PAYMENT_INFO_USING_LINK",
      "isPHI": false,
      "isRestricted": true,
      "timestamp": "2025-12-19T03:43:07.100Z",
      "valueBefore": null,
      "valueAfter": "payment info has been added",
      "actor": {
        "id": "a9a2bJ9VcoVEPGgK9REMkjKIbl33",
        "firstName": "Ritik",
        "lastName": "Parikh",
        "email": "ritik.parikh+02testmulti@carevalidate.com"
      },
      "targetUser": {
        "id": "a9a2bJ9VcoVEPGgK9REMkjKIbl33",
        "firstName": "Ritik",
        "lastName": "Parikh",
        "email": "ritik.parikh+02testmulti@carevalidate.com"
      }
    }
  }
}