This document provides a comprehensive guide to integrating with the Lesspay Pay Out (Disbursement) API.1. Batch Integration Flow#
The Pay Out process supports batch submissions and involves an operational audit step before funds are released.Sequence Diagram#
2. Order State Logic#
Unlike Pay In, Pay Out orders require manual confirmation (Audit) and may result in partial success.3. Integration Steps#
Step 1: Submit Batch Request#
Call /api/global/payout/batch/create-order to submit a batch of payout instructions.Audit: The request returns immediately with status PENDING_CONFIRM. This means the system has accepted the request, but it requires internal operational audit.
Step 2: Internal Audit#
The Lesspay Operations team reviews the batch order.Approved: The system automatically subunits the transactions to the upstream Payment Channel.
Rejected: The order statis becomes FAILED, and a notification is sent.
Step 3: Channel Processing#
The payment channel processes individual fund transfers (Pay Out Details).Step 4: Final Notification#
Once all details in the batch have reached a final state (Success or Failure), Lesspay will send a single asynchronous notification to your notify_url.Logic: Query the batch details using /api/global/payout/query to see which specific transactions succeeded or failed.
Response: Return "SUCCESS" to acknowledge.
Modified at 2025-12-19 04:33:59
