Notification - eventAsk AIpost http://localhost:8080/api/hay/v0/communications/notificationThis endpoint will receive the main notification stream for the platform events.Body ParamscustomerHayIduuidrequiredUnique identifier (UUID) of the customer associated with the notificationidempotencyKeyuuidrequiredIdempotency key (UUID) to uniquely represent this request and prevent duplication.typestringenumrequiredThe type of the notification event - one of: ACCOUNT_STATUS_CHANGE: The status of an account has changed APPLE_PAY_REWARD_FOR_CUSTOMER: Apple Pay reward reminder CARD_ADDED_TO_WALLET: Card has been added to a device wallet CARD_STATUS_CHANGE: The status of a card has changed CUSTOMER_DETAILS_CHANGE: Customer's personal details have been updated CUSTOMER_STATUS_UPDATED: Customer's status has been updated ONBOARDING_PASSED: Customer onboarding completed successfully ONBOARDING_FAILED: Customer onboarding failed REMINDER: A reminder SCHEDULED_PAYMENT: Scheduled payment creation notification TRANSACTION: Transaction notification DIRECT_ENTRY: Direct Entry notification MANDATE: Mandate notification MANDATE_DUE_PAYMENT: Mandate due payment notification MANDATE_PAYMENT: Mandate payment notification MANDATE_ACTION_EXPIRATION: Mandate action expiration notification DELEGATED_OTP_NOTIFICATION: Delegated OTP notification for 3DS authentication ACCOUNT_STATUS_CHANGECUSTOMER_STATUS_UPDATEDCARD_ADDED_TO_WALLETCARD_STATUS_CHANGECUSTOMER_DETAILS_CHANGEONBOARDING_PASSEDONBOARDING_FAILEDREMINDERSCHEDULED_PAYMENTTRANSACTIONDIRECT_ENTRYMANDATEMANDATE_DUE_PAYMENTMANDATE_PAYMENTAPPLE_PAY_REWARD_FOR_CUSTOMERMANDATE_ACTION_EXPIRATIONDELEGATED_OTP_NOTIFICATIONShow 17 enum valuesfirebaseDeviceTokenstringFirebase token of the customer's deviceactionOwnerstringenumThe party responsible for the triggering of an action resulting in a notification event. Possible values: CLIENT: Client executed an action which triggered the event. PLATFORM: Shaype executed an action which triggered the event. CLIENTPLATFORMAllowed:CLIENTPLATFORMcardHayIduuidUnique identifier (UUID) of the Card associated with the eventproductIduuidUnique identifier (UUID) of the Product of the account associated with the eventaccountStatusChangeEventobjectDetails of the Account Status Change event; provided when the type is ACCOUNT_STATUS_CHANGE.accountStatusChangeEvent objectcustomerStatusUpdatedEventobjectDetails of the Customer Status Updated event; provided when the type is CUSTOMER_STATUS_UPDATED.customerStatusUpdatedEvent objecttransactionEventobjectDetails of the Transaction event; provided when the type is TRANSACTION.transactionEvent objectcardStatusChangeEventobjectDetails of the Card Status Change event; provided when the type is CARD_STATUS_CHANGE.cardStatusChangeEvent objectcustomerDetailsChangeEventobjectDetails of the Customer Details Change event; provided when the type is CUSTOMER_DETAILS_CHANGE.customerDetailsChangeEvent objectcardAdditionToWalletEventobjectDetails of the Card Added to Wallet event; provided when the type is CARD_ADDED_TO_WALLET.cardAdditionToWalletEvent objectreminderTypestringenumType of the Reminder event; provided when the type is REMINDER. Possible values: REMINDER_TO_COMPLETE_FUNDING REMINDER_TO_PROVISION_DIGITAL_CARD REMINDER_TO_TRANSACT APPLE_PAY_REMINDER_24_HRS APPLE_PAY_REMINDER_7_DAYS APPLE_PAY_SPEND_REMINDER_7_DAYS APPLE_PAY_SPEND_REMINDER_14_DAYS APPLE_PAY_ADD_TO_WALLET_REMINDER_30_DAYS APPLE_PAY_ADD_TO_WALLET_REMINDER_60_DAYS APPLE_PAY_ADD_TO_WALLET_REMINDER_90_DAYS GOOGLE_PAY_24_HRS_PARTIAL_PROVISIONING GOOGLE_PAY_7_DAYS_PARTIAL_PROVISIONING GOOGLE_PAY_7_DAYS_SPEND_REMINDER GOOGLE_PAY_14_DAYS_SPEND_REMINDER CARD_EXPIRY_MONTH_REMINDER CARD_EXPIRY_2_WEEK_REMINDER CARD_EXPIRY_DAY_REMINDER REMINDER_TO_COMPLETE_FUNDINGREMINDER_TO_PROVISION_DIGITAL_CARDREMINDER_TO_TRANSACTAPPLE_PAY_REMINDER_24_HRSAPPLE_PAY_REMINDER_7_DAYSAPPLE_PAY_SPEND_REMINDER_7_DAYSAPPLE_PAY_SPEND_REMINDER_14_DAYSAPPLE_PAY_ADDITION_REWARDAPPLE_PAY_SPEND_REWARDAPPLE_PAY_ADD_TO_WALLET_REMINDER_30_DAYSAPPLE_PAY_ADD_TO_WALLET_REMINDER_60_DAYSAPPLE_PAY_ADD_TO_WALLET_REMINDER_90_DAYSGOOGLE_PAY_24_HRS_PARTIAL_PROVISIONINGGOOGLE_PAY_7_DAYS_PARTIAL_PROVISIONINGGOOGLE_PAY_7_DAYS_SPEND_REMINDERGOOGLE_PAY_14_DAYS_SPEND_REMINDERCARD_EXPIRY_MONTH_REMINDERCARD_EXPIRY_2_WEEK_REMINDERCARD_EXPIRY_DAY_REMINDERShow 19 enum valuesscheduledPaymentEventobjectDetails of the Scheduled Payment Created event; provided when the type is SCHEDULED_PAYMENT.scheduledPaymentEvent objectonboardingFailedEventobjectDetails of the Onboarding Failed event; provided when the type is ONBOARDING_FAILED.onboardingFailedEvent objectdirectEntryEventobjectDetails of the Direct Entry event; provided when the type is DIRECT_ENTRY.directEntryEvent objectmandateDuePaymentEventDtoobjectDetails of the Mandate Due Payment event; provided when the type is MANDATE_DUE_PAYMENT.mandateDuePaymentEventDto objectmandateEventDtoobjectDetails of the Mandate event; provided when the type is MANDATE.mandateEventDto objectmandatePaymentEventDtoobjectDetails of the Mandate Payment event; provided when the type is MANDATE_PAYMENT.mandatePaymentEventDto objectapplePayRewardForCustomerEventobjectDetails of the Apple Pay Reward For Customer event; provided when the type is APPLE_PAY_REWARD_FOR_CUSTOMER.applePayRewardForCustomerEvent objectcardExpiryReminderEventobjectDetails of the Card About To Expire event; provided when the type is REMINDER with one of the following reminder type values: CARD_EXPIRY_MONTH_REMINDER CARD_EXPIRY_2_WEEK_REMINDER CARD_EXPIRY_DAY_REMINDER cardExpiryReminderEvent objectmandateActionExpirationEventobjectDetails of the Mandate Action Expiration event; provided when the type is MANDATE_ACTION_EXPIRATION.mandateActionExpirationEvent objectdelegatedOtpNotificationEventobjectDetails of the Delegated OTP Notification event; provided when the type is DELEGATED_OTP_NOTIFICATION.delegatedOtpNotificationEvent objectResponses 200Success 403Unauthorised 422Invalid Input 500Internal errorUpdated 10 months ago
