This guide is designed to help you upgrade from SingleView Payouts API V1.0 to Payouts API V2.0 and make the most of the enhanced features and structural improvements introduced in the latest version.

What's New in Payouts API V2.0

Payouts API V2.0 offers a cleaner, more modular architecture to streamline your payout operations. With V2.0, you can now perform:

Key Changes in V2.0

When upgrading from V1.0 to V2.0, take note of the following updates:

1. URL Structure Changes

Separate URLs for Single and Bulk payouts and Single and Bulk Payouts Enquiry delivering a cleaner endpoint structure for easier integration and maintenance.

API	New Endpoint
Single Payout	/api/v2/single/payment
Single Payout Enquiry	/api/v2/single/payment/enquiry
Bulk Payout	/api/v2/bulk/payment
Bulk Payout Enquiry	/api/v2/bulk/payment/enquiry

2.TransferType Tag Moved to Payload

In V1.0, transfer type was part of the URL.

In V2.0, it is removed from the URL and is now passed within the payload for both single and bulk payouts.

3. Improved Payload Structure

More structured and intuitive request and response formats for enhanced readability and clearer field definitions for faster implementation.

4. Removal ofbulkToSingle Tag

The bulkToSingle identifier has been removed from both single and bulk payout payloads as well as from single and bulk payload enquiry payloads.

5. Change in Payout EnquiryMessageType Tag

The MessageType used in Payout Enquiry has been updated to BPE for Bulk Payout Enquiry and SINGLEREQ for Single Payout Enquiry consistency and clarity.

Upgrade Checklist

Before going live with Payouts V2.0, ensure you've completed the following:

✅ Review the new endpoint URLs

✅ Update your logic to pass transfer type in the payload

✅ Refactor the request/response structures based on the V2.0 format

✅ Remove deprecated fields like bulkToSingle

✅ Update Payout Enquiry requests with MessageType: BPE (Bulk Payouts Enquiry) & MessageType: SINGLEREQ (Single Payouts Enquiry)

✅ Validate all flows in the sandbox environment

Why Upgrade to V2.0?

Simplified and modular endpoints
Enhanced clarity and consistency in API communication
More scalable architecture for future enhancements
Clear separation between single and bulk flows
Better support for audit, reconciliation, and monitoring

📘
Need help?
If you face any challenges during the upgrade or need further clarification, don’t hesitate to contact the SingleView support team. We’re here to ensure your upgrade is seamless.