Quickstart

Integrate your POS in minutes. Follow these five steps to authenticate, submit a sale, and confirm BIR EIS acknowledgment.

1. Get your API key

   Obtain a Vendor API key from your vendor administrator in the EIS Bridge Console. API keys are issued to registered POS/ERP vendors during onboarding. You will also receive merchant_code, branch_code, and pos_device_id for test accounts.

   Get API Key →

2. Set BASE_URL and headers

   Use the Sandbox environment for development. Sandbox credentials are issued during vendor onboarding. Every request requires your API key and JSON content type.

   Environment & headers

   # Sandbox (development)
   export BASE_URL="https://sandbox.eisbridge.com/v1"
   export API_KEY="YOUR_VENDOR_API_KEY"
   
   # Production
   # export BASE_URL="https://api.eisbridge.com/v1"
   
   curl -X GET "$BASE_URL/transactions?page=1&page_size=1" \
     -H "Authorization: Bearer $API_KEY" \
     -H "Content-Type: application/json"

3. POST /transactions

   Submit a single sale wrapped in a transaction object. Use the Standard Sale Object format documented in the Data Model.

   Request

   curl -X POST "$BASE_URL/transactions" \
     -H "Authorization: Bearer $API_KEY" \
     -H "Content-Type: application/json" \
     -d '{
     "transaction": {
       "transaction_id": "POS-10001",
       "transaction_datetime": "2026-06-07T14:23:55+08:00",
       "merchant_code": "MRC123",
       "branch_code": "BR001",
       "pos_device_id": "POS01",
       "invoice_type": "OR",
       "items": [
         {
           "sku": "SKU001",
           "description": "Product A",
           "qty": 1,
           "unit_price": 100
         }
       ],
       "totals": {
         "gross": 100,
         "net": 100
       },
       "payment": {
         "method": "CASH",
         "amount": 100
       }
     }
   }'

   Response

   {
     "status": "accepted",
     "transaction_id": "POS-10001",
     "bridge_transaction_id": "EB-20260607-000001",
     "merchant_code": "MRC123",
     "branch_code": "BR001",
     "pos_device_id": "POS01",
     "processing_status": "queued",
     "message": "Transaction accepted for EIS processing."
   }

   Store bridge_transaction_id in your POS for status lookups and webhook correlation.

4. GET transaction status

   Poll until BIR EIS processing completes, or configure webhooks for push notifications.

   Request

   curl -X GET "$BASE_URL/transactions/EB-20260607-000001" \
     -H "Authorization: Bearer $API_KEY"

   Response

   {
     "bridge_transaction_id": "EB-20260607-000001",
     "transaction_id": "POS-10001",
     "merchant_code": "MRC123",
     "branch_code": "BR001",
     "pos_device_id": "POS01",
     "processing_status": "sent",
     "eis_status": "acknowledged",
     "eis_reference_no": "EIS-INV-20260607-123456",
     "last_update": "2026-06-07T14:25:10+08:00"
   }

5. Done — EIS acknowledged

   When eis_status is acknowledged, BIR EIS has accepted the invoice. Persist eis_reference_no for audit and customer receipts. The merchant must hold valid EIS CERT and PTT per BIR for live compliance.

   Next: run the QA test suite, explore batch submit and webhooks, or download the Postman collection.