Complete Bulk Payout
Completes a bulk bank payout batch after the payout CSV has been successfully uploaded.
Important: This step is required
The Complete Bulk Payout endpoint must be called after the Bulk payout step has been completed successfully. It uses the
batch_referencereturned for the uploaded batch to confirm and complete the payout processing.
Request
Method: POST
Endpoint:
{{base_url}}/api/v1/payout/wallet-bank/completeAuthentication & Headers
| Header | Type | Required | Description |
|---|---|---|---|
Authorization | String | Yes | Bearer ${auth_secret_1d9l} — your activated authentication secret. |
x-merchant-ref | String | Yes | Your unique merchant reference. |
Content-Type | String | Yes | Must be set to application/json. |
Request Body
{
"batch_reference": "LBREF-2CC2032A-7CB2-4FAF-974A-D9FD1541FB35-003C6",
"wallet_pin": ""
}Request Fields
| Field | Type | Required | Description |
|---|---|---|---|
batch_reference | String | Yes | Unique reference of the bulk payout batch returned after the CSV upload. |
wallet_pin | String | Yes | Wallet PIN used to authorize and complete the bulk payout. |
Bulk Payout Flow
The bulk payout process must be completed in the following order:
1. Upload Bank Accounts → 2. Complete Bulk Payout → 3. Get Bulk Payout
Step 1: Upload Bank Accounts
Upload the CSV containing the recipient account details and payout amounts using the Bulk Payout Upload endpoint.
The upload generates a batch_reference for the batch.
Step 2: Complete Bulk Payout
Use the generated batch_reference and the merchant's wallet PIN to complete and authorize the payout batch.
POST /api/v1/payout/wallet-bank/completeStep 3: Get Bulk Payout
After completing the batch, use the batch_reference with the Get Bulk Payout endpoint to retrieve the processing results and individual payout statuses.
GET /api/v1/payout/wallet-bank/batch?batch_reference={batch_reference}Note: The same
batch_referencegenerated during the upload is used for both the Complete Bulk Payout and Get Bulk Payout steps.
Updated 25 days ago