Home

๐Ÿ“˜

Metadata field

Some activity event types will also come with metadata provide further information about the event

Event typeDescriptionMetadata
PaymentPlanStarted
PaymentPlanCancelled- 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
PaymentPlanPaymentRetry
PaymentPlanPaymentFailed
PaymentPlanPaymentSuccess
PaymentPlanComplete- 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
PaymentPlanViewed
PayNowViewed
RequestCallBackSent
AdhocPaymentMade- 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- 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- 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.
MessageQueuedThis means the message is processed on our end
MessageDelivered
MessageFailed
MessageOpened
MessageClicked
MessageSpamReport
MessageScheduled
InvoiceCreated
InvoiceFullyPaid
InvoiceVoided
ContactDisabled
TransactionCreated
InstantPaymentFailed
FeedbackReceived
InvoiceUnvoided
AgentPaymentLinkViewed
InvoiceChallengeSuccess
InvoiceChallengeFailed
PaymentPortalVisited
WebsiteInvoiceAccess
PaymentPortalRated
PaymentPortalNpsCollected - NPS - the NPS score selected by the user. This value is from 0 to 10

- Comment - an optional comment entered by the user
PaymentPortalDisputeRequested
PaymentPortalOfferMade
PaymentPortalAddContactInfo
FinancialHardshipFormDownloaded
InvoiceAttachmentViewedCustomer downloaded invoice attachment
InvoiceAttachmentChallengeSuccessCustomer successfully passed invoice attachment verification screen
InvoiceAttachmentChallengeFailedCustomer failed to pass invoice attachment verification screen
InvoiceAttachmentChallengePageViewedCustomer viewed attachment verification screen
HelpArticlesPageViewed
HelpArticlesHaveNotHelpedClicked
BPayViewed
VerificationPageViewed
HardshipRequestCallBackSent
CampaignCommsPaused
CampaignCommsResumed
PaymentPlanPaused- 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- 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- 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
InvoiceAttachmentUploadedThe attachment for invoice presentment is uploaded to CreditClear
BlockedDueToNoAttachmentThe 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

๐Ÿšง

Insurance integration

These activity events are only related to Insurance integration

Event typeDescription
VersionDiagramFormDownloadedLiability Dispute Form Downloaded event
ClaimPortalVisited
PersonalDetailsStepViewed
PersonalDetailsStepSubmitted
IsInsuredStepViewed
IsInsuredStepSubmitted
InsurerNameStepViewed
InsurerNameStepSubmitted
IsClaimLodgedStepViewed
IsClaimLodgedStepSubmitted
ClaimNumberStepViewed
ClaimNumberStepSubmitted
NotLodgedClaimReasonStepViewed
NotLodgedClaimReasonStepSubmitted
AcceptClaimLiabilityStepViewed
AcceptClaimLiabilityStepSubmitted
ClaimCompletedStepViewed
ClaimCompleted
AcceptedLiability
DisputedLiability
UpdateContactInfoRequestReceived
SupportPhoneNumberClicked