Create a payment link for a document
X-Api-Key<token>
Business API key, e.g. vuz_ab12cdef... Created via Settings → Integrations → API Keys. Unlike partner keys, a public API key's STRING does not encode its environment — isolation instead comes from a completely separate sandbox database: a key minted on the Sandbox server (above) only ever reads/writes sandbox data and can never see or affect production, regardless of what the key looks like.
In: header
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
curl -X POST "https://example.com/payment-links" \ -H "Content-Type: application/json" \ -d '{ "type": "invoice", "documentId": "550e8400-e29b-41d4-a716-446655440000", "documentNumber": "INV-2025-001", "documentType": "invoice", "amount": 150.5 }'{ "id": "550e8400-e29b-41d4-a716-446655440000", "url": "https://pay.vuz.co.il/550e8400-e29b-41d4-a716-446655440000", "shortUrl": "string", "type": "invoice", "status": "active", "amount": 1170, "currency": "ILS", "expiresAt": "2025-01-22T00:00:00.000Z", "createdAt": "2025-01-15T10:30:00.000Z", "sourceDocumentId": "string", "sourceDocumentNumber": "Invoice #12345", "sourceDocumentType": "tax_invoice", "qrCodeBase64": "string"}