Metadata field
Some activity event types also comes with metadata to provide further information about the event
| Event type | Description | Metadata |
|---|---|---|
| PaymentPlanStarted | Payment arrangement started | |
| PaymentPlanCancelled | Payment arrangement cancelled | - CancelledDate - The time the payment plan cancelled in ISO 8601 format e.g. 2021-11-03T12:58:07.9850068Z - PaymentFrequency - The frequency of the payment, possible values: Weekly, Fortnightly, Monthly, Daily - RecurringAmount - The amount for each instalment e.g. 59.0 |
| PaymentPlanPaymentDue | Payment arrangement payment due | |
| PaymentPlanPaymentRetry | Payment arrangement payment retry | |
| PaymentPlanPaymentSuccess | Payment arrangement payment successful | |
| PaymentPlanComplete | Payment arrangement completed | - EndDate - The time the payment plan completed in ISO 8601 format e.g. 2021-11-03T12:41:48.7669804Z - RecurringPaymentId - Unique identifier of the payment plan e.g. 066c92a8-438c-475f-979c-ce4bf592e0b8 |
| RequestCallBackViewed | Request callback viewed | |
| PaymentPlanViewed | Payment arrangement viewed | |
| PayNowViewed | Payment now viewed | |
| RequestCallBackSent | Request call back sent | |
| AdhocPaymentMade | Customer made adhoc payment | - TransactionId - Transaction ID of the payment - Amount - The amount paid e.g. 1235.0 - PaymentType - The type of payment of this transaction e.g. FatZebraCreditCard - IsAdhocPayment - True when the payment is a adhoc payment |
| PaymentFailed | Payment failed | - TransactionId - Transaction ID of the payment - Amount - The amount paid e.g. 1245.0 - PaymentType - The type of payment of this transaction e.g. FatZebraCreditCard - TransactionCorrelationId - Unique Identifier of the transaction e.g. 08644c2b-aac2-4ddd-9274-0476175eb6ac - ProcessedOnUtc - The time the payment is processed in ISO 8601 format e.g. 2021-11-03T11:26:16.4307546Z - IsAdhocPayment - False when the payment is a payment plan instalment and True when the payment is an adhoc payment - AdhocPaymentFailedSinceLastSuccess - Count of failed adhoc payments since the last (if any) successful one, including payment retry as each retry is treated as a new transaction - NonAdhocPaymentFailedSinceLastSuccess - Count of failed non-adhoc payments since the last (if any) successful one, including payment retry as each retry is treated as a new transaction - RetryCount - Count of retry attempts to process the payment |
| PaymentSuccess | Payment successful | - TransactionId - Transaction ID of the payment - Amount - The amount paid e.g. 45.0 - PaymentType - The type of payment of this transaction e.g. FatZebraCreditCard - TransactionCorrelationId - Unique Identifier of the transaction e.g. 08644c2b-aac2-4ddd-9274-0476175eb6ac - PaidOnUtc - The time the payment is paid in ISO 8601 format e.g. 2021-11-03T11:26:16.4307546Z - IsAdhocPayment - False when the payment is a payment plan instalment and True when the payment is an adhoc payment - TotalDiscountAmountToDate - The total invoice discount amount applied to date. If more than one discount has been applied to the invoice then this would be a sum of those. |
| PaymentReceiptSent | Payment receipt sent to custoemr | |
| PartialPaymentMade | Customer made partual payment | |
| PaidInvoiceReopened | Paid invoice reopened | |
| MessageQueued | Message processed on our end | |
| MessageDelivered | Received the confirmation of message delivery to customer | |
| MessageFailed | Message failed to deliver to customer | |
| MessageOpened | Message opened by customer | |
| MessageClicked | Message clicked by customer | |
| MessageSpamReport | Message reported as spam by customer | |
| MessageScheduled | Message scheduled | |
| InvoiceCreated | Invoice created | |
| InvoiceFullyPaid | Invoice fully paid | |
| InvoiceVoided | Invoice voided | |
| ContactDisabled | Contact disabled | |
| TransactionCreated | Transaction created | |
| FeedbackReceived | Feedback received | |
| InvoiceUnvoided | Invoice unvoided | |
| AgentPaymentLinkViewed | Agent viewed the payment link | |
| InvoiceChallengeSuccess | Customer successfully clear invoice challenge | |
| InvoiceChallengeFailed | Customer failed invoice | |
| PaymentPortalVisited | Customer visited payment portal | |
| WebsiteInvoiceAccess | Portal is accessed by customer through invoice search screen or landing page | |
| NpsQuestionAsked | NPS question asked to customer | |
| PaymentPortalRated | Payment portal rated | |
| PaymentPortalNpsCollected | NPS collected | - NPS - the NPS score selected by the user. This value is from 0 to 10 - Comment - an optional comment entered by the user |
| PaymentPortalDisputeRequested | Customer raises dispute | |
| PaymentPortalOfferMade | Customer makes an offer | |
| FinancialHardshipPageViewed | Customer viewed the financial hardship page | |
| FinancialHardshipFormDownloaded | Customer downloaded financial hardship form | |
| InvoiceAttachmentViewed | Customer downloaded invoice attachment | |
| InvoiceAttachmentChallengeSuccess | Customer successfully passed invoice attachment verification screen | |
| InvoiceAttachmentChallengeFailed | Customer failed to pass invoice attachment verification screen | |
| InvoiceAttachmentChallengePageViewed | Customer viewed attachment verification screen | |
| HelpArticlesPageViewed | Customer viewed help article page | |
| HelpArticlesHaveNotHelpedClicked | Customer clicked help article did not help | |
| BPayViewed | BPay viewed | |
| VerificationPageViewed | Verification page viewed | |
| HardshipRequestCallBackSent | Hardship request callback sent | |
| CampaignCommsPaused | Campaign communication paused | |
| CampaignCommsResumed | Campaign communication resumed | |
| PaymentPlanPaused | Payment arrangement pause | - RecurringPaymentId - Unique identifier of the payment plan e.g. 066c92a8-438c-475f-979c-ce4bf592e0b8 - OccurredAtUtc - The time the payment plan is paused in ISO 8601 format e.g. 2021-11-03T12:44:41.1420683Z |
| PaymentPlanResumed | Payment arrangement resumed | - RecurringPaymentId - Unique identifier of the payment plan e.g. 066c92a8-438c-475f-979c-ce4bf592e0b8 - OccurredAtUtc - The time the payment plan is resumed in ISO 8601 format e.g. 2021-11-03T12:52:55.1904722Z |
| PaymentPlanScheduled | Payment arrangement scheduled | - StartDate - Time scheduled to start in ISO 8601 format e.g. 2021-11-05T00:00:00.000000Z - RecurringPaymentId - Unique identifier of the payment plan e.g. 066c92a8-438c-475f-979c-ce4bf592e0b8 - PaymentFrequency - The frequency of the payment, possible values: Weekly, Fortnightly, Monthly, Daily - RecurringAmount - The amount for each instalment e.g. 100.0 |
| InvoiceAttachmentUploaded | The attachment for invoice presentment is uploaded to CreditClear | |
| BlockedDueToNoAttachment | The customer got onto the payment portal but the attachment for invoice presentment is not available in CreditClear. This only happens when configured to decline access when no document is available | |
| PaymentPlanAmountFrequencyUpdated | Customer updated payment arrangement amount or frequency | |
| PaymentPlanNextInstalmentSkipped | Customer skipped next instalment | |
| PaymentInstrumentAdded | Customer added a new payment instrument such as credit card | |
| PaymentInstrumentRemoved | Customer removed a payment instrument | |
| DefaultPaymentInstrumentChanged | Customer updated the default payment instrument used for installment charges |
Insurance integration
These activity events are
onlyrelated to Insurance integration
| Event type | Description |
|---|---|
| VersionDiagramFormDownloaded | Customer downloaded version diagram aka liability dispute form |
| ClaimPortalVisited | Customer visted claim portal |
| PersonalDetailsStepViewed | Customer viewed personal details step |
| PersonalDetailsStepSubmitted | Customer submitted personal details step |
| IsInsuredStepViewed | Customer viewed is insured step |
| IsInsuredStepSubmitted | Customer submitted is insured step |
| InsurerNameStepViewed | Customer viewed is insurer name step |
| InsurerNameStepSubmitted | Customer submitted is insurer name step |
| IsClaimLodgedStepViewed | Customer viewed is claim lodged step |
| IsClaimLodgedStepSubmitted | Customer submitted is claim lodged step |
| ClaimNumberStepViewed | Customer viewed claim number step |
| ClaimNumberStepSubmitted | Customer submitted claim number step |
| NotLodgedClaimReasonStepViewed | Customer viewed not lodged claim reason step |
| NotLodgedClaimReasonStepSubmitted | Customer viewed not lodged claim reason step |
| AcceptClaimLiabilityStepViewed | Customer viewed accept claim liability step |
| AcceptClaimLiabilityStepSubmitted | Customer submitted accept claim liability step |
| ClaimCompletedStepViewed | Customer viewed completed step |
| ClaimCompleted | Customer completed claim |
| AcceptedLiability | Custoemer accepted liability |
| DisputedLiability | Customer viewed not lodged claim reason step |
| UpdateContactInfoRequestReceived | Request to update contact infor received from customer |
| SupportPhoneNumberClicked | Customer clicked support phone number |