Send End User Emails
Certain notifications are required for integrating with Permissioned Clear Options. This page will help you implement the appropriate notifications and understand end user communication.
Note
All parameters referenced here are Notifications parameters unless otherwise stated.
Required
Implementing Required Notifications
Partners integrating our Clear solution with custom components must implement the following for each required Notification:
- Send an email (or equivalent notification) to end users.
- Obtain advance written approval from your WePay team of the content of each email (or equivalent notification).
- Archive each email (or equivalent notification) and keep an audit log, both of which must be provided to us within 7 days of our request. The logs must include, for each email (or equivalent notification):
- Date and time sent
- Recipient email address (or equivalent notification destination)
- Modify the content of emails (or equivalent notifications), and/or support additional emails (or equivalent notifications), within 30 days of our notification.
- Implement appropriate security measures, including DMARC, to protect end users against spear phishing attacks and the like. Read more about our security certification.
Required detals for Card Present integrations are indicated with an asterisk. Further context is provided in the relevant expanded notification details.
Scenario | Notification Event Topic(s) | Samples and Implementation |
---|---|---|
Complete onboarding |
| Click to expand for sample Notification payloads and sample email templates.
accounts.capabilities.updated Notification payload to inform onboarding reminders by inspecting the following JSON blocks:
Send reminders according to the following schedule (at minimum) until onboarding is complete:
|
Disabled Account Capabilities | accounts.capabilities.updated | Click to expand for sample Notification payloads and sample email templates.
false and previous value was true , then notify the merchant of the issue, how to resolve it, and applicable deadlines. Resolution can be inferred from the current_issues parameter in the Notification payload. Deadlines are outlined in Enable Merchants. If Payments are disabled, send reminders and guide merchants on how to re-enable Payments according to the following schedule (at minimum):
|
Invalidated Payout Method |
| Click to expand for sample Notification payloads and sample email templates.
payload.failure_reason.reason_code parameter and look for either of the following values:
accounts.capabilities.updated notification where the payload.payouts.current_issues.errant_fields parameter identifies a null payout method, then trigger this email flow. |
New Dispute* | disputes.created | Click to expand for sample Notification payloads and sample email templates.
|
Resolved Dispute* | disputes.resolved | Click to expand for sample Notification payloads and sample email templates.
|
Legal Entity details require an update | legal_entities.verifications.updated | Click to expand for sample Notification payloads and sample email templates.Inspect the all the following parameters and JSON blocks which are applicable to the Legal Entity and which are found in thepayload JSON block:
issue_type parameters have the in_review value and then update to errant_fields , WePay requires the information to be updated and resubmitted.Note the example in_review Notification JSON where additional_representatives are already null . This means that only the entity and controller details may need to be updated. The example errant_fields Notification JSON shows that the controller's details must be resubmitted and the entity's details are still in review. |
Supporting documentation is required for Legal Entity Verifications | legal_entities.verifications.updated | Click to expand for sample Notification payloads and sample email templates.
current_issues.issue_type in the following paths within the payload JSON block:
"issue_type": "identity_verification" is present, send the email to the merchant according to the following schedule (at minimum):
"issue_type": "risk_outreach" is present, send the email to the merchant.Learn more about the document outreach API. |
Payment receipt* | payments.completed | Click to expand for sample Notification payloads and sample email templates.Inspect the following applicable parameters and JSON blocks to inform the email variables:
|
Canceled Payment* | payments.canceled | Click to expand for sample Notification payloads and sample email templates.Inspect the following Notification parameters to inform the email:
*Note: The payer version of this email is not applicable if the transaction is Card Present and if the payer's email was not collected at the time of transaction. |
Failed Payment* | payments.failed | Click to expand for sample Notification payloads and sample email templates.
|
Failed Payout | payouts.failed | Click to expand for sample Notification payloads and sample email templates.
|
User management, security, and compliance | These emails are not strictly payments related, so there are no WePay API Notifications. That said, it is extremely important that your platform sends the following emails to all end users for cyber security, regulatory, and compliance reasons. | Sample emails: |
Recommended
Scenario | Notification Event Topic(s) | Samples and Implementation |
---|---|---|
Payment complete | payments.completed | Click to expand for sample Notification payloads and sample email templates.
|
Negative Account balance | accounts.negative_balance | Click to expand for sample Notification payloads and sample email templates. |
Account closed due to negative balance | accounts.capabilities.updated | Click to expand for sample Notification payloads and sample email templates. |
New Adjustment | adjustments.created | Click to expand for sample Notification payloads and sample email templates.
|
Updated Payout Method | accounts.updated | Click to expand for sample Notification payloads and sample email templates.When there is a delta between the currentpayout.currencies.X.payout_method_id value and the previous value, the Payment Method has been updated. |
Completed Legal Entity Verifications | legal_entities.verifications.updated | Click to expand for sample Notification payloads and sample email templates.When all parameters ending withis_verified return as true , this email can be sent. Please note that this does not mean WePay will never ask for additional verification details. You should also send this notification when submitted documents have been `verified` by WePay. |
Updated Legal Entity details |
| Click to expand for sample Notification payloads and sample email templates.
POST /legal_entities/{id}/verifications or POST /legal_entities/{id} request to the same Legal Entity, send this email to verify that the owner made these changes and to confirm that the changes were successful. |
Sent ACH Payment Method micro deposits | payment_methods.microdeposit_sent | Click to expand for sample Notification payloads and sample email templates.Inspect the following parameters and JSON blocks to inform the email:
|
ACH Payment Method micro deposit reminder | payment_methods.microdeposit_reminder | Click to expand for sample email template.This API notification can be used to automate 2 reminders within a 30 day period. |
ACH Payment Method micro deposits failed | payment_methods.microdeposit_verification_failed | Click to expand for sample email template.After 2 failed attempts to verify, the payment method can no longer be used. The payer should re-submit their payment details to create a new payment method and try again. |
Payout is under review | payouts.in_review | Click to expand for sample Notification payloads and sample email templates.Inspect the following parameters to inform the email:
|
Payout Created | payouts.completed | Click to expand for sample Notification payloads and sample email templates.Inspect the following parameters:
|
Failed Payout | payouts.failed | Click to expand for sample Notification payloads and sample email templates.
|
Failed Payment | payments.failed | Click to expand for sample Notification payloads and sample email templates.
|
Failed Refund | refunds.failed | Click to expand for sample Notification payloads and sample email templates. |
New Recovery | recoveries.created | Click to expand for sample Notification payloads and sample email templates.Inspect the following parameters:
|
Failed Recovery | recoveries.failed | Click to expand for sample Notification payloads and sample email templates.
|
New Refund | refunds.created | Click to expand for sample Notification payloads and sample email templates.Inspect the following parameters and JSON blocks:
|
Failed Refund | refunds.failed | Click to expand for sample Notification payloads and sample email templates.Inspect the following JSON blocks:
|
New Dispute | disputes.created | Click to expand for sample Notification payloads and sample email templates. |
Updated Dispute | disputes.updated | Click to expand for sample Notification payloads and sample email templates. |
Resolved Dispute | disputes.resolved | Click to expand for sample Notification payloads and sample email templates.
|
Additional Notification Subscriptions
Below are some additional Notification Event Topics which will be helpful to your platform, but not necessarily tied to end user communications.
legal_entities.created
legal_entities.updated
payment_methods.created
payment_methods.deleted
payment_methods.updated
payment_methods.microdeposit_sent
payout_methods.created
payouts.created
recoveries.completed
refunds.completed
Emails Sent By WePay
Below is a list of emails that we handle. You cannot turn these emails off.
- 1099 filings and TIN verification
- Procedures for tax liens and similar claims
- WePay account closed for compromised account
- Unrecognized Charge lookup
- WePay Privacy policy updated
- WePay Terms of Service updated