Object

The table below lists the response objects received for the Payouts APIs.

API	Response Object
Create Payout	Create Payout Response Object
Get Payouts	Get Payouts Response Object
Get Account Balance	Get Account Balance Response Object
Create Bulk Payouts	Create Bulk Payouts Response Object
Update Scheduled Payout	Update Scheduled Payout Response Object
Cancel Scheduled Payout	Cancel Scheduled Payout Response Object

Create Payout

Shown below is a sample responses of a Create Payout API.

{
  "clientReferenceId": "0171c4c0-f50a-4151-b39b-63c87a3c0cd6",
  "requestReferenceId": "req-ba50808e45ce4d19a86988e7d90df3ad",
  "paymentReferenceId": "txn-b03ee63e412a4ecf88b6bdb08a6632c3",
  "payeeName": "Kevin Bob",
  "accountNumber": "*******1415",
  "branchCode": "SBIN0011123",
  "amount": {
    "currency": "INR",
    "value": 4900
  },
  "mode": "IMPS",
  "status": "SCHEDULED",
  "message": "Payment instruction scheduled for execution",
  "scheduledAt": "2025-07-16T10:26:06Z",
  "remarks": "REFUND",
  "_links": [
    {
      "rel": "status",
      "href": "http://pyt-instruction-service-dev.v2.pinepg.in/payouts/v3/payments?paymentReferenceId=txn-b03ee63e412a4ecf88b6bdb08a6632c3"
    }
  ]
}

The table below lists the various parameters returned in the Create Payout response object.

