Business payouts
Send funds with a traceable payout workflow.
Initiate payouts to beneficiary bank accounts, monitor the current status and keep operational visibility through your BudyPay merchant account.
Payout API
A practical flow for beneficiary bank payouts.
The documented payout endpoint accepts beneficiary and transaction details together with your merchant key, order ID and a secure HMAC hash.
Create payout request
Build the request using a unique merchant order ID and beneficiary bank details.
Authenticate securely
Generate the request hash with HMAC SHA-256 and your merchant secret.
Track outcome
Use the payout status API and callbacks to update your internal records.
Initiate payout
Send the exact beneficiary and order data your operations rely on.
- Beneficiary name and bank account
- Required beneficiary banking details from the API documentation
- Amount and payout description
- Unique order ID from your system
- Merchant key and HMAC SHA-256 hash
StartPayout
POST https://pg.budypay.com/StartPayout/initiate_payout
{
"name": "Beneficiary Name",
"amount": "100.00",
"bank_account": "1234567890",
"merchant_key": "YOUR_KEY",
"order_id": "PAYOUT1001",
"hash": "HMAC_SHA256_HASH"
}Status model
Design your payout logic around explicit status states.
The BudyPay payout documentation lists these status values for payout processing.
| Status | Meaning | Recommended merchant action |
|---|---|---|
| Success | Payout completed successfully. | Mark the payout complete and store the available transaction reference. |
| Pending | Payout is still being processed. | Keep the payout open and wait for a callback or perform a later status check. |
| Failed | Payout failed due to an error. | Record the failure and decide whether your business flow permits a retry. |
Operations visibility
Check payout balance and status from the same API family.
The documented Payout Balance and Payout Status endpoints help your backend confirm available operational balance and fetch the latest payout state.
