Paytm Payment Gateway icon

Paytm Payment Gateway

Manage payments, subscriptions, refunds, and settlements using Paytm APIs

Actions13

Settlement → Fetch All

AI-generated

Summary

Fetches a list of settlements (payouts) from Paytm within a specified date range, with optional filters for settlement bill ID, UTR number, and settlement status, supporting pagination.

Inputs

  • settlementStartTime (required) — Start date and time for the settlement range (inclusive).
  • settlementEndTime (required) — End date and time for the settlement range (inclusive).
  • pageNum — Page number to fetch (starting from 1). Default: 1.
  • pageSize — Number of settlements per page (max 50). Default: 20.
  • additionalFields.settlementBillId — Filter by specific settlement bill ID (payout ID).
  • additionalFields.utrNo — Filter by UTR number (unique transaction reference).
  • additionalFields.settleStatus — Filter by settlement status. Options: Any (empty), Bank Initiated, Payout Settled, Payout Unsettled, Wait for Settle.

Output shape

object

Returns the settlement bill list data from Paytm, typically containing a data array of settlement objects with fields such as settlement bill ID, amount, status, UTR, timestamps, etc.

Links

Discussion