Fetch Payout Status (Batch)

Api Endpoint:

This API for Payout Status (Batch) will be a POST request.

{BaseUrl}/payouts/getPayoutDetailsBatch

Description

The Fetch Payout Status (Batch) API allows a user to fetch multiple payout transaction statuses within a date range. This is useful for reconciliation, reporting, and auditing purposes.

---

Request

Request Header

Request Header

{
  "apiKey": "your api key",
  "token": "your token"
}

• apiKey: Your unique API key provided by PayHub.
• token: A token that validates your session or request.

Request Body

Request Body

{
  "start_date": "2025-03-28",
  "end_date": "2025-03-28",
  "limit": 10,
  "skip": 0
}

• start_date: Start date (YYYY-MM-DD) in IST.
• end_date: End date (YYYY-MM-DD) in IST.
• limit: Number of records to return (max 10000).
• skip: Offset for pagination.

---

Success Response

Success Response

{
  "responseCode": 200,
  "responseMessage": "Success",
  "responseData": {
    "page": 1,
    "limit": 10,
    "count": 10,
    "data": [
      {
        "transaction_id": "65eed955exyz",
        "amount": 101,
        "status": "success",
        "utr":"15667899",
        "code": "01",
        "description": "transaction pending",
        "createdAt": "2025-03-28T08:12:45.000Z"
      }
    ]
  }
}

---

Error Responses

Missing Start Date

{
  "responseCode": 400,
  "responseMessage": "Please provide valid details.",
  "responseData": "start_date is required"
}

Missing End Date

{
  "responseCode": 400,
  "responseMessage": "Please provide valid details.",
  "responseData": "end_date is required"
}

Invalid Limit

{
  "responseCode": 400,
  "responseMessage": "Please provide valid details.",
  "responseData": "limit must be a number"
}

Invalid Skip

{
  "responseCode": 400,
  "responseMessage": "Please provide valid details.",
  "responseData": "skip must be a number"
}

Limit Too High

{
  "responseCode": 400,
  "responseMessage": "Please provide valid details.",
  "responseData": "limit cannot be greater than 10000"
}

Invalid API Key

{
  "responseCode": 403,
  "responseMessage": "Invalid apiKey"
}

Invalid Details

{
  "responseCode": 400,
  "responseMessage": "Invalid details"
}

---

Notes

• All timestamps are handled in IST timezone.
• Use limit and skip for efficient pagination.
• Ideal for bulk status tracking of payouts across a date range.
• Corresponding codes: "00" (success), "01" (pending), "02" (failed), "U69" (expired), "03" (unknown)