Hopp til hovedinnhold

Giving-endepunkter

Giving-modulen administrerer gaver, fond, betalingsbehandling, abonnementer og relaterte finansielle operasjoner. Den støtter flere betalingsportaler (Stripe, PayPal), håndterer engangs- og gjentakende gaver, sporer gavebatcher og tilbyr webhook-behandling for asynkrone betalingshendelser.

Basissti: /giving

Gaver

Basissti: /giving/donations

MethodPathAuthPermissionDescription
GET/JWTDonations.View eller egen personIdList alle gaver. Filtrer med ?batchId= eller ?personId=
GET/:idJWTDonations.ViewHent en gave etter ID
GET/myJWTHent gjeldende brukers gaver
GET/summaryJWTDonations.ViewSummaryHent gaveoppsummering. Filtrer med ?startDate=&endDate=&type=. Bruk type=person for per-person-fordeling
GET/testEmailPublicSend en test-e-post (utvikling/feilsøking)
POST/JWTDonations.EditOpprett eller oppdater gaver (batch)
DELETE/:idJWTDonations.EditSlett en gave

Eksempel: List gaver etter batch

GET /giving/donations?batchId=abc-123
Authorization: Bearer <token>
[
{
"id": "don-456",
"batchId": "abc-123",
"personId": "per-789",
"donationDate": "2025-03-15T00:00:00.000Z",
"amount": 100.00,
"method": "card"
}
]

Eksempel: Hent gaveoppsummering

GET /giving/donations/summary?startDate=2025-01-01&endDate=2025-12-31
Authorization: Bearer <token>
[
{
"week": "2025-01-06",
"fund": "General Fund",
"totalAmount": 2500.00,
"count": 15
}
]

Gavebatcher

Basissti: /giving/donationbatches

Utvider GenericCrudController med CRUD-ruter: getById, getAll, post, delete. Sletteoperasjonen fjerner også alle gaver i batchen.

MethodPathAuthPermissionDescription
GET/JWTDonations.ViewSummaryList alle gavebatcher
GET/:idJWTDonations.ViewSummaryHent en gavebatch etter ID
POST/JWTDonations.EditOpprett eller oppdater gavebatcher
DELETE/:idJWTDonations.EditSlett en batch og alle dens gaver

Gi

Basissti: /giving/donate

Håndterer den offentlige gaveflyten inkludert belastninger, abonnementer, webhooks og gebyrberegninger. Ingen basis-CRUD-ruter er aktivert; alle endepunkter er egendefinerte.

MethodPathAuthPermissionDescription
GET/gateways/:churchIdPublicHent tilgjengelige betalingsportaler for en kirke (kun offentlige nøkler)
POST/client-tokenJWTGenerer et klienttoken for portal-initialisering
POST/create-orderJWTOpprett en betalingsordre (PayPal-stil utsjekking)
POST/chargeJWTBehandle en engangsbelastning
POST/subscribeJWTOpprett et gjentakende gaveabonnement
POST/logPublicLogg en gave. Body: { donation, fundData }
POST/webhook/:providerPublicMotta betalings-webhook-hendelser (Stripe, PayPal). Krever ?churchId=
POST/replay-stripe-eventsJWTDonations.EditSpill av Stripe-hendelser på nytt for en datoperiode. Body: { startDate, endDate, dryRun }
POST/feePublicBeregn transaksjonsgebyrer. Body: { type, provider, gatewayId, amount, currency }. Krever ?churchId=
POST/captcha-verifyPublicVerifiser reCAPTCHA-token. Body: { token }

Eksempel: Behandle en gavebelastning

POST /giving/donate/charge
Authorization: Bearer <token>

{
"provider": "stripe",
"amount": 50.00,
"currency": "usd",
"person": { "id": "per-123", "email": "donor@example.com" },
"funds": [{ "id": "fund-001", "name": "General Fund", "amount": 50.00 }],
"church": { "name": "First Church", "subDomain": "firstchurch" }
}
{
"id": "ch_abc123",
"status": "succeeded",
"provider": "stripe"
}

Eksempel: Opprett et gjentakende abonnement

POST /giving/donate/subscribe
Authorization: Bearer <token>

{
"provider": "stripe",
"amount": 100.00,
"customerId": "cus_abc123",
"interval": { "interval_count": 1, "interval": "month" },
"billing_cycle_anchor": 1710460800,
"person": { "id": "per-123", "email": "donor@example.com" },
"funds": [{ "id": "fund-001", "name": "General Fund", "amount": 100.00 }],
"church": { "name": "First Church", "subDomain": "firstchurch" }
}
{
"id": "sub_xyz789",
"status": "active",
"provider": "stripe"
}

Fond

Basissti: /giving/funds

Utvider GenericCrudController med CRUD-ruter: getById, getAll, post, delete. view-tillatelsen er null (ingen tillatelse kreves for å se fond).

MethodPathAuthPermissionDescription
GET/JWTList alle fond
GET/:idJWTHent et fond etter ID
GET/churchId/:churchIdPublicHent alle fond for en spesifikk kirke (offentlig)
POST/JWTDonations.EditOpprett eller oppdater fond
DELETE/:idJWTDonations.EditSlett et fond

Fondsgaver

Basissti: /giving/funddonations

Sporer hvordan individuelle gaver fordeles på tvers av fond. Ingen basis-CRUD-ruter er aktivert; alle endepunkter er egendefinerte.

