Find updates to WePay’s API and other products/features here in the Release Notes.
Subscribe here for API release notes via email:
|Version||Date Introduced||Upgrade Guide|
|API Changes||Doc Changes|
Link & Clear
Link & Clear
New ACH verification error
Link & Clear
A new error reason code has been implemented in order to provide more information when attempts to verify an ACH payment method have permanently failed. The new reason code is
New merchant verification requirements
To enhance protection of your platform, payers, and merchants, WePay is requiring new verification fields for all merchants onboarded after September 1, 2020.
Change in ownership feature
When an individual’s information (such as address) changes, or when an individual joins/leaves an organization, that information should be updated via the API. Learn more about the restrictions and expectations for this feature below.
Limited availability Terminal models
WePay now offers the Ingenico Lane 3000 and XAC AT170R on a limited availability basis. Development is still underway, so these terminal models will only be available in the Stage environment for the time being. Reach out to your WePay integration team or technical account manager for more information.
Update to CAD fee disclosure sample
Link & Clear
The sample Canadian fee disclosure box has been updated to provide more comprehensive information.
Update to Link restrictions & permissions-based feature list
As new features have been released, additional items have been added to the Link restrictions & permissions-based features lists. Review these items below.
Merchant IC+ refund policy
All partners leveraging the Merchant IC+ pricing model must implement the outlined refund policy. Additionally, partners charging fees for refunds must disclose that fee to merchants.
Terminal custom screen spec guide
Configure the terminal screens for your merchants with your own custom designs.
Mobile card reader pairing guide
This new guide provides a detailed walk through of how to pair both the Moby 5500 and the RP457c AudioJack card readers.
New guide for processing 1 transaction with 2+ cards
Review the recommended process for processing a single transaction using multiple authorizations. This case can come up when a customer has a limited balance on one card (like a gift card) and then needs to use a second card to pay the remaining balance.
New Card Present solution: Mobile Card Readers
Link & Clear
Simplify your Card Present integration and minimize your API usage by eliminating device and configuration management. Note that keyed card entry and receipt printing are not available in the Mobile Card Reader Solution.
New API error: INVALID_EMPLOYER_IDENTIFICATION_NUMBER
More specific information is returned with the INVALID_PARAMS error when the submitted EIN is not in a valid format on Legal Entity requests.
Merchant IC+ fee disclosure
A legally required component of Merchant IC+, fee disclosures must be presented to merchants prior to acceptance of pricing terms. Save agreements and leverage the document upload JS to meet this requirement.
Build Payment Support Tools
Build payment-specific support tools for your team as required from Clear partners.
Account Capability for Terminals
Link & Clear
There is now a Capability indicating whether a merchant can leverage a Terminal for Card Present transactions. If your platform has not integrated Card Present transactions, then your merchants’ Terminal Capability will never be enabled. This Capability only impacts a merchant’s ability to use Terminals, and has no impact on web-based processing.
deferred_auth is nullable
Rather than customizing the
deferred_auth options for Terminals, fallback to the defaults by not passing the structure.
Transaction Records can now be updated with
custom_data to help platforms customize reporting. For instance, create your own custom categories, such as “tips”, “subscriptions”, and “carts” and then organize transaction records in your own database according to that
Transaction Records Descriptions
Transaction Record parameters on other resources now have updated descriptions to provide more context and specificity. For instance, Transaction Record parameters on a Dispute lookup identify more accurately exactly what that portion of the transaction represents.
- Example: Dispute lookup response
Credit card iFrame styling
The credit card iFrame now supports styling the color of errors.
The following values will return an error if submitted for entity or controller
address.region for US-based merchants:
This restriction is applicable to both Link and Clear merchants, but only partners integrating WePay’s Clear solution need to develop against it.
Updated R10 & R11 ACH return codes
NACHA has updated the meaning for R10 and R11 ACH return codes. This update provides more specificity and differentiation, allowing enhanced insight into the status of attempted payments, and next steps.
Recurring and authorization MIC+ fees
MIC+ now supports recurring and authorization fees. Charge merchants recurring fees (i.e. for subscription/membership), as well as fees per authorization (regardless of authorization result).
Level 2 & Level 3 Processing
WePay now supports L2/L3 processing. Reduce Dispute volume for your merchants by providing more transactional information upfront.
The Security Certification now outlines recommendations (not requirements) about the kind of SSL certificate to use.
Paper Check Payouts
WePay now supports paper check Payouts for merchants in the US.
Important: Using a value of
daily on the
period parameter when setting up Payouts on an Account and when the Payout Method is paper check is only intended for resolving one-time Payouts for merchants. Sending daily paper check Payouts to a single merchant more than once in a given week will incur additional costs for your platform.
Sane Defaults to Fetch Transaction Records
On GET /transaction_records, the
create_time_start parameter will default to current time -7 days, and the
create_time_end parameter will default to the current time. Additionally, the maximum interval between
create_time_end is 35 days.
The following API error reasons have been added to the
INVALID_PARAMS error code:
Update to Required Emails
Clear partners can now use KYC iFrames rather than building out KYC UIs. This alleviates partner effort in developing to regulation with regards to KYC collection, and also removes the need for a partner’s servers to interact with PII data.
Update to CIP/KYC Certification
- KYC collection sample UIs
- New sole proprietor and individual requirements
- Removal of FinCEN information
- Changed requirements for controller information, government identification number, and merchant entity type
It is recommended to review this certification to ensure that any previous development is still in compliance.
Platforms integrating with WePay can now leverage test KYC credentials in the stage environment.
Update to Card Network Rules Certification
Added a new recommendation in addition to the 12 transaction receipt data requirements.
Guide to Recurring Billing
Recurring billing allows for subscription payments, monthly donations, and other interval-based payment use cases. While WePay supports platforms which rely on recurring billing, platforms must build the infrastructure and manage recurrence.
MIC+ Limited Launch
MIC+ is available for select platforms. MIC+ allows for cheaper processing by billing exact fees as opposed to using a generic all-encompassing fee.