Skip to main content
Processors are merchants who accept NFC card payments via POS terminals. Each processor gets API credentials for integration.

​
Processor Lifecycle

1

Registration

Admin creates processor with business details
2

Credentials Issued

API key and HMAC secret generated for POS integration
3

Processing Payments

Processor accepts card payments via POS terminal
4

Funds Settlement

Processor can transfer funds or request reclaim

​
Endpoints

Create Processor

POST /api/v1/processorsRegister new processor with credentials

Get Processor

GET /api/v1/processors/:idRetrieve processor details

List Processors

GET /api/v1/processorsList all processors with pagination

Suspend Processor

POST /api/v1/processors/:id/suspendSuspend processor from processing

Transfer Funds

POST /api/v1/processors/:id/transferTransfer to subscriber account

Transaction History

GET /api/v1/processors/:id/transactionsView processor transaction history

Request Reclaim

POST /api/v1/processors/:id/reclaim - Submit fund withdrawal request for admin review

​
API Credentials

When a processor is created, they receive:

API Key

olive_pos_live_xxxxxFor POS terminal authentication

HMAC Secret

secret_xxxxxFor signing requests

Dashboard Login

Email + password for web dashboard
API key and HMAC secret are only shown once at creation. Store them securely!

​
Processor Status

StatusDescription
activeCan process payments normally
Can login to dashboard
Can transfer/reclaim funds

​
Reclaim Flow

Processors can request to withdraw funds from their account:
1

Submit Request

Processor submits reclaim request with amount
2

Pending Review

Request status is pending
3

Admin Review

Admin approves or rejects request
4

Funds Transferred

On approval, funds transferred to designated account

​
Response Examples

{
  "success": true,
  "processor_id": "proc_abc123",
  "message": "Processor created successfully",
  "api_key_id": "key_xyz789",
  "api_key": "olive_pos_live_xxxxxx",
  "hmac_secret": "secret_xxxxxx",
  "warning": "Save credentials - they won't be shown again!"
}

​
Integration

POS Integration Guide

Complete guide for integrating POS terminals

API Authentication

Learn about API key and HMAC authentication