MethodPathAuthPermissionDescription
GET/JWTDonations.ViewList fondsgaver. Filtrer med ?donationId=, ?personId=, ?fundId= eller ?fundName=. Valgfritt legg til ?startDate=&endDate= for datofiltrering
GET/:idJWTDonations.ViewHent en fondsgave etter ID
GET/myJWTHent gjeldende brukers fondsgaver
POST/JWTDonations.EditOpprett eller oppdater fondsgaver (batch)
DELETE/:idJWTDonations.EditSlett en fondsgave

Portaler

Basissti: /giving/gateways

Administrerer konfigurasjoner for betalingsportaler (Stripe, PayPal osv.). Ingen basis-CRUD-ruter er aktivert; alle endepunkter er egendefinerte. Portal-hemmeligheter er kryptert i hvile.

MethodPathAuthPermissionDescription
GET/JWTList alle portaler for kirken
GET/:idJWTSettings.EditHent en portal etter ID
GET/churchId/:churchIdPublicHent portaler for en kirke (kun offentlige nøkler)
GET/configured/:churchIdPublicSjekk om en kirke har en konfigurert betalingsportal
POST/JWTSettings.EditOpprett eller oppdater portaler (krypterer nøkler, klargjør webhooks og produkter)
PATCH/:idJWTSettings.EditDelvis oppdatering av en portal
DELETE/:idJWTSettings.EditSlett en portal (fjerner også dens webhooks)

Eksempel: Sjekk portalkonfigurasjon

GET /giving/gateways/configured/church-123
{
"configured": true
}

Kunder

Basissti: /giving/customers

Utvider GenericCrudController med CRUD-ruter: getAll, delete. Kobler personer til deres betalingsportal-kundeoppføringer.

MethodPathAuthPermissionDescription
GET/JWTDonations.ViewSummaryList alle kunder
GET/:idJWTDonations.ViewSummary eller egen oppføringHent en kunde etter ID
GET/:id/subscriptionsJWTDonations.ViewSummary eller egen oppføringHent portal-abonnementer for en kunde
DELETE/:idJWTDonations.EditSlett en kunde

Abonnementer

Basissti: /giving/subscriptions

Administrerer gjentakende gaveabonnementer. Ingen basis-CRUD-ruter er aktivert; alle endepunkter er egendefinerte.

MethodPathAuthPermissionDescription
GET/JWTDonations.ViewSummaryList alle abonnementer
GET/:idJWTDonations.ViewSummaryHent et abonnement etter ID
POST/JWTDonations.Edit eller eget abonnementOppdater abonnementer med betalingsportalen
DELETE/:idJWTDonations.Edit eller eget abonnementAvbryt et abonnement og fjern fra databasen. Body: { provider, reason }

Abonnementsfond

Basissti: /giving/subscriptionfunds

Sporer fondsfordelinger for gjentakende abonnementer. Ingen basis-CRUD-ruter er aktivert; alle endepunkter er egendefinerte.

MethodPathAuthPermissionDescription
GET/JWTDonations.View eller eget abonnementList abonnementsfond. Filtrer med ?subscriptionId=
GET/:idJWTDonations.ViewSummaryHent et abonnementsfond etter ID
DELETE/:idJWTDonations.EditSlett et abonnementsfond
DELETE/subscription/:idJWTDonations.Edit eller eget abonnementSlett alle fond for et abonnement

Betalingsmetoder

Basissti: /giving/paymentmethods

Administrerer lagrede betalingsmetoder (kort, bankkontoer) via betalingsportal-API-er. Ingen basis-CRUD-ruter er aktivert; alle endepunkter er egendefinerte.

MethodPathAuthPermissionDescription
GET/personid/:idJWTDonations.View eller egen personIdHent alle lagrede betalingsmetoder for en person (kort, bankkontoer)
POST/addcardJWTLegg til en kortbetalingsmetode. Body: { id, personId, customerId, email, name, churchId, provider }
POST/updatecardJWTDonations.Edit eller egen personIdOppdater kortdetaljer. Body: { personId, paymentMethodId, cardData, provider }
POST/ach-setup-intentJWTDonations.Edit eller egen personIdOpprett en Stripe ACH SetupIntent for bankkontotilknytning. Body: { personId, customerId, email, name, churchId }
POST/ach-setup-intent-anonPublicOpprett en anonym ACH SetupIntent for gjestegaver. Body: { email, name, churchId, gatewayId }
POST/addbankaccountJWTDonations.Edit eller egen personIdLegg til en bankkonto via token (utfaset; bruk ach-setup-intent). Body: { id, personId, customerId, email, name }
POST/updatebankJWTDonations.Edit eller egen personIdOppdater bankkontodetaljer. Body: { paymentMethodId, personId, bankData, customerId }
POST/verifybankJWTDonations.Edit eller egen kundeVerifiser en bankkonto med mikroinnskudd. Body: { paymentMethodId, customerId, amountData }
DELETE/:id/:customeridJWTDonations.Edit eller egen kundeSlett en betalingsmetode (kort eller bankkonto)

Hendelseslogg

Basissti: /giving/eventLog

Utvider GenericCrudController med CRUD-ruter: getById, getAll, post, delete. Sporer betalingsportal-webhook-hendelser for revisjon og deduplisering.

MethodPathAuthPermissionDescription
GET/JWTDonations.ViewSummaryList alle hendelseslogger
GET/:idJWTDonations.ViewSummaryHent en hendelseslogg etter ID
GET/type/:typeJWTDonations.ViewSummaryHent hendelseslogger filtrert etter hendelsestype
POST/JWTDonations.EditOpprett eller oppdater hendelseslogger
DELETE/:idJWTDonations.EditSlett en hendelseslogg

Relaterte sider