GET
/
payout
/
bulk
All Upload bulk payouts
curl --request GET \
  --url https://nini.monieswitch.com/payout/bulk \
  --header 'Authorization: Bearer <token>'
{
  "status": true,
  "message": "Operation is successful",
  "data": {
    "page": 1,
    "size": 50,
    "totalRecords": 6,
    "totalPages": 1,
    "records": [
      {
        "id": "fd2acdcf-b5bf-49e1-afa4-181a1a8312ee",
        "name": "Testing",
        "type": "SCHEDULE",
        "status": "UPLOADED",
        "metadata": {
          "scheduleDate": "2024-11-13T14:00:15.851Z"
        },
        "uploadedFile": "https://d1hhqx6q67lhms.cloudfront.net/fLS3YGJqqwQBmaGAPzTQZhJ4m_bulk-payout-5.csv",
        "totalRecords": 5,
        "batchReference": "wFQXhT0zATlwfqRh6NTUGHnltUvcVsuLtM3Y",
        "totalValidRecords": 5,
        "totalInvalidRecords": 0,
        "createdAt": "2024-11-13T12:27:24.294Z"
      },
      {
        "id": "2facad3c-4eae-4937-97a8-c68d26806c5a",
        "name": "Testing",
        "type": "SCHEDULE",
        "status": "UPLOADED",
        "metadata": {
          "scheduleDate": "2024-11-13T14:00:15.851Z"
        },
        "uploadedFile": "https://d1hhqx6q67lhms.cloudfront.net/CcvO3kIwlP9W9WbOdHBZLuR9t_bulk-payout-5.csv",
        "totalRecords": 5,
        "batchReference": "0W2z8isCoW8u4sBzBEdlq2SUAwuY0JLjvwWd",
        "totalValidRecords": 5,
        "totalInvalidRecords": 0,
        "createdAt": "2024-11-13T12:26:42.582Z"
      },
      {
        "id": "eb8c66ef-7fef-4a44-8ff9-6e75d2da121f",
        "name": "Testing",
        "type": "SCHEDULE",
        "status": "UPLOADED",
        "metadata": {
          "scheduleDate": "2024-11-13T14:00:15.851Z"
        },
        "uploadedFile": "https://d1hhqx6q67lhms.cloudfront.net/2tPfMjV2J5RDiyU2PSnUjK3QJ_bulk-payout-5.csv",
        "totalRecords": 5,
        "batchReference": "0zJL5btPEtzrK2s5k9Q7Rkz7UqP3basy1CY7",
        "totalValidRecords": 5,
        "totalInvalidRecords": 0,
        "createdAt": "2024-11-13T12:26:03.763Z"
      },
      {
        "id": "a4575a9c-8060-4b35-a53b-0d3bbae48f6e",
        "name": null,
        "type": "ONETIME",
        "status": "COMPLETED",
        "metadata": null,
        "uploadedFile": null,
        "totalRecords": 2,
        "batchReference": "jhNSFKTjIy6HcfGq0MGRkW6FswVZNSG11IJG",
        "totalValidRecords": 1,
        "totalInvalidRecords": 1,
        "createdAt": "2024-11-08T09:59:16.121Z"
      },
      {
        "id": "ed06772e-cdd1-43ad-b43d-75917510b219",
        "name": null,
        "type": "ONETIME",
        "status": "COMPLETED",
        "metadata": null,
        "uploadedFile": null,
        "totalRecords": 2,
        "batchReference": "KtZRccJTKxnb6cRTqeoQHjLu31O5Apw5GMAx",
        "totalValidRecords": 1,
        "totalInvalidRecords": 1,
        "createdAt": "2024-11-08T09:19:30.283Z"
      },
      {
        "id": "4e092895-17ed-4d6c-9f24-6c879ff144e2",
        "name": null,
        "type": "ONETIME",
        "status": "COMPLETED",
        "metadata": null,
        "uploadedFile": null,
        "totalRecords": 2,
        "batchReference": "RZpz2ovThIkM2lJKJdufBGBZETrY1vHquzsr",
        "totalValidRecords": 2,
        "totalInvalidRecords": 0,
        "createdAt": "2024-11-08T08:10:03.066Z"
      }
    ]
  }
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

page
integer
size
integer
name
string
reference
string
startDate
string
endDate
string
type
string

ONETIME, SCHEDULE, RECURRENT

Response

200 - application/json

All Upload bulk payouts - Successful

The response is of type object.