Purpose, Audience and Scope
Purpose
This Implementation Guide is designed to provide merchants with a comprehensive technical reference for integrating the wero payment method.
The guide outlines all necessary steps and requirements for a direct server-to-server integration (Direct API). It focuses on enabling merchants to:
- Initiate and manage wero payments through the API
- Understand the lifecycle of payments (creation, confirmation, refund)
- Implement error handling, and idempotent request logic
The goal is to ensure that merchants can seamlessly embed wero into their checkout processes, minimize integration issues, and establish a robust foundation for live operations.
Audience
This document is intended for:
- Developers & Engineers: responsible for implementing and testing the Direct API integration
- Solution Architects: designing the payment flow and ensuring system compatibility
- Technical Project Managers: coordinating integration timelines and deliverables
Non-technical stakeholders (e.g. operations or product owners) may use this guide as a reference for process understanding, but the implementation details are aimed at technical professionals.
Scope
This guide covers the Direct API Integration of wero including:
Payment Plan Types supported:
- Single Immediate: one-time payments, executed instantly
- Event Dependent: payments triggered upon a specific event (e.g. shipment confirmed)
- Subscription: ongoing payment arrangement authorizing merchants to automatically collect funds at regular, predefined intervals
- Refunds: full or partial refunds of payments
Annotation: There will be additional supported Payment Plan Types. The Implementation Guide will be expanded accordingly.
Technical foundation:
- Authentication
- API conventions and endpoints
- Error codes
Out Of Scope
This guide does not cover:
- Hosted Payment Page (HPP) or Payment Widgets (iframe-based integrations)
- Point-of-Sale (POS) acceptance of wero
- End-customer communication strategies (UX copy, UI design, branding guidelines)
- Non-wero payment methods offered via VR Payment
Updated about 1 month ago