Route Reference
Finance and Payments
Payment providers, account records, finance programs, settlement records, refunds, transfers, and upgrades. Includes generated endpoint contracts from partners-api source.
First created Last updated
End-to-end developer runbook
- Step 1 - Confirm the API area: Identify the product area, route module, endpoint path, and consumer before writing or calling code.
- Step 2 - Read the endpoint contract: Check method, auth, parameters, response, errors, side effects, and related docs.
- Step 3 - Prepare authentication and input: Use the right session, bearer token, webhook secret, or internal header. Validate body and query data before sending it.
- Step 4 - Make the request: Call the endpoint from the correct origin and environment. Keep credentials and secrets out of logs.
- Step 5 - Verify response, side effects, and records: Confirm status code, response shape, database records, external side effects, and audit evidence.
- Step 6 - Add tests, docs, and handoff notes: Update route inventory, consumer notes, and certification checks before depending on the change.
Family summary
Payment providers, account records, finance programs, settlement records, refunds, transfers, and upgrades.
Modules audited
paymentAccounts.ts: 6 generated endpoint entries.paymentProviders.ts: 4 generated endpoint entries.paymentAccountReports.ts: 2 generated endpoint entries.financePrograms.ts: 4 generated endpoint entries.finance.ts: 16 generated endpoint entries.regoRefunds.ts: 6 generated endpoint entries.regoTransfers.ts: 7 generated endpoint entries.regoUpgrades.ts: 7 generated endpoint entries.
Endpoint table
| Method | Path | Module | Auth scan | Source |
|---|---|---|---|---|
POST | /api/events/:eventId/payment-accounts/:accountId/report | paymentAccountReports.ts | Rego attendee session required. | partners-api/src/routes/paymentAccountReports.ts:18 |
GET | /api/events/:id/finance-programs | financePrograms.ts | Partner dashboard session required. | partners-api/src/routes/financePrograms.ts:478 |
PUT | /api/events/:id/finance-programs | financePrograms.ts | Partner dashboard session required. | partners-api/src/routes/financePrograms.ts:493 |
GET | /api/events/:id/finance/accounting | finance.ts | Partner dashboard session required. | partners-api/src/routes/finance.ts:1022 |
POST | /api/events/:id/finance/accounting/deductions | finance.ts | Partner dashboard session required. | partners-api/src/routes/finance.ts:1190 |
POST | /api/events/:id/finance/accounting/entries | finance.ts | Partner dashboard session required. | partners-api/src/routes/finance.ts:1177 |
PATCH | /api/events/:id/finance/accounting/ledger/:sourceType/:sourceId | finance.ts | Partner dashboard session required. | partners-api/src/routes/finance.ts:1203 |
GET | /api/events/:id/finance/analytics | finance.ts | Partner dashboard session required. | partners-api/src/routes/finance.ts:998 |
GET | /api/events/:id/finance/settlements | finance.ts | Partner dashboard session required. | partners-api/src/routes/finance.ts:1293 |
POST | /api/events/:id/finance/settlements | finance.ts | Partner dashboard session required. | partners-api/src/routes/finance.ts:1356 |
POST | /api/events/:id/finance/settlements/quote | finance.ts | Partner dashboard session required. | partners-api/src/routes/finance.ts:1319 |
GET | /api/events/:id/payment-account-reports | paymentAccounts.ts | Partner dashboard session required. | partners-api/src/routes/paymentAccounts.ts:202 |
GET | /api/events/:id/payment-accounts | paymentAccounts.ts | Partner dashboard session required. | partners-api/src/routes/paymentAccounts.ts:93 |
PUT | /api/events/:id/payment-accounts | paymentAccounts.ts | Partner dashboard session required. | partners-api/src/routes/paymentAccounts.ts:117 |
GET | /api/events/:id/payment-providers | paymentProviders.ts | Partner dashboard session required. | partners-api/src/routes/paymentProviders.ts:125 |
PUT | /api/events/:id/payment-providers | paymentProviders.ts | Partner dashboard session required. | partners-api/src/routes/paymentProviders.ts:182 |
GET | /api/events/:id/rego-refunds | regoRefunds.ts | Partner dashboard session required. | partners-api/src/routes/regoRefunds.ts:959 |
PATCH | /api/events/:id/rego-refunds/:refundId/review | regoRefunds.ts | Partner dashboard session required. | partners-api/src/routes/regoRefunds.ts:981 |
GET | /api/events/:id/rego-transfers | regoTransfers.ts | Partner dashboard session required. | partners-api/src/routes/regoTransfers.ts:928 |
PATCH | /api/events/:id/rego-transfers/:transferId/review | regoTransfers.ts | Partner dashboard session required. | partners-api/src/routes/regoTransfers.ts:950 |
GET | /api/events/:id/rego-upgrades | regoUpgrades.ts | Partner dashboard session required. | partners-api/src/routes/regoUpgrades.ts:1332 |
PATCH | /api/events/:id/rego-upgrades/:upgradeId/review | regoUpgrades.ts | Partner dashboard session required. | partners-api/src/routes/regoUpgrades.ts:1396 |
POST | /api/manage/:eventId/payment-accounts/:accountId/report | paymentAccountReports.ts | Rego attendee session required. | partners-api/src/routes/paymentAccountReports.ts:18 |
GET | /api/manage/:id/finance-programs | financePrograms.ts | Partner dashboard session required. | partners-api/src/routes/financePrograms.ts:478 |
PUT | /api/manage/:id/finance-programs | financePrograms.ts | Partner dashboard session required. | partners-api/src/routes/financePrograms.ts:493 |
GET | /api/manage/:id/finance/accounting | finance.ts | Partner dashboard session required. | partners-api/src/routes/finance.ts:1022 |
POST | /api/manage/:id/finance/accounting/deductions | finance.ts | Partner dashboard session required. | partners-api/src/routes/finance.ts:1190 |
POST | /api/manage/:id/finance/accounting/entries | finance.ts | Partner dashboard session required. | partners-api/src/routes/finance.ts:1177 |
PATCH | /api/manage/:id/finance/accounting/ledger/:sourceType/:sourceId | finance.ts | Partner dashboard session required. | partners-api/src/routes/finance.ts:1203 |
GET | /api/manage/:id/finance/analytics | finance.ts | Partner dashboard session required. | partners-api/src/routes/finance.ts:998 |
GET | /api/manage/:id/finance/settlements | finance.ts | Partner dashboard session required. | partners-api/src/routes/finance.ts:1293 |
POST | /api/manage/:id/finance/settlements | finance.ts | Partner dashboard session required. | partners-api/src/routes/finance.ts:1356 |
POST | /api/manage/:id/finance/settlements/quote | finance.ts | Partner dashboard session required. | partners-api/src/routes/finance.ts:1319 |
GET | /api/manage/:id/payment-account-reports | paymentAccounts.ts | Partner dashboard session required. | partners-api/src/routes/paymentAccounts.ts:202 |
GET | /api/manage/:id/payment-accounts | paymentAccounts.ts | Partner dashboard session required. | partners-api/src/routes/paymentAccounts.ts:93 |
PUT | /api/manage/:id/payment-accounts | paymentAccounts.ts | Partner dashboard session required. | partners-api/src/routes/paymentAccounts.ts:117 |
GET | /api/manage/:id/payment-providers | paymentProviders.ts | Partner dashboard session required. | partners-api/src/routes/paymentProviders.ts:125 |
PUT | /api/manage/:id/payment-providers | paymentProviders.ts | Partner dashboard session required. | partners-api/src/routes/paymentProviders.ts:182 |
GET | /api/manage/:id/rego-refunds | regoRefunds.ts | Partner dashboard session required. | partners-api/src/routes/regoRefunds.ts:959 |
PATCH | /api/manage/:id/rego-refunds/:refundId/review | regoRefunds.ts | Partner dashboard session required. | partners-api/src/routes/regoRefunds.ts:981 |
GET | /api/manage/:id/rego-transfers | regoTransfers.ts | Partner dashboard session required. | partners-api/src/routes/regoTransfers.ts:928 |
PATCH | /api/manage/:id/rego-transfers/:transferId/review | regoTransfers.ts | Partner dashboard session required. | partners-api/src/routes/regoTransfers.ts:950 |
GET | /api/manage/:id/rego-upgrades | regoUpgrades.ts | Partner dashboard session required. | partners-api/src/routes/regoUpgrades.ts:1332 |
PATCH | /api/manage/:id/rego-upgrades/:upgradeId/review | regoUpgrades.ts | Partner dashboard session required. | partners-api/src/routes/regoUpgrades.ts:1396 |
POST | /api/rego/rego-upgrades/:id/pay | regoUpgrades.ts | Rego attendee session required. | partners-api/src/routes/regoUpgrades.ts:1199 |
GET | /api/rego/regos/:ref/refunds | regoRefunds.ts | Rego attendee session required. | partners-api/src/routes/regoRefunds.ts:744 |
POST | /api/rego/regos/:ref/refunds | regoRefunds.ts | Rego attendee session required. | partners-api/src/routes/regoRefunds.ts:799 |
GET | /api/rego/regos/:ref/transfers | regoTransfers.ts | Rego attendee session required. | partners-api/src/routes/regoTransfers.ts:630 |
POST | /api/rego/regos/:ref/transfers | regoTransfers.ts | Rego attendee session required. | partners-api/src/routes/regoTransfers.ts:692 |
GET | /api/rego/regos/:ref/upgrades | regoUpgrades.ts | Rego attendee session required. | partners-api/src/routes/regoUpgrades.ts:945 |
POST | /api/rego/regos/:ref/upgrades | regoUpgrades.ts | Rego attendee session required. | partners-api/src/routes/regoUpgrades.ts:1034 |
GET | /api/rego/users/transfer-search | regoTransfers.ts | Rego attendee session required. | partners-api/src/routes/regoTransfers.ts:599 |
Endpoint contract notes
- Action 1 - Verify unknowns: The table is source-generated, but fields marked unknown need manual handler review.
- Action 2 - Check source line: Use the source line as the starting point for exact request, response, and side-effect behavior.
- Action 3 - Review consumers: Search dashboard, rego, EMS LAN, and webhook callers before changing a path or response.
- Action 4 - Update inventory: Regenerate after any route change.