Parameter	Type	Description
clientReferenceId	`string`	Unique identifier to track the payout for your reference. Minimum length: `1` character. Maximum length: `40` characters. Must not contain spaces. Example: `430582f3-6e83-4cec-a3ab-72847fb9680f`
requestReferenceId	`string`	Unique identifier of the request in the Pine Labs Online database. Minimum length: `1` character. Maximum length: `50` characters. Example: `664816162868`
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`
payeeName	`string`	Name of the beneficiary’s bank account holder. Minimum length: `1` character. Maximum length: `40` characters. Allowed characters: alphabets and spaces only. Example: `Kevin Bob`
accountNumber	`string`	Account number of the beneficiary's bank. Minimum length: `9` digits. Maximum length: `18` digits. Example: `500012121313141415`
branchCode	`string`	Branch code of the beneficiary's bank. Maximum length: `11` characters. The first `4` characters must be alphabets (`A–Z`, `a–z`). The `5`th character must be `0`. The remaining characters (`6`th to last) can be alphanumeric (letters or digits). Example: `SBIN0011123`
amount	`object`	An object that contains the payout amount details. Learn more about our `amount` child object.
mode	`string`	Mode of payment through which you want to initiate a payout. Accepted values: `UPI` `IMPS` `NEFT` `RTGS` Example: `IMPS`
status	`string`	Payout status. Possible values: `SCHEDULED`: When the create payout request is successfully received by Pine Labs Online `PENDING`: When the funding account has insufficient balance to process the payout. `PROCESSING`: The request is successfully sent to the Bank, but the Bank has not yet processed the payout. `PROCESSED`: The bank has successfully processed the payout, but confirmation from the bank has not yet been received to Pine Labs Online. `SUCCESS`: When the transaction is successful, here the amount is debited from the payee account and credited to the beneficiary account. `FAILED`: When the transaction is failed.
message	`string`	Message corresponding to the payout status. Example: `Payment instruction scheduled for execution`
scheduledAt	`string`	Specifies the scheduled time for executing the payout. The value must be provided in UTC. Example: `2025-07-05T16:05:00Z`
remarks	`string`	Description or reference text for the transaction. Minimum length: `1` character. Maximum length: `50` characters. Supported Characters: `A-Z` `a-z` `0-9` `-` `space` Example: `Refund payment`
_links	`array of objects`	An array of objects that contains the links. Learn more about our `_links` child object.

Amount [Child Object]

The table below lists the various parameters in the amount child object. This object is part of the Create Payout response object.

Parameter	Type	Description
value	`integer`	The transaction amount is Paisa. Minimum value: `100` (₹1). Maximum value: `100000000` (₹`10` lakh). Example: `100`
currency	`string`	Type of currency. Example: `INR`

_Links [Child Object]

The table below lists the various parameters in the _links child object. This object is part of the Create Payout response object.

Parameter	Type	Description
rel	`string`
href	`string`

Get Payouts

Shown below is a sample responses of a Get Payout API.

{
  "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": "http://pyt-instruction-service-dev.v2.pinepg.in/payouts/v3/payments?page=1&count=500&paymentReferenceId=txn-b03ee63e412a4ecf88b6bdb08a6632c3"
    }
  ]
}

The table below lists the various parameters returned in the Get Payout response object.

Parameter	Type	Description
Payments	`array of objects`	An array of objects that contains the list of payment details. Learn more about our `payments` child object.
totalRecords	`integer`	Number of transactions returned in the fetch response. Example: `1`
nextPage	`integer`	Number of pages returned in the fetch response. Example: `1`
totalPages	`integer`	Total pages returned in the fetch response. Example: `2`
_links	`array of objects`	An array of objects that contains the links. Learn more about our `_links` child object.

Payments [Child Object]

The table below lists the various parameters in the payments child object. This object is part of the Get Payout response object.

Parameter	Type	Description
clientReferenceId	`string`	Unique identifier to track the payout for your reference. Minimum length: `1` character. Maximum length: `40` characters. Must not contain spaces. Example: `430582f3-6e83-4cec-a3ab-72847fb9680f`
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`
bankTransactionReferenceId	`string`	Unique Transaction Reference [UTR] of the transaction. Example: `664816162868`
mode	`string`	Mode of payment through which you want to initiate a payout. Accepted values: `UPI` `IMPS` `NEFT` `RTGS` Example: `IMPS`
amount	`object`	An object that contains the payout amount details. Learn more about our `amount` child object.
accountNumber	`string`	Account number of the beneficiary's bank. Minimum length: `9` digits. Maximum length: `18` digits. Example: `500012121313141415`
payeeName	`string`	Name of the beneficiary’s bank account holder. Minimum length: `1` character. Maximum length: `40` characters. Allowed characters: alphabets and spaces only. Example: `Kevin Bob`
fees	`object`	An object that contains the fees details. Learn more about our `fees` child object.
tax	`object`	An object that contains the tax details. Learn more about our `tax` child object.
remarks	`string`	Description or reference text for the transaction. Minimum length: `1` character. Maximum length: `50` characters. Supported Characters: `A-Z` `a-z` `0-9` `-` `space` Example: `Refund payment`
status	`string`	Payout status. Possible values: `SCHEDULED`: When the create payout request is successfully received by Pine Labs Online `PENDING`: When the funding account has insufficient balance to process the payout. `PROCESSING`: The request is successfully sent to the Bank, but the Bank has not yet processed the payout. `PROCESSED`: The bank has successfully processed the payout, but confirmation from the bank has not yet been received to Pine Labs Online. `SUCCESS`: When the transaction is successful, here the amount is debited from the payee account and credited to the beneficiary account. `FAILED`: When the transaction is failed.
message	`string`	Message corresponding to the payout status. Example: `Payment instruction scheduled for execution`
createdAt	`string`	The ISO 8601 UTC Timestamp, when the create payout request was received by Pine Labs Online. Example: `2025-07-16T10:26:06Z`
updatedAt	`string`	The ISO 8601 UTC Timestamp, when the payout response object is updated. Example: `2025-07-16T10:26:06Z`
scheduledAt	`string`	Specifies the scheduled time for executing the payout. The value must be provided in UTC. Example: `2025-07-05T16:05:00Z`

Amount [Child Object]

The table below lists the various parameters in the amount child object. This object is part of the payments child object.

Parameter	Type	Description
value	`integer`	The transaction amount is Paisa. Minimum value: `100` (₹1). Maximum value: `100000000` (₹`10` lakh). Example: `100`
currency	`string`	Type of currency. Example: `INR`

Fees [Child Object]

The table below lists the various parameters in the fees child object. This object is part of the payments child object.

