Skip to main content
The POS API enables Smart PAY terminals to accept payments using OLIVE NFC cards. It provides endpoints for card verification, payment processing, and refunds.

​
Features

Card Verification

Instantly verify card status and balance before purchase

NFC Payments

Process secure offline-first or online NFC transactions

Smart Routing

Route transactions to correct subscriber wallet

Refunds

Process full or partial refunds directly from terminal

​
Endpoints

Process Payment

POST /api/v1/pos/paymentExecute a payment transaction

Verify Card

POST /api/v1/pos/verify-cardCheck card validity and name

Refund

POST /api/v1/pos/refundRefund a transaction

Lookup Card

POST /api/v1/pos/lookup-cardGet card details (Admin/Support)

​
Payment Flow

1

Tap Card

Customer taps NFC card on Smart PAY terminal
2

Verify

Terminal calls verify-card to check status and prompt for PIN
3

Authorize

Customer enters PIN on terminal
4

Process

Terminal calls payment with encrypted PIN and amount
5

Receipt

Transaction approved, terminal prints receipt

​
Security

POS endpoints are strictly restricted to authorized merchant terminals and require specific API keys.
  • Merchant ID: Every request must include the registered Merchant ID.
  • Processor ID: Validates the specific terminal device.
  • Encryption: PINs must be encrypted before transmission (in production).

​
Integration Status

Online

Real-time processing

Offline

Store and forward (coming soon)

Sandbox

Test environment available