Documentation

Get batch payout

Suggest Edits

This API retrieves the details of a specific batch payout using its unique batch payout UUID. The response provides comprehensive information about the payout, including the total amount and a breakdown of transactions grouped by payee.


📘

Authentication Route

This route is secured with processor token authentication.


Endpoint

   /3p/api/v2/batch-payouts/{batch_payout_uuid}

 


Response

{
    "status": true,
    "message": "",
    "data": {
        "total": 8900,
        "direction": "credit",
        "payee_id": [
            {
                "payee_id": "0cda5458-660f-4f12-9447-e432da2f959c",
                "total": 8900,
                "transactions": [
                    {
                        "transaction_id": "9ccf5706-dff0-46c7-bf74-4e34dc998485",
                        "client_reference_id": "typesetting",
                        "amount": 4400
                    },
                    {
                        "transaction_id": "9ccf577a-921b-431a-9e35-80b7fde5e2bd",
                        "client_reference_id": "typesetting",
                        "amount": 4500
                    }
                ]
            }
        ]
    },
    "errors": null,
    "error_code": null
}

Updated 9 days ago