Invoicing ও finance

Ecommerce ও SaaS payment-এর জন্য Receipt PDF API

QR code, barcode, PDF/A setting এবং repeatable template output-সহ order, payment, tax ও refund data থেকে receipt PDF তৈরি করুন।

প্রাথমিক API JSON Render
Endpoint /api/v1/pdf/render
System ecommerce backend / billing backend / SaaS platform / POS export service
যে কাজটি করতে হবে

প্রতিটি caller-কে PDF drawing code own করতে না দিয়ে completed order, payment, refund এবং tax data-কে এমন receipt PDF-এ রূপান্তর করুন যা email, store, print বা customer account-এ attach করা যায়।

কখন এই API ব্যবহার করবেন

  • আপনার system payment status, receipt number, tax line এবং customer data আগে থেকেই own করে।
  • Email, account history, support workflow বা audit export-এর জন্য receipt PDF দরকার।
  • Lookup, refund বা pickup flow-এর জন্য receipt-এর ভিতরে QR code বা barcode চান।
  • Layout approved হওয়ার পরে stable receipt template দরকার।

এটি কী replace করে না

  • Payment processing বা refund execution দরকার। gPdf receipt render করে; money movement আপনার payment system own করে।
  • Legal e-invoice packaging দরকার। Factur-X বা ZUGFeRD output-এর জন্য E-Invoice Render endpoint ব্যবহার করুন।
  • POS hardware control বা cash drawer logic দরকার।

কোন endpoint call করবেন

প্রাথমিক

/api/v1/pdf/render

JSON Render এই workflow-এর default path।

সহায়ক 1

/api/v1/template-render

Workflow-তে related API path, template contract অথবা capabilities lookup দরকার হলে ব্যবহার করুন।

নূন্যতম request

POST /api/v1/pdf/render - lookup QR code-সহ compact receipt।

{
  "pages": [
    {
      "size": "a6",
      "elements": [
        {
          "type": "text",
          "x": 10,
          "y": 12,
          "content": "Receipt R-2026-1001",
          "style": { "font_size": 16, "font_family": "NotoSans-Regular" }
        },
        {
          "type": "text",
          "x": 10,
          "y": 28,
          "content": "Order total: $82.40\nPaid by card ending 4242\nTax: $6.10",
          "style": { "font_size": 10, "font_family": "NotoSans-Regular" }
        },
        {
          "type": "barcode",
          "format": "qrcode",
          "content": "https://example.com/receipts/R-2026-1001",
          "x": 10,
          "y": 58,
          "width": 28,
          "height": 28
        }
      ]
    }
  ]
}

gPdf কী করে

  • JSON Render payload থেকে receipt page rendering।
  • Text, total, item line, QR code, barcode, metadata এবং optional PDF/A setting।
  • একই receipt layout reuse হলে Template Render binding।
  • Successful render-এ binary PDF output; failure হলে shared gPdf error envelope।

আপনার system-এর দায়িত্ব

  • Payment authorization, capture, refund, tax calculation এবং receipt numbering।
  • Customer identity, order state, currency formatting এবং retention policy।
  • Email delivery, account storage এবং duplicate receipt handling।

Production checklist

  1. Stable receipt number ব্যবহার করুন এবং প্রতিটি render-এর সাথে X-Request-Id পাঠান।
  2. Receipt source data থেকে regenerate হবে নাকি প্রথম render-এর পরে store হবে তা ঠিক করুন।
  3. Long item name, refund, discount, multi-tax line এবং zero-value order test করুন।
  4. Support ও finance team layout approve করলে Template Render-এ switch করুন।
  5. Payment ও tax decision rendering request-এর বাইরে রাখুন।

দাবির সীমা

  • gPdf payment process করে না, tax calculate করে না বা refund issue করে না।
  • Receipt PDF নিজে থেকে legal e-invoice হয়ে যায় না।
  • Business truth আপনার system own করে; gPdf তার PDF representation render করে।

Receipt PDF হলো rendering output

এটি আলাদা payment বা POS endpoint নয়। আপনার ecommerce, billing বা POS backend decide করে যে receipt আছে, তারপর receipt content gPdf-এ DocumentRequest হিসেবে বা published template-এর data হিসেবে পাঠায়।

Rendering layer deterministic থাকা উচিত। Support agent একই receipt আবার চাইলে আপনার system retention policy অনুযায়ী source data replay করতে পারে বা আগে stored PDF return করতে পারে।

Repeated receipt-এর জন্য template path

Receipt layout সাধারণত দ্রুত stabilize হয়। Design approved হলে template publish করুন এবং receipt field দিয়ে POST /api/v1/template-render call করুন। এতে payment system data-তে focus করে এবং layout ownership এক জায়গায় থাকে।

FAQ

gPdf কি receipt total calculate করতে পারে?
না। Total, discount, tax এবং refund state আপনার payment বা commerce system own করে। gPdf আপনার পাঠানো value render করে।
Receipt কি JSON Render নাকি Template Render ব্যবহার করবে?
Layout design করার সময় JSON Render ব্যবহার করুন। Receipt layout ও field contract stable হলে Template Render ব্যবহার করুন।
Receipt-এ কি QR code থাকতে পারে?
হ্যাঁ। gPdf PDF output-এ QR code barcode element support করে। QR code-এ encoded URL বা payload আপনার system own করে।
এটি কি e-invoice API-এর মতো?
না। সাধারণ receipt PDF JSON Render বা Template Render ব্যবহার করে। Factur-X এবং ZUGFeRD packaging E-Invoice Render endpoint ব্যবহার করে।