Fetch Payin Status (Batch)

Api Endpoint:

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

{BaseUrl}/user/getPayinDetailsBatch

Description

The Batch Fetch Payin Status API allows users to fetch the status of multiple transactions within a specific date range using pagination. This is useful for reporting, reconciliation, and large-scale data sync.

Request

Request Header

Request Header

{
  "apiKey": "your api key",
  "token": "your token",
 "content-type": "application/json"
}

• apiKey: Your unique API key provided by PayHub.
• token: A token that validates your session or request.
• content-type: Specifies that the request body is in JSON format.

Request Body

Request Body

{
  "start_date": "2025-03-25",
  "end_date": "2025-03-25",
  "limit": 10,
  "skip": 0,
  "status": "success"||"failed"||"pending"||"chargeback"(optional field)
}

• start_date: Start date of the transaction range (in YYYY-MM-DD).
• end_date: End date of the transaction range (in YYYY-MM-DD).
• limit: Number of records to fetch (max: 10000).
• skip: Records to skip (for pagination).
• status: Status of the transactions.

Possible Responses:

Success Response

Success Response

{
  "responseCode": 200,
  "responseMessage": "Success",
  "responseData": {
    "page": 1,
    "limit": 10,
    "count": 10,
    "data": [
      {
        "transaction_id": "qr_ABC123",
        "amount": 100,
        "status": "pending",
        "utr":"15667899",
        "code": "01",
        "description": "transaction pending",
        "createdAt": "2025-03-26T05:01:58.916Z"
      }
    ]
  }
}

Error Responses

Missing Start Date

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

Missing End Date

{
  "responseCode": 400,
  "responseMessage": "Please provide valid details.",
  "responseData": "endDate 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": 401,
  "responseMessage": "Invalid apiKey"
}

Invalid Details

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

Notes

• Dates are parsed in IST timezone.
• Use pagination (limit and skip) to fetch large data sets safely.
• Do not exceed 10,000 records per request.
• Secure your API credentials.