This API retrieves a list of all batch payouts. The response provides details for each payout, including the total amount and relevant timestamps. Pagination options are available to efficiently manage large datasets.

Authentication Route This route is secured with processor and vendor token authentication.

​
Endpoint

GET 3p/api/v2/batch-payouts/business/{busines_user_uuid}

​
Path Parameters

ParameterTypeDescription
business_user_uuidstringThe UUID of the business user whose payout details you want to retrieve.

​
Query Parameter

FieldsTypeIs RequiredDescription
per_pageintegerNoBy default: 10 Min: 1 Max: 100
start_datestringNoThis parameter will filter the user’s records based on the creation date of the batch payout. Date format: Y-m-d
end_datestringNoThis parameter will filter the user’s records based on the creation date of the batch payout. Date format: Y-m-d
sort_orderstringNoBy default: newest Possible Value: newest oldest
pageintegerNoBy default: 1 Min: 1

​
Response

{
    "status": true,
    "message": "",
    "data": {
        "batch_payouts": [
            {
                "uuid": "ec0eb270-b656-4ffe-8799-66508ad48e18",
                "amount": 8900,
                "trace_id": "ach_11kt6v9715jp67t",
                "payout_status": "PAYOUT_COMPLETE",
                "ach_return_code": null,
                "failure_reason": null,
                "created_at": "2025-02-16 14:15:15",
                "updated_at": "2025-02-18 14:15:15"
            },
            {
                "uuid": "941c0a0e-ff5c-46c5-8198-58b868e1b832",
                "amount": 2200,
                "trace_id": "ach_11kt6v9715jp67t",
                "payout_status": "PAYOUT_COMPLETE",
                "ach_return_code": null,
                "failure_reason": null,
                "created_at": "2025-02-16 14:15:15",
                "updated_at": "2025-02-18 14:15:15"
            },
            {
                "uuid": "312fff75-c3fb-4661-a2c6-bf909871be3b",
                "amount": 6600,
                "trace_id": "ach_11kt6v9715jp67t",
                "payout_status": "PAYOUT_COMPLETE",
                "ach_return_code": null,
                "failure_reason": null,
                "created_at": "2025-02-16 14:15:15",
                "updated_at": "2025-02-18 14:15:15"
            }
        ],
        "pagination": {
            "total_items": 12,
            "per_page": 10,
            "current_page": 1,
            "total_pages": 2
        }
    },
    "errors": null,
    "error_code": null
}

​
Errors & Warnings

{
    "status": false,
    "message": "Invalid Parameters Received: startDate, endDate",
    "data": null,
    "errors": null,
    "error_code": null
}