# Create Vendor Referral Create a new referral record linking a merchant to a vendor for commission tracking. ## Request ### Headers ### Path Parameters ### Body Parameters ## Response ### Success (201 Created) ```json { "success": true, "data": { "referralId": "ref_j0k1l2m3n4o5p6q7", "vendorId": "vnd_a1b2c3d4e5f6g7h8", "merchantId": "mer_m3n4o5p6q7r8s9t0", "referralCode": "ACME-2024-003", "referralSource": "partner_portal", "status": "active", "commissionRate": 15.0, "totalTransactions": 0, "totalRevenue": 0, "totalCommission": 0, "environment": "production", "notes": "Enterprise client referred at FinTech Summit 2024", "createdAt": "2024-03-21T11:00:00.000Z", "updatedAt": "2024-03-21T11:00:00.000Z" }, "message": "Vendor referral created successfully", "error": null, "meta": { "request_id": "req_xxxxx", "timestamp": "2024-03-21T11:00:00.000Z", "processing_time_ms": 130, "api_version": "v1", "endpoint": "POST /vendors/:id/referrals", "user_type": "merchant" } } ``` ### Error Responses ## Examples ```bash curl -X POST https://api.zenpayz.com/merchant/api/v1/vendors/vnd_a1b2c3d4e5f6g7h8/referrals \ -H "Authorization: Bearer zp_test_xxxxx" \ -H "X-Timestamp: 2024-03-21T11:00:00.000Z" \ -H "X-Signature: a1b2c3d4e5f6..." \ -H "X-Secret-Salt: your_secret_salt" \ -H "Content-Type: application/json" \ -d '{ "merchantId": "mer_m3n4o5p6q7r8s9t0", "referralCode": "ACME-2024-003", "referralSource": "partner_portal", "commissionRate": 15.0, "environment": "production", "notes": "Enterprise client referred at FinTech Summit 2024" }' ``` ```javascript const response = await fetch('https://api.zenpayz.com/merchant/api/v1/vendors/vnd_a1b2c3d4e5f6g7h8/referrals', { method: 'POST', headers: { 'Authorization': `Bearer ${apiKey}`, 'X-Timestamp': timestamp, 'X-Signature': signature, 'X-Secret-Salt': secretSalt, 'Content-Type': 'application/json', }, body: JSON.stringify({ merchantId: 'mer_m3n4o5p6q7r8s9t0', referralCode: 'ACME-2024-003', referralSource: 'partner_portal', commissionRate: 15.0, environment: 'production', notes: 'Enterprise client referred at FinTech Summit 2024', }), }); const result = await response.json(); console.log(result.data.referralId); // ref_j0k1l2m3n4o5p6q7 ``` ```javascript const referral = await zenpays.vendors.createReferral('vnd_a1b2c3d4e5f6g7h8', { merchantId: 'mer_m3n4o5p6q7r8s9t0', referralCode: 'ACME-2024-003', referralSource: 'partner_portal', commissionRate: 15.0, environment: 'production', notes: 'Enterprise client referred at FinTech Summit 2024', }); console.log(referral.referralId); // ref_j0k1l2m3n4o5p6q7 ``` ## Related Endpoints - [Vendor Referrals](/docs/rest-api/endpoints/vendors/vendor-referrals) - [Vendor Commissions](/docs/rest-api/endpoints/vendors/vendor-commissions) - [Get Vendor](/docs/rest-api/endpoints/vendors/get-vendor)