List Payouts API

GET/payouts/v3/payments

Retrieves payout details. Use paymentReferenceId or clientReferenceId to fetch a specific payout, or requestReferenceId to fetch all payouts associated with a single request. Supports filtering by mode, status, and date range.

View as Markdown Open in ChatGPT Open in Claude Open in Perplexity

Requires Bearer token. Get token →

Header Parameters

Field	Details
`Request-Timestamp` `string`date-time	ISO 8601 UTC timestamp of the request. Used for idempotency and audit.
`Request-ID` `string`	Use a global unique identifier [GUID] for the request. Constraints Minimum length: 1 characterMaximum length: 50 characters

Query Parameters

Field	Details
`paymentReferenceId` `string`	Unique identifier of the payment in Pine Labs database. Constraints Minimum length: 1 characterMaximum length: 50 characters
`clientReferenceId` `string`	Unique client reference provided when creating the payout. Constraints Minimum length: 1 characterMaximum length: 40 characters
`requestReferenceId` `string`	Unique identifier of the request in Pine Labs database. Constraints Minimum length: 1 characterMaximum length: 50 characters
`bankTransactionReferenceId` `string`	Unique Transaction Reference (UTR) from the bank.
`mode` `string`	Filter by payment mode. Allowed values: `UPIIMPSNEFTRTGS`
`dateFrom` `string`date-time	Fetch payouts initiated after this date (ISO 8601 UTC).
`dateTo` `string`date-time	Fetch payouts initiated before this date (ISO 8601 UTC).
`status` `string`	Filter by payout status. Allowed values: `SCHEDULEDPENDINGPROCESSINGPROCESSEDSUCCESSFAILED`
`page` `string`	Page number (default 1). Constraints Default value: 1
`count` `string`	Number of records per page. Constraints Default value: 10

Response

Field	Details
`payments` `GetPayoutsPaymentItem[]`15 nested fields	List of payout records matching the query.
`clientReferenceId` `string`	Unique identifier to track the payout.
`paymentReferenceId` `string`	Unique identifier of the payment in Pine Labs database.
`bankTransactionReferenceId` `string`	Unique Transaction Reference (UTR) from the bank.
`mode` `string`	Payment mode used for the payout. Allowed values: `UPIIMPSNEFTRTGS`
`amount` `object`2 nested fields	Payout monetary amount with currency. For payout creation, minimum ₹1 (100 paisa), maximum ₹10 lakh (100000000 paisa).
`accountNumber` `string`	Beneficiary's bank account number (may be masked).
`payeeName` `string`	Name of the beneficiary.
`fees` `object`2 nested fields	Monetary amount with currency (no min/max constraints). Used for fees, tax, and balance values.
`tax` `object`2 nested fields	Monetary amount with currency (no min/max constraints). Used for fees, tax, and balance values.
`remarks` `string`	Description or reference text for the transaction.
`status` `string`	Current payout status. Allowed values: `SCHEDULEDPENDINGPROCESSINGPROCESSEDSUCCESSFAILED`
`message` `string`	Message corresponding to the payout status.
`createdAt` `string`date-time	Timestamp when the payout request was received (ISO 8601 UTC).
`updatedAt` `string`date-time	Timestamp when the payout record was last updated (ISO 8601 UTC).
`scheduledAt` `string`date-time	Scheduled execution time in UTC.
`totalRecords` `integer`	Total number of records matching the query.
`nextPage` `integer`	Next page number in the result set.
`totalPages` `integer`	Total number of pages in the result set.
`_links` `PayoutLink[]`2 nested fields	HATEOAS pagination links.

Status Codes

`200`	Payout records retrieved successfully.
`400`	The request was malformed or missing required fields.
`401`	Authentication failed — missing, expired, or invalid Bearer token.
`403`	The authenticated client does not have permission for this operation.
`500`	An unexpected error occurred on the server.

Run

Request

curl --request GET \
  --url 'https://pluraluat.v2.pinepg.in/payouts/v3/payments?paymentReferenceId=txn-b03ee63e412a4ecf88b6bdb08a6632c3&clientReferenceId=0171c4c0-f50a-4151-b39b-63c87a3c0cd6&requestReferenceId=664816162868&bankTransactionReferenceId=664816162868&mode=IMPS&dateFrom=2025-07-15T10%3A26%3A06Z&dateTo=2025-08-16T10%3A26%3A06Z&status=SUCCESS&page=1&count=10' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN' \
  --header 'Request-ID: a1b2c3d4-e5f6-7890-abcd-ef1234567890' \
  --header 'Request-Timestamp: 2024-10-01T10:30:00Z'

Status:

{
  "payments": [
    {
      "clientReferenceId": "0171c4c0-f50a-4151-b39b-63c87a3c0cd6",
      "paymentReferenceId": "txn-b03ee63e412a4ecf88b6bdb08a6632c3",
      "bankTransactionReferenceId": "664816162868",
      "mode": "IMPS",
      "amount": {
        "currency": "INR",
        "value": 4900
      },
      "accountNumber": "*******9300",
      "payeeName": "Kevin Bob",
      "fees": {
        "currency": "INR",
        "value": 0
      },
      "tax": {
        "currency": "INR",
        "value": 0
      },
      "remarks": "REFUND",
      "status": "SUCCESS",
      "message": "Payment instruction successfully executed with bank",
      "createdAt": "2025-07-16T10:26:06Z",
      "updatedAt": "2025-07-16T10:28:06Z",
      "scheduledAt": "2025-07-16T10:26:06Z"
    }
  ],
  "totalRecords": 1,
  "nextPage": 1,
  "totalPages": 1,
  "_links": [
    {
      "rel": "first",
      "href": "/payouts/v3/payments?page=1&count=500&paymentReferenceId=txn-b03ee63e412a4ecf88b6bdb08a6632c3"
    }
  ]
}