Parameter	Type	Description
value	`integer`	The fee amount is Paisa. Minimum value: `100` (₹1). Maximum value: `100000000` (₹`10` lakh). Example: `100`
currency	`string`	Type of currency. Example: `INR`

Tax [Child Object]

The table below lists the various parameters in the tax child object. This object is part of the payments child object.

Parameter	Type	Description
value	`integer`	The tax amount is Paisa. Minimum value: `100` (₹1). Maximum value: `100000000` (₹`10` lakh). Example: `100`
currency	`string`	Type of currency. Example: `INR`

_Links [Child Object]

The table below lists the various parameters in the _links child object. This object is part of the Create Payout response object.

Parameter	Type	Description
rel	`string`
href	`string`

Get Account Balance

Shown below is a sample responses of a Get Account Balance API.

{
  "accountNumber": "0995300992429",
  "branchCode": "UTIB0001111",
  "balance": {
    "currency": "INR",
    "value": 19994250900
  }
}

The table below lists the various parameters returned in the Get Account Balance response object.

Parameter	Type	Description
accountNumber	`string`	Account number of the beneficiary's bank. Minimum length: `9` digits. Maximum length: `18` digits. Example: `500012121313141415`
branchCode	`string`	Branch code of the beneficiary's bank. Maximum length: `11` characters. The first `4` characters must be alphabets (`A–Z`, `a–z`). The `5`th character must be `0`. The remaining characters (`6`th to last) can be alphanumeric (letters or digits). Example: `SBIN0011123`
balance	`object`	An object that contains the funding account balance details. Learn more about our `amount` child object.

Balance [Child Object]

The table below lists the various parameters in the balance child object. This object is part of the Get Account Balance API response object.

Parameter	Type	Description
value	`integer`	The account balance amount is Paisa. Minimum value: `100` (₹1). Maximum value: `100000000` (₹`10` lakh). Example: `100`
currency	`string`	Type of currency. Example: `INR`

Create Bulk Payouts

Shown below is a sample responses of a Create Bulk Payouts API.

{
  "requestReferenceId": "req-1b980dd2c75b456782bc1a3acff481a0",
  "status": "PROCESSED",
  "message": "",
  "_links": [
    {
      "rel": "status",
      "href": "/payouts/v3/payments?requestReferenceId=req-1b980dd2c75b456782bc1a3acff481a0"
    }
  ]
}

The table below lists the various parameters returned in the Create Bulk Payouts response object.

Parameter	Type	Description
requestReferenceId	`string`	Unique identifier of the request in the Pine Labs Online database. Minimum length: `1` character. Maximum length: `50` characters. Example: `664816162868`
status	`string`	Bulk payout status. Possible values: `SCHEDULED`: When the create payout request is successfully received by Pine Labs Online `PENDING`: When the funding account has insufficient balance to process the payout. `PROCESSING`: The request is successfully sent to the Bank, but the Bank has not yet processed the payout. `PROCESSED`: The bank has successfully processed the payout, but confirmation from the bank has not yet been received to Pine Labs Online. `SUCCESS`: When the transaction is successful, here the amount is debited from the payee account and credited to the beneficiary account. `FAILED`: When the transaction is failed.
message	`string`	Message corresponding to the bulk payout status. Example: `Payout PROCESSED`
_links	`array of objects`	An array of objects that contains the links. Learn more about our `_links` child object.

_Links [Child Object]

The table below lists the various parameters in the _links child object. This object is part of the Create Payout response object.

Parameter	Type	Description
rel	`string`
href	`string`

Update Scheduled Payout

Shown below is a sample responses of a Update Scheduled Payout API.

{
  "clientReferenceId": "test4feb0-10",
  "requestReferenceId": "req-7c85bda19bf141c981b94e750c6041b6",
  "paymentReferenceId": "txn-f9e00a80a357418d908a67bd30cdbc37",
  "payeeName": "Rishendrasai",
  "accountNumber": "919000664016",
  "branchCode": "PYTM0123456",
  "vpa": "",
  "email": "[email protected]",
  "phone": "9000664016",
  "amount": {
    "currency": "INR",
    "value": 100
  },
  "mode": "IMPS",
  "status": "SCHEDULED",
  "message": "Payment instruction pending to be executed",
  "scheduledAt": "2025-07-05T16:05:00Z",
  "remarks": "Test transaction",
  "_links": [
    {
      "rel": "status",
      "href": "http://pluralqa.pinepg.in:8000/payouts/v2/payments?paymentReferenceId=txn-f9e00a80a357418d908a67bd30cdbc37"
    }
  ]
}

