The ProofPay API is a RESTful backend service for managing payment proof submissions and verification workflows. It is designed for agencies that need to track client payments across projects, with role-based access for admins and clients.
\nhttps://proofpay-api.vercel.app\nAll protected endpoints require a JWT Bearer token, obtained via the Login endpoint. Include it in the Authorization header:
Authorization: Bearer <token>\nCreates a new agency
\n","urlObject":{"protocol":"https","path":["agencies"],"host":["proofpay-api","vercel","app"],"query":[],"variable":[]}},"response":[],"_postman_id":"9d1f0b86-dd5b-4956-8cb1-c50a94cf727e"}],"id":"1572b62d-ef38-4238-8ef8-c117b23e37cf","description":"Manages agency-level operations within the ProofPay platform. This folder currently covers the creation of new agencies, which serve as the top-level organizational unit under which teams, projects, and payments are scoped.
\n","_postman_id":"1572b62d-ef38-4238-8ef8-c117b23e37cf"},{"name":"AUTH","item":[{"name":"Register User","id":"b81299d9-8252-4316-abad-e5391ac25ab5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"email\": \"user@gmail.com\",\r\n \"password\": \"123456\",\r\n \"role\": \"admin\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://proofpay-api.vercel.app/auth/register","description":"Creates a new user (admin or client)
\n","urlObject":{"protocol":"https","path":["auth","register"],"host":["proofpay-api","vercel","app"],"query":[],"variable":[]}},"response":[],"_postman_id":"b81299d9-8252-4316-abad-e5391ac25ab5"},{"name":"Login User","id":"c7bc9eec-6abb-43f8-a6a8-9085c2e3807e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"email\": \"user@gmail.com\",\r\n \"password\": \"123456\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://proofpay-api.vercel.app/auth/login","description":"Authenticates user and returns JWT token
\n","urlObject":{"protocol":"https","path":["auth","login"],"host":["proofpay-api","vercel","app"],"query":[],"variable":[]}},"response":[],"_postman_id":"c7bc9eec-6abb-43f8-a6a8-9085c2e3807e"}],"id":"0da51f93-3545-4b70-a2f6-d306752e791d","description":"Handles user authentication for the ProofPay API. This folder covers account registration for both admin and client roles, as well as login functionality that returns a JWT token used to authorize subsequent requests.
\n","_postman_id":"0da51f93-3545-4b70-a2f6-d306752e791d"},{"name":"TEAM","item":[{"name":"Add Team Member","id":"b87d1060-3a8a-447d-9829-23a3054a6763","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"Adds a user to an agency team with a role
\n","urlObject":{"protocol":"https","path":["team"],"host":["proofpay-api","vercel","app"],"query":[],"variable":[]}},"response":[],"_postman_id":"b87d1060-3a8a-447d-9829-23a3054a6763"}],"id":"2971e599-a617-4c8e-a6ed-74e9a1a8158c","description":"Manages team membership within an agency. This folder covers adding users to an agency team and assigning them a role, enabling role-based access control across the ProofPay platform.
\n","_postman_id":"2971e599-a617-4c8e-a6ed-74e9a1a8158c"},{"name":"PROJECTS","item":[{"name":"Create Project","id":"e2973e96-4885-477e-a51a-6f5061d42f8d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"Creates a project under the current agency
\n","urlObject":{"protocol":"https","path":["projects"],"host":["proofpay-api","vercel","app"],"query":[],"variable":[]}},"response":[],"_postman_id":"e2973e96-4885-477e-a51a-6f5061d42f8d"},{"name":"Create Project","id":"76481fea-8011-4736-bcdb-6f21a08b537f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"Returns all projects for the logged-in user's agency
\n","urlObject":{"protocol":"https","path":["projects"],"host":["proofpay-api","vercel","app"],"query":[],"variable":[]}},"response":[],"_postman_id":"76481fea-8011-4736-bcdb-6f21a08b537f"},{"name":"Get Single Project","id":"f733d349-e11b-4b11-aa69-eff71f2a65af","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"Returns one project (scoped to agency)
\n","urlObject":{"protocol":"https","path":["projects",":id"],"host":["proofpay-api","vercel","app"],"query":[],"variable":[{"type":"any","value":"","key":"id"}]}},"response":[],"_postman_id":"f733d349-e11b-4b11-aa69-eff71f2a65af"}],"id":"b3accb0f-b420-4048-a44d-95ddf57d842e","description":"Handles project management operations scoped to an agency. This folder covers creating new projects, listing all projects belonging to the logged-in user's agency, and retrieving a single project by its ID.
\n","_postman_id":"b3accb0f-b420-4048-a44d-95ddf57d842e"},{"name":"PAYMENTS","item":[{"name":"Create Payment (Upload Proof)","id":"3b80e8b1-24df-48d2-9a0a-613692af8fc1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"Client uploads payment proof (image/file)
\n","urlObject":{"protocol":"https","path":["payments"],"host":["proofpay-api","vercel","app"],"query":[],"variable":[]}},"response":[],"_postman_id":"3b80e8b1-24df-48d2-9a0a-613692af8fc1"},{"name":"Verify Payment (Manual)","id":"bdf578b4-d179-4b25-aac1-83f85fc42764","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"Admin manually verifies a payment
\n","urlObject":{"protocol":"https","path":["payments",":id","verify"],"host":["proofpay-api","vercel","app"],"query":[],"variable":[{"type":"any","value":"","key":"id"}]}},"response":[],"_postman_id":"bdf578b4-d179-4b25-aac1-83f85fc42764"},{"name":"Reject Payment","id":"3f5332aa-05be-4cc7-b508-143de5a8316d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"Admin rejects a payment
\n","urlObject":{"protocol":"https","path":["payments",":id","reject"],"host":["proofpay-api","vercel","app"],"query":[],"variable":[{"type":"any","value":"","key":"id"}]}},"response":[],"_postman_id":"3f5332aa-05be-4cc7-b508-143de5a8316d"},{"name":"Verify Payment via Paystack","id":"6c03eeef-a321-41b7-a2c6-f44e2a7e7e97","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"Verifies payment using Paystack reference
\n","urlObject":{"protocol":"https","path":["payments","verify","paystack"],"host":["proofpay-api","vercel","app"],"query":[],"variable":[]}},"response":[],"_postman_id":"6c03eeef-a321-41b7-a2c6-f44e2a7e7e97"}],"id":"b51c4227-a803-4d45-ba64-8934f94eb5b0","description":"Manages the full payment proof lifecycle within the ProofPay platform. This folder covers client-side proof submission (image/file upload), as well as admin actions to manually verify or reject submitted payments.
\n","_postman_id":"b51c4227-a803-4d45-ba64-8934f94eb5b0"},{"name":"WEBHOOK","item":[{"name":"Stripe Webhook","id":"14ca3af1-9ed4-4335-ba62-97210b9f1664","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"stripe-signature","value":"(auto from Stripe)","type":"text"}],"body":{"mode":"raw","raw":"Handled automatically by Stripe","options":{"raw":{"language":"text"}}},"url":"https://proofpay-api.vercel.app/webhook/stripe","description":"Receives Stripe events and auto-verifies payments
\n","urlObject":{"protocol":"https","path":["webhook","stripe"],"host":["proofpay-api","vercel","app"],"query":[],"variable":[]}},"response":[],"_postman_id":"14ca3af1-9ed4-4335-ba62-97210b9f1664"}],"id":"3446fff8-1bf9-43d1-9547-2a059d075453","description":"Contains the webhook event handler for the ProofPay API. This folder is used to receive and process incoming event notifications, enabling integrations and automated workflows triggered by platform activity.
\n","_postman_id":"3446fff8-1bf9-43d1-9547-2a059d075453"},{"name":"DASHBOARD","item":[{"name":"Get Dashboard Data","id":"0a47cdee-221e-4a74-9f93-77391d00aa61","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"Returns:
\nProvides a high-level summary view for authenticated users. The dashboard endpoint returns aggregated stats and key metrics relevant to the logged-in user's agency, giving a quick overview of activity across projects and payments.
\n","_postman_id":"2021aa1a-bc0e-449c-b4af-bc7b4d4a43a5"},{"name":"REPORTS","item":[{"name":"Export CSV Report","id":"bd021fa2-b600-4533-ae9c-91ef3f322d33","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"Exports all agency payments as CSV
\n","urlObject":{"protocol":"https","path":["reports","export"],"host":["proofpay-api","vercel","app"],"query":[],"variable":[]}},"response":[],"_postman_id":"bd021fa2-b600-4533-ae9c-91ef3f322d33"}],"id":"ac71af83-0b19-4cdd-988a-3afe37e15b26","description":"Handles report generation and data export for the ProofPay platform. This folder contains endpoints that allow authorized users to extract payment and project data in structured formats (e.g., CSV or Excel) for auditing, reconciliation, and record-keeping purposes.
\n","_postman_id":"ac71af83-0b19-4cdd-988a-3afe37e15b26"}]}