Bulkpe Payouts
Initiate Payout
Use this API to initiate an amount transfer from your Bulkpe Virtual Account / Current Account / Escrow Account to a beneficiary bank account or UPI VPA.
Send your API key as Authorization: Bearer <key>. See Authorization.
When a payout is initiated, Bulkpe processes it with the partner bank.
- If the bank completes the transaction instantly, you’ll get the final status (
SUCCESSorFAILED) in the sync response. - If the response shows
PENDING, you’ll later receive a callback from Bulkpe once the status updates (e.g.,PENDING→SUCCESSorFAILED). To set up callback, refer to this page. - If the payout fails, refer to the
messagefield for the reason and retry if needed. - You can also use the Fetch Transaction Status API anytime to check the current status of the payout.
- For more details around key things to handle, refer to this page.
Request
Body
amountnumberMandatoryAmount to send, in rupees. Must be within the limits of the chosen payment_mode.
Example
1account_numberstringConditionalBeneficiary bank account number. Required for IMPS, NEFT and RTGS; not needed for UPI.
Example
77220000000001payment_modestringMandatoryRail to send the payout on: IMPS, NEFT, RTGS or UPI.
Example
UPIreference_idstringMandatoryYour unique ID for this payout. Used to match callbacks and check status.
Example
Payout-test6transaction_notestringOptionalShort remark added to the payment, shown in the beneficiary’s statement.
Example
Refund03beneficiaryNamestringMandatoryName of the beneficiary account holder.
Example
Your Beneficiary NameifscstringConditionalIFSC of the beneficiary’s bank branch. Required for IMPS, NEFT and RTGS; not needed for UPI.
Example
FDRL0007777upistringConditionalBeneficiary UPI ID. Required only when payment_mode is UPI.
Example
dummyUPI@yesbankcontact_idstringOptionalSaved contact to pay. Use it instead of passing bank or UPI details each time.
Response
Fields inside data. Full examples are in the response panel.
beneCodestringbeneNamestringExample
namebeneAccNumstringExample
77220000000001beneIfscCodestringExample
FDRL0007777beneAcTypenumberExample
10transaction_idstringExample
TRAREF00034637453reference_idstringExample
Internal1718712497amountnumberExample
1payment_remarkstringExample
From Peid Piper using Bulkpe - Refund03payment_modestringExample
IMPSstatusstringExample
PENDINGutrstringmessagestringExample
Transaction Initiated!
Payment Method Limits
| Payment Method | Minimum Amount | Maximum Amount | Day / Month Limit |
|---|---|---|---|
| IMPS | 1 | 500000 | No Limit |
| NEFT | 1 | No Limit | No Limit |
| RTGS | 200000 | No Limit | No Limit |
| UPI | 1 | 100000 | No Limit |
There is no daily or monthly limit on number of payouts.