Get Payouts

get

https://plural-uat.v2.pinepg.in/payouts/v3/payments

Use this API to fetch all the payout details.

Environment

Use our UAT environment endpoint for testing and for integration utilize our production endpoint.

Environment	Endpoints
User Acceptance Testing [UAT]	`https://plural-uat.v2.pinepg.in/payouts/v3/payments`
Production [PROD]	`https://api.pluralpay.in/payouts/v3/payments`

📘
Note:

This API allows you to retrieve payout details.

Use paymentReferenceId or clientReferenceId to fetch details of a specific payout.

Use requestReferenceId to fetch details of all payouts associated with a single request.

Query Params

paymentReferenceId

string

Unique identifier of the payment in the Pine Labs Online database.

Minimum length: 1 character.
Maximum length: 50 characters.

Example: 0171c4c0-f50a-4151-b39b-63c87a3c0cd6

clientReferenceId

string

Unique identifier entered while creating a payout request.

Minimum length: 1 character.
Maximum length: 40 characters.
Must not contain spaces.

Example: txn-b03ee63e412a4ecf88b6bdb08a6632c3

requestReferenceId

string

Unique identifier of the request in the Pine Labs Online database.

Minimum length: 1 character.
Maximum length: 50 characters.

Example: 664816162868

bankTransactionReferenceId

string

Unique Transaction Reference [UTR] of the transaction.

Example: 664816162868

mode

string

Mode in which the payout was processed.

Possible values:

UPI
IMPS
NEFT
RTGS

Example: IMPS

dateFrom

string

Fetch payouts initiated after the specified date.

Example: 2025-07-15T10:26:06Z

dateTo

string

Fetch payouts initiated before the specified date.

Example: 2025-08-16T10:26:06Z

status

string

Query based on the status of the payouts.

Possible values:

SCHEDULED
PENDING
PROCESSING
PROCESSED
SUCCESS
FAILED

Example: SUCCESS

page

string

Number of pages to be displayed.

By default it is 1.

Example: 1

count

string

Number of transaction to be displayed in a page.

Example: 10

Headers

Content-Type

string

Defaults to application/json

The type of content included in the HTTP message body.

Possible value: application/json.

Authorization

string

required

Defaults to Bearer

The HTTP header where you can include your secret token for authentication.

Example: Bearer <access_token>

Note: Use the access token generated using our Generate Token API.

Request-Timestamp

string

Use ISO 8601 UTC Timestamp, to create a timestamp when the generate token is requested.

Example: 2024-07-09T07:57:08.022Z

Request-ID

string

Use a global unique identifier [GUID] for the request.

Minimum: 1 characters.
Maximum: 50 characters

Example: c17ce30f-f88e-4f81-ada1-c3b4909ed235

Responses

Language

Credentials

Header

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

Environment

📘Note:

200200

400400

📘
Note: