Overview
The education PIN endpoint lets you purchase result-checker and exam registration scratch cards (WAEC, NECO, JAMB, etc.) in bulk or one at a time.
Fetch exam product names from Get products (service=EXAM PIN or the matching service name from your catalog), then call purchase directly.
Authentication
Requires your merchant API key and the channel: API header.
Authorization: Bearer dcy_live_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
channel: API
Purchase education PIN
POST /api/v1/education-pin/purchase
Request body
| Field | Type | Required | Description |
|---|
exam_name | string | ✓ | Exam product name from catalog |
quantity | number | ✓ | Number of PINs (1–5; JAMB must be 1) |
examNumber | string | | Required for JAMB purchases |
customerRef | string | | Your internal reference ID |
promocode | string | | Discount promo code |
curl -sS -X POST "https://api.dancity.app/api/v1/education-pin/purchase" \
-H "Authorization: Bearer $DANCITY_API_KEY" \
-H "Content-Type: application/json" \
-H "channel: API" \
-d '{
"exam_name": "WAEC Result Checker",
"quantity": 1,
"customerRef": "EDU-REF-001"
}'
Full purchase flow
1. GET /api/v1/products?service=EXAM PIN
→ pick exam_name and note unit price
2. POST /api/v1/education-pin/purchase
{ exam_name, quantity }
→ receive PIN details in the transaction response
Education PINs are delivered immediately. Store them securely — they cannot be re-fetched from the API after the transaction response is received.
Next steps
