Create Payout

Use this API to create a Individual Payout.

Environment

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

EnvironmentEndpoints
User Acceptance Testing [UAT]https://plural-uat.v2.pinepg.in/payouts/v3/payments/banks
Production [PROD]https://api.pluralpay.in/payouts/v3/payments/banks
Body Params
string
required

Enter a unique identifier to track the payout.

  • Minimum length: 1 character.
  • Maximum length: 40 characters.
  • Must not contain spaces.
Example: 430582f3-6e83-4cec-a3ab-72847fb9680f

string
required

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

string

Email address of the beneficiary's bank account holder.

Has to be a valid Email address.

Example: [email protected]

string

Mobile number of the beneficiary's bank account holder.

Has to be 10 numeric digits.

Example: 9876543210

string

Mandatory for IMPS, NEFT, and RTGS transactions.

Account number of the beneficiary's bank.

  • Minimum length: 9 digits.
  • Maximum length: 18 digits.
.Example: 505012121313141415

string

Mandatory for IMPS, NEFT, and RTGS transactions.

Branch code of the beneficiary's bank.

  • Maximum length: 11 characters.
  • The first 4 characters must be alphabets (A–Z, a–z).
  • The 5th character must be 0.
  • The remaining characters (6th to last) can be alphanumeric (letters or digits).
Example: SBIN0011123

amount
object
required

An object that contains the payout amount details.

string
required

Mode of payment through which you want to initiate a payout.

Accepted values:

  • UPI
  • IMPS
  • NEFT
  • RTGS
Example: IMPS

string
required

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

Headers
string
Defaults to application/json

The type of content included in the HTTP message body.

Possible value: application/json.

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.

string

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

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

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
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json
Ask AI
Assistant
Order Lifecycle
Refunds
Settlements
Checkout
Dashboard
International Payments
How do I implement webhook notifications for payment status updates, and what's the recommended way to verify webhook authenticity?
How do I integrate Pine Labs payment gateway with my React Native mobile app and what are the required API credentials?
Can I customize the payment UI for card transactions, and what parameters can I pass to modify the checkout experience for my customers?
Assistant