# Vendor Payout Initiate a commission payout to a vendor. This triggers a transfer of earned commissions to the vendor's registered bank account. ## Request ### Headers ### Path Parameters ### Body Parameters ## Response ### Success (201 Created) ```json { "success": true, "data": { "payoutId": "pyt_n4o5p6q7r8s9t0u1", "vendorId": "vnd_a1b2c3d4e5f6g7h8", "amount": 5312.50, "currency": "USD", "status": "processing", "paymentMethod": "wire", "commissionsIncluded": 12, "bankDetails": { "bankName": "First National Bank", "beneficiaryName": "Acme Referrals LLC", "accountNumber": "****6789" }, "adminNotes": "Q1 2024 commission payout", "environment": "production", "initiatedAt": "2024-03-21T16:00:00.000Z", "estimatedArrival": "2024-03-24T16:00:00.000Z" }, "message": "Vendor payout initiated successfully", "error": null, "meta": { "request_id": "req_xxxxx", "timestamp": "2024-03-21T16:00:00.000Z", "processing_time_ms": 250, "api_version": "v1", "endpoint": "POST /vendors/:id/payouts", "user_type": "merchant" } } ``` ### Error Responses ## Examples ```bash curl -X POST https://api.zenpayz.com/merchant/api/v1/vendors/vnd_a1b2c3d4e5f6g7h8/payouts \ -H "Authorization: Bearer zp_test_xxxxx" \ -H "X-Timestamp: 2024-03-21T16:00:00.000Z" \ -H "X-Signature: a1b2c3d4e5f6..." \ -H "X-Secret-Salt: your_secret_salt" \ -H "Content-Type: application/json" \ -d '{ "amount": 5312.50, "currency": "USD", "paymentMethod": "wire", "adminNotes": "Q1 2024 commission payout", "environment": "production" }' ``` ```javascript const response = await fetch('https://api.zenpayz.com/merchant/api/v1/vendors/vnd_a1b2c3d4e5f6g7h8/payouts', { method: 'POST', headers: { 'Authorization': `Bearer ${apiKey}`, 'X-Timestamp': timestamp, 'X-Signature': signature, 'X-Secret-Salt': secretSalt, 'Content-Type': 'application/json', }, body: JSON.stringify({ amount: 5312.50, currency: 'USD', paymentMethod: 'wire', adminNotes: 'Q1 2024 commission payout', environment: 'production', }), }); const result = await response.json(); console.log(result.data.payoutId); // pyt_n4o5p6q7r8s9t0u1 console.log(result.data.status); // processing ``` ```javascript const payout = await zenpays.vendors.createPayout('vnd_a1b2c3d4e5f6g7h8', { amount: 5312.50, currency: 'USD', paymentMethod: 'wire', adminNotes: 'Q1 2024 commission payout', environment: 'production', }); console.log(payout.payoutId); // pyt_n4o5p6q7r8s9t0u1 console.log(payout.status); // processing ``` ## Related Endpoints - [Vendor Commissions](/docs/rest-api/endpoints/vendors/vendor-commissions) - [Get Vendor](/docs/rest-api/endpoints/vendors/get-vendor) - [Vendor Analytics](/docs/rest-api/endpoints/vendors/vendor-analytics)