Release Notes

Support

Release Notes

May 2026

Disbursement approval and rejection webhooks — Operators now receive a webhook when they approve or reject a disbursement via Proceed With Disbursement. Approval fires status: "approved" and rejection fires status: "rejected", completing the disbursement webhook lifecycle alongside the existing creation, success, failed, and declined events. See Webhooks → Disbursements for the full lifecycle and updated payload examples.

KYC moved into the SDK — Identity verification now runs inside the Vivamo SDK. Call Get Customer KYC Info to get a client secret, pass it to the new vivamo.createKycElements() method, and the widget handles the full KYC flow. If you'd rather not wire any of this up yourself, the SDK will trigger verification on a customer's first payment or disbursement. The verifyAfterCreation flag on Create Customer is deprecated.

Check customer location endpoint - A new GET /v1/customers/{externalCustomerId}/location endpoint returns whether the customer should be granted access based on their current location according to their IP address. This can be used for geolocation-based restrictions prior to going through the Vivamo SDK flows.
SDK W-9 tax form flow — The SDK now automatically handles W-9 collection during disbursements. When a customer triggers the W-9 requirement, the SDK shows the W-9 form and resumes the disbursement flow after submission.
Disbursement approval blocked until W-9 complete — The proceed-with-disbursement endpoint now returns a 400 error if the customer has not completed their W-9.
W-2G prize recording — Operators with bingo or horse racing tax types can now record qualifying prizes via POST /v1/customers/{externalCustomerId}/prizes. Prizes are validated against IRS filing thresholds ($1,200 for bingo, $600 + 300x wager for horse racing) and automatically trigger W-9 collection when needed.
Prize record retrieval — A new GET /v1/customers/{externalCustomerId}/prizes endpoint returns a customer's prize records, filtered by tax year (defaults to the current year).
SDK Restyling - Some visual updates to the SDK including new button styles, improved error message formatting, and better spacing for a cleaner look.

Improved API documentation - (You are here!) Updated code samples and added more detailed explanations for all API endpoints, including new error codes and troubleshooting tips. Added support for LLMs and AI.
Disposable email blocking — Customer creation and updates now reject email addresses from known disposable or temporary email providers (e.g. Mailinator, Guerrilla Mail, YOPmail). Requests using a disposable email domain return a 400 error.
Plus suffix email blocking — Email addresses containing + characters in the local part (e.g. user+test@example.com) are no longer accepted during customer creation or updates. This prevents the creation of duplicate accounts via email aliasing.

Customer KYC status change webhook — Vivamo now sends a webhook to your registered URL whenever a customer's KYC verification status changes (e.g. from pending to verified or under_review).
Customer creation hardening — Improved handling of shared externalCustomerId and email values. Duplicate detection is now more robust across operators.
Payment descriptor support — Operators can now configure a payment descriptor that appears on the customer's bank or card statement. The SDK displays the descriptor during the payment flow.

Publishable key authentication — Fixed an issue with publishable keys (pk_...).
1099 reporting threshold increased — The disbursement threshold for collecting 1099 tax information has been raised from $600 to $2,000, per IRS publication.

Pay By Bank (Aeropay) integration — Added Aeropay as a pay-by-bank processor for instant ACH payments and disbursements. Customers can link their bank accounts through the Aeropay widget and use them for future transactions.
SMS verification is now a standalone step, separated from the payment and disbursement flows for a cleaner customer experience.
Improved error detail messages in the SDK for more actionable feedback when transactions fail.

Added surcharge support with a full fee breakdown displayed in the SDK before the customer confirms a transaction.
SDK now displays base amount, processing fees, sales tax, and total separately when surcharges apply.
Card type detection for stored payment methods (Visa, Mastercard, etc.).

Improved sales tax location handling for more accurate tax calculations.
Fixed webhook signature generation for outbound webhooks where the amount field format was inconsistent.

Switched to a new KYC verification provider for improved identity verification reliability.
Verification links now return separate URLs for driver's license and passport verification.
Added sales tax calculation support, automatically applied based on the customer's location when enabled.
Simplified KYC completion checks in the SDK flow.

Introduced sales tax as an optional feature for payment transactions.
Added Luhn validation on credit card entry in the SDK for immediate feedback on invalid card numbers.
Added 1099 tax information collection for disbursements exceeding the $600 annual threshold.
SDK UX improvements when only one transaction type is available.

Added the ability to initiate KYC verification during customer creation using the verifyAfterCreation flag.
Customer profile information is now included in the pending disbursement list response.
Added a Get Customer Disbursements endpoint.
Geolocation enforcement — transactions can now be restricted by the customer's location.
Frontend SDK refactored to a modular architecture for faster load times and improved performance.
Fixed an issue with one-off (non-stored) card payments.

Platform rebranded from RubyPay to Vivamo, including new API domains and SDK assets.
Added geolocation-based authorization for restricting transactions by region.
Introduced value-based processor orchestration for smarter transaction routing based on amount thresholds.
Fixed SDK styling in dark mode.

Launched Pay By Bank (ACH Instant) as a new payment method for both payments and disbursements.
Added payment status cooldown to prevent duplicate status polling.
Improved payment failure handling — failed status can no longer be overridden by stale responses.
SDK now displays success and failure icons on transaction completion.