The table below lists the various parameters returned in the Update Scheduled Payout response object.

Parameter	Type	Description
clientReferenceId	`string`	Unique identifier to track the payout for your reference. Minimum length: `1` character. Maximum length: `40` characters. Must not contain spaces. Example: `430582f3-6e83-4cec-a3ab-72847fb9680f`
requestReferenceId	`string`	Unique identifier of the request in the Pine Labs Online database. Minimum length: `1` character. Maximum length: `50` characters. Example: `664816162868`
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`
payeeName	`string`	Name of the beneficiary’s bank account holder. Minimum length: `1` character. Maximum length: `40` characters. Allowed characters: alphabets and spaces only. Example: `Kevin Bob`
accountNumber	`string`	Account number of the beneficiary's bank. Minimum length: `9` digits. Maximum length: `18` digits. Example: `500012121313141415`
branchCode	`string`	Branch code of the beneficiary's bank. Maximum length: `11` characters. The first `4` characters must be alphabets (`A–Z`, `a–z`). The `5`th character must be `0`. The remaining characters (`6`th to last) can be alphanumeric (letters or digits). Example: `SBIN0011123`
vpa	`string`	VPA handle of the beneficiary's account. Example: `9876543210@examplebank`
email	`string`	Email address of the beneficiary's bank account holder. Has to be a valid Email address. Example: `[email protected]`
phone	`string`	Mobile number of the beneficiary's bank account holder. Has to be 10 numeric digits. Example: `9876543210`
amount	`object`	An object that contains the payout amount details. Learn more about our `amount` child object.
mode	`string`	Mode of payment through which you want to initiate a payout. Accepted values: `UPI` `IMPS` `NEFT` `RTGS` Example: `IMPS`
status	`string`	Payout status. Possible values: `SCHEDULED`: When the create payout request is successfully received by Pine Labs Online `PENDING`: When the funding account has insufficient balance to process the payout. `PROCESSING`: The request is successfully sent to the Bank, but the Bank has not yet processed the payout. `PROCESSED`: The bank has successfully processed the payout, but confirmation from the bank has not yet been received to Pine Labs Online. `SUCCESS`: When the transaction is successful, here the amount is debited from the payee account and credited to the beneficiary account. `FAILED`: When the transaction is failed.
message	`string`	Message corresponding to the payout status. Example: `Payment instruction scheduled for execution`
scheduledAt	`string`	Specifies the scheduled time for executing the payout. The value must be provided in UTC. Example: `2025-07-05T16:05:00Z`
remarks	`string`	Description or reference text for the transaction. Minimum length: `1` character. Maximum length: `50` characters. Supported Characters: `A-Z` `a-z` `0-9` `-` `space` Example: `Refund payment`
_links	`array of objects`	An array of objects that contains the links. Learn more about our `_links` child object.

Amount [Child Object]

The table below lists the various parameters in the amount child object. This object is part of the Update Scheduled Payout response object.

Parameter	Type	Description
value	`integer`	The transaction amount is Paisa. Minimum value: `100` (₹1). Maximum value: `100000000` (₹`10` lakh). Example: `100`
currency	`string`	Type of currency. Example: `INR`

_Links [Child Object]

The table below lists the various parameters in the _links child object. This object is part of the Update Scheduled Payout response object.

Parameter	Type	Description
rel	`string`
href	`string`

Cancel Scheduled Payout

Shown below is a sample responses of a Cancel Scheduled Payout API.

{
  "clientReferenceId": "0171c4c0-f50a-4151-b39b-63c87a3c0cd6",
  "requestReferenceId": "req-ba50808e45ce4d19a86988e7d90df3ad",
  "paymentReferenceId": "txn-b03ee63e412a4ecf88b6bdb08a6632c3",
  "payeeName": "Kevin Bob",
  "accountNumber": "*******1415",
  "branchCode": "SBIN0011123",
  "amount": {
    "currency": "INR",
    "value": 4900
  },
  "mode": "IMPS",
  "status": "SCHEDULED",
  "message": "Payment instruction scheduled for execution",
  "scheduledAt": "2025-07-16T10:26:06Z",
  "remarks": "REFUND",
  "_links": [
    {
      "rel": "status",
      "href": "http://pyt-instruction-service-dev.v2.pinepg.in/payouts/v3/payments?paymentReferenceId=txn-b03ee63e412a4ecf88b6bdb08a6632c3"
    }
  ]
}

The table below lists the various parameters returned in the Cancel Scheduled Payout response object.

Parameter	Type	Description
clientReferenceId	`string`	Unique identifier to track the payout for your reference. Minimum length: `1` character. Maximum length: `40` characters. Must not contain spaces. Example: `430582f3-6e83-4cec-a3ab-72847fb9680f`
requestReferenceId	`string`	Unique identifier of the request in the Pine Labs Online database. Minimum length: `1` character. Maximum length: `50` characters. Example: `664816162868`
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`
payeeName	`string`	Name of the beneficiary’s bank account holder. Minimum length: `1` character. Maximum length: `40` characters. Allowed characters: alphabets and spaces only. Example: `Kevin Bob`
accountNumber	`string`	Account number of the beneficiary's bank. Minimum length: `9` digits. Maximum length: `18` digits. Example: `500012121313141415`
branchCode	`string`	Branch code of the beneficiary's bank. Maximum length: `11` characters. The first `4` characters must be alphabets (`A–Z`, `a–z`). The `5`th character must be `0`. The remaining characters (`6`th to last) can be alphanumeric (letters or digits). Example: `SBIN0011123`
vpa	`string`	VPA handle of the beneficiary's account. Example: `9876543210@examplebank`
email	`string`	Email address of the beneficiary's bank account holder. Has to be a valid Email address. Example: `[email protected]`
phone	`string`	Mobile number of the beneficiary's bank account holder. Has to be 10 numeric digits. Example: `9876543210`
amount	`object`	An object that contains the payout amount details. Learn more about our `amount` child object.
mode	`string`	Mode of payment through which you want to initiate a payout. Accepted values: `UPI` `IMPS` `NEFT` `RTGS` Example: `IMPS`
status	`string`	Payout status. Possible values: `SCHEDULED`: When the create payout request is successfully received by Pine Labs Online `PENDING`: When the funding account has insufficient balance to process the payout. `PROCESSING`: The request is successfully sent to the Bank, but the Bank has not yet processed the payout. `PROCESSED`: The bank has successfully processed the payout, but confirmation from the bank has not yet been received to Pine Labs Online. `SUCCESS`: When the transaction is successful, here the amount is debited from the payee account and credited to the beneficiary account. `FAILED`: When the transaction is failed.
message	`string`	Message corresponding to the payout status. Example: `Payment instruction scheduled for execution`
scheduledAt	`string`	Specifies the scheduled time for executing the payout. The value must be provided in UTC. Example: `2025-07-05T16:05:00Z`
remarks	`string`	Description or reference text for the transaction. Minimum length: `1` character. Maximum length: `50` characters. Supported Characters: `A-Z` `a-z` `0-9` `-` `space` Example: `Refund payment`
_links	`array of objects`	An array of objects that contains the links. Learn more about our `_links` child object.

Amount [Child Object]

The table below lists the various parameters in the amount child object. This object is part of the Cancel Scheduled Payout response object.

Parameter	Type	Description
value	`integer`	The transaction amount is Paisa. Minimum value: `100` (₹1). Maximum value: `100000000` (₹`10` lakh). Example: `100`
currency	`string`	Type of currency. Example: `INR`

_Links [Child Object]

The table below lists the various parameters in the _links child object. This object is part of the Cancel Scheduled Payout response object.

Parameter	Type	Description
rel	`string`
href	`string`