Skip to main content

Class AddNotificationSettingsRequest

An Add Notification Settings request is used to enable email notifications for specified location.

Properties

Field/Tag NameValue(s)RequiredNotes
custServProviderIdYPartner Id
entity_idYMerchant Id
request_emailYregistered at ProfitStars; email format
location_idYAlphanumeric; Unique ID
to_addressYMultiple email addresses separated by commas; do not include spaces.
notification_typeACH Credit_Card Money_Center ACH_Recurring Remote_Deposit ACH_Returns Check21_ReturnsY
notification_subtypeNone Rejected Sent_To_Transaction_Processing Needs_Rescan Processed_With_Adjustment Duplicate_Items_In_Batch Rejected_Items_In_Batch Remote_Deposit_AllY*Required only when notification_type is set to Remote_Deposit Should be set to ‘None’ for all other options.
subjectNtext(255)
descriptionNtext (long)
case_reasonApplication Special Circumstances, Update Bank Account Information, Update Business Information,N

Example AddNotificationSettingsRequest

Input Method: XML

<xml>
<custServProviderId>######</custServProviderId>
<entity_id>######</entity_id>
<request_email>none@example.com</request_email>
<location_id>#######</location_id>
<to_address>none1@example.com,none2@example.com</to_address>
<notification_type>ACH_Returns</notification_type>
<notification_subtype>None</notification_subtype>
<subject></subject>
<description></description>
<case_reason></case_reason>
</xml>