Build with Payport

Payport is a payment management platform that wraps Paystack to give you a clean API and a rich dashboard. You initialize a payment from your app, redirect your user to the Paystack checkout, and Payport handles the rest — verifying the transaction, recording it, and notifying your server via a callback.

Open the Payport URL provided to you in a browser and sign in with your credentials. If you are accessing a demo environment, use the credentials below.

Every API request requires an API key. Keys are created inside the dashboard under Settings → API Keys (requires the manage-api-keys permission — Super Admin has this by default).

Generating a key

Managing keys

The Your API Keys table lists all keys you have created. Each entry shows a key prefix (e.g. bpt_…), label, postback URL, creation date, and last used date. Click Revoke to permanently disable a key.

All payment API endpoints require your API key. There are two equivalent methods — use whichever fits your stack:

Creates a Paystack transaction and a local payment record. Returns a payment_url which you redirect the payer to for checkout.

Required fields

Optional fields

Example request

POST /api/payments/initialize HTTP/1.1
Host: your-payport-domain.com
Content-Type: application/json
X-API-Key: YOUR_API_KEY

{
  "matric_no":    "ATA1000110",
  "studentname":  "Jane Doe",
  "amount":       10000,
  "refno":        "RCP-2025-001",
  "session":      "2024/2025",
  "programme":    "B.Sc Computer Science",
  "email":        "jane@example.com",
  "paymentfor":   "School fees"
}

Success response — 201 Created

{
  "payment_url":     "https://checkout.paystack.com/...",
  "reference":       "BPT-XXXXXXXXXX",
  "access_code":     "...",
  "amount":          10000,
  "receipt_number":  "RCP-2025-001"
}

Error responses

Checks the payment status with Paystack. If successful, marks the local payment as Paid and returns the amount and student identifier.

Example request

GET /api/payment/verify-payment?reference=BPT-XXXXXXXXXX HTTP/1.1
Host: your-payport-domain.com
X-API-Key: YOUR_API_KEY

Success response

{
  "status":   "success",
  "message":  "Payment verified successfully",
  "data": {
    "amount_paid":  10000.0,
    "student":      "ATA1000110"
  }
}

{
  "status":   "failed",
  "message":  "Payment not confirmed.",
  "data": {
    "amount_paid":  0,
    "student":      "ATA1000110"
  }
}

Error responses

Use Requery when a payment may have been completed on Paystack but the local record hasn't been updated yet (e.g. due to webhook delay). If Paystack confirms success, the payment is marked Paid.

Example request

GET /api/payment/requery-payment?reference=BPT-XXXXXXXXXX HTTP/1.1
Host: your-payport-domain.com
X-API-Key: YOUR_API_KEY

Responses

When a payment is confirmed, Payport sends a POST request to your configured callback URL. Set it on your API key in Settings → API Keys, or pass postback_url per-request in the Initialize body.

Payload fields

Example callback payload

{
  "payment_id":         123,
  "reference":          "BPT-XXXXXXXXXX",
  "receipt_number":     "RCP-2025-001",
  "status":             "Paid",
  "amount":             10000,
  "amount_paid":        10000,
  "balance_due":        0,
  "payment_date":       "14-03-2025 02:30:45 PM",
  "matric_no":          "ATA1000110",
  "studentname":        "Jane Doe",
  "session":            "2024/2025",
  "programme":          "B.Sc Computer Science",
  "email":              "jane@example.com",
  "paymentfor":         "School fees",
  "paystack_verified":  true,
  "paystack_status":    "success",
  "metadata": {
    "responseCode":   "0000",
    "isSuccessful":  true,
    "error":         null
  }
}

After logging in, the sidebar gives you access to the following pages based on your assigned permissions:

Profile

Go to Settings → Profile to update your name and email. All changes are recorded in the audit log.

Password

Go to Settings → Password. Enter your current password, then the new password and its confirmation. Use a strong, unique password.

Go to Settings → Two-Factor Auth. Once enabled, you will need both your password and a time-based code from an authenticator app (e.g. Google Authenticator) to sign in.

To disable 2FA, go to the same page and confirm using your current 2FA code or recovery codes.

Payport tracks every significant action — logins, API key creation and revocation, profile updates, 2FA changes, and file downloads.