Documentation

Batch Payouts

📘

Authentication Route

This route is secured with processor token authentication.

This API is processor specific and returns the list of batch payouts to a processor and can be filtered by a date range.


Endpoint

   /3p/api/v1/batchpayouts

 

Query Payload

FieldsTypeIs RequiredDescription
start_datestringNoDate should be in format: Y-m-d
end_datestringNoDate should be in format: Y-m-d

Response Object

{
    "status": true,
    "message": "",
    "data": [
      {
        "payout_uuid": "9bd53fe1-ac74-4e81-b6f2-be88b7c86a68",
      	"date": "2024-04-18 01:00:20"
      },
      {
        "payout_uuid": "9bd945fb-c942-402b-8420-bbcf5094fd9b",
      	"date": "2024-04-19 01:00:20"
      }
    ],
    "errors": null,
    "error_code": null
}

Errors & Warnings

CodeMessage
401
422