Repository navigation
Expand file tree
/
Copy pathopenapi.json
More file actions
189 lines (189 loc) · 6.56 KB
/
Copy pathopenapi.json
File metadata and controls
189 lines (189 loc) · 6.56 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
{
"openapi": "3.1.0",
"info": {
"title": "ProofPay API",
"version": "2.1.0",
"description": "Pay-on-acceptance protocol for digital deliverables with PayPal authorization holds and deterministic AI verification.",
"contact": {
"name": "ProofPay Developer Support",
"url": "https://proofpay.app"
}
},
"servers": [
{
"url": "http://localhost:3000/api/v1",
"description": "Local Developer Sandbox"
},
{
"url": "https://proofpay.app/api/v1",
"description": "Cloud Production Sandbox"
}
],
"components": {
"securitySchemes": {
"BearerAuth": {
"type": "http",
"scheme": "bearer",
"bearerFormat": "API Key (pp_k_...)",
"description": "Scoped Machine or User API Key"
}
},
"schemas": {
"Contract": {
"type": "object",
"properties": {
"id": { "type": "string", "format": "uuid" },
"title": { "type": "string" },
"status": {
"type": "string",
"enum": ["DRAFT", "PROPOSED", "ACCEPTED", "FUNDED", "IN_PROGRESS", "COMPLETED", "CANCELLED", "FAILED"]
},
"total_minor": { "type": "integer", "description": "Total in USD minor cents" },
"currency": { "type": "string", "default": "USD" },
"contract_hash": { "type": "string", "description": "Canonical SHA-256 agreement hash" },
"paypal_order_id": { "type": "string", "nullable": true },
"authorization_id": { "type": "string", "nullable": true }
}
},
"Milestone": {
"type": "object",
"properties": {
"id": { "type": "string", "format": "uuid" },
"title": { "type": "string" },
"amount_minor": { "type": "integer" },
"status": {
"type": "string",
"enum": ["PENDING", "SUBMITTED", "VERIFYING", "PASSED", "REJECTED", "ESCALATED", "RELEASED", "VOIDED"]
},
"capture_id": { "type": "string", "nullable": true }
}
},
"VerificationReport": {
"type": "object",
"properties": {
"decision": { "type": "string", "enum": ["PASSED", "REJECTED", "ESCALATED"] },
"confidence": { "type": "number" },
"reasons": { "type": "array", "items": { "type": "string" } },
"latency_ms": { "type": "integer" }
}
}
}
},
"security": [{ "BearerAuth": [] }],
"paths": {
"/contracts": {
"get": {
"summary": "List user contracts",
"tags": ["Contracts"],
"responses": {
"200": { "description": "List of contracts for the current session or API key" }
}
},
"post": {
"summary": "Compile & create a contract from natural language prompt",
"tags": ["Contracts"],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"required": ["prompt"],
"properties": {
"prompt": { "type": "string", "description": "Specification of milestones and deliverables" },
"seller_email": { "type": "string", "format": "email" },
"budget_cap_minor": { "type": "integer" }
}
}
}
}
},
"responses": {
"201": { "description": "Contract compiled and created successfully" }
}
}
},
"/contracts/{id}/accept": {
"post": {
"summary": "Accept contract terms and lock agreement hash",
"tags": ["Lifecycle"],
"parameters": [{ "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }],
"responses": {
"200": { "description": "Contract accepted and hash locked in ledger" }
}
}
},
"/contracts/{id}/fund": {
"post": {
"summary": "Generate PayPal authorization hold approval link",
"tags": ["Funding"],
"parameters": [{ "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }],
"responses": {
"200": { "description": "Returns PayPal approval URL for human payer authorization" }
}
}
},
"/contracts/{id}/milestones/{milestoneKey}/submit": {
"post": {
"summary": "Submit deliverable payload for automated verification",
"tags": ["Deliverables"],
"parameters": [
{ "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } },
{ "name": "milestoneKey", "in": "path", "required": true, "schema": { "type": "string" } }
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"required": ["payload"],
"properties": {
"payload": { "type": "string", "description": "JSON string or text deliverable" },
"content_type": { "type": "string", "enum": ["json_records", "text"] }
}
}
}
}
},
"responses": {
"200": { "description": "Deliverable received and verification initiated" }
}
}
},
"/contracts/{id}/proof-pack": {
"get": {
"summary": "Download cryptographic Proof Pack (JSON or PDF)",
"tags": ["Ledger & Evidence"],
"parameters": [
{ "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } },
{ "name": "format", "in": "query", "schema": { "type": "string", "enum": ["json", "pdf"] } }
],
"responses": {
"200": { "description": "Cryptographic Proof Pack evidence bundle" }
}
}
},
"/contracts/{id}/dispute-evidence": {
"get": {
"summary": "Download PayPal Disputes API provide_evidence formatted payload",
"tags": ["Ledger & Evidence"],
"parameters": [
{ "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }
],
"responses": {
"200": { "description": "JSON payload ready for PayPal Disputes API provide_evidence" }
}
}
},
"/ledger": {
"get": {
"summary": "Global append-only financial audit ledger (AG Grid query)",
"tags": ["Ledger & Evidence"],
"responses": {
"200": { "description": "Sequence-ordered immutable events with hash verification" }
}
}
}
}
}