Processors
Processors are merchants who accept NFC card payments via POS terminals. Each processor gets API credentials for integration.
Processor Lifecycle
Admin creates processor with business details
API key and HMAC secret generated for POS integration
Processor accepts card payments via POS terminal
Processor can transfer funds or request reclaim
Endpoints
POST /api/v1/processors
Register new processor with credentials
GET /api/v1/processors/:id
Retrieve processor details
GET /api/v1/processors
List all processors with pagination
POST /api/v1/processors/:id/suspend
Suspend processor from processing
POST /api/v1/processors/:id/transfer
Transfer to subscriber account
GET /api/v1/processors/:id/transactions
View processor transaction history
POST /api/v1/processors/:id/reclaim - Submit fund withdrawal request for admin review
API Credentials
When a processor is created, they receive:
olive_pos_live_xxxxx
For POS terminal authentication
secret_xxxxx
For signing requests
Email + password for web dashboard
API key and HMAC secret are only shown once at creation. Store them securely!
Processor Status
| Status | Description |
|---|---|
active | Can process payments normally |
| Can login to dashboard | |
| Can transfer/reclaim funds |
Reclaim Flow
Processors can request to withdraw funds from their account:
Processor submits reclaim request with amount
Request status is pending
Admin approves or rejects request
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!"
}