Documentation

Batch Payout

Suggest Edits

📘

Authentication Route

This route is secured with processor token authentication.

This API is processor specific and returns the list of transactions included in a processor batch payout grouped by Payee.

Endpoint

   /3p/api/v1/batchpayout/{payout_uuid}

 

Response Object

{
    "status": true,
    "message": "",
    "data": {
        "total": 10100,
        "direction": "credit",
        "payee_id": [
            {
                "payee_id": "51126751-6bfe-4346-a58b-e96ce3da6fe3",
                "total": 6060,
                "transactions": [
                    {
                        "transaction_id": "9bd42a41-70d2-484c-98a6-21709141660d",
                        "client_reference_id": "deposit_12345",
                        "amount": 6060
                    }
                ]
            },
            {
                "payee_id": "396dda76-f451-42c7-9bd6-85ad412680c2",
                "total": 4040,
                "transactions": [
                    {
                        "transaction_id": "9bd429a5-f0ed-4550-bc8e-02699b6c6afa",
                        "client_reference_id": "deposit_54321",
                        "amount": 4040
                    }
                ]
            }
        ]
    },
    "errors": null,
    "error_code": null
}

Errors & Warnings

CodeMessage
401
422

Updated 5 months ago