Skip to content

Preview a donation receipt​

GET
/org-admin/{slug}/donations/{id}/receipt

Read-only donation receipt preview for this organization. Requires organization permission org.read_donations.

Authorizations​

BearerAuth

In the browser, authentication rides on the httpOnly session cookies set by /cognito/signin or the Google / Apple sign-in at /cognito/oauth/{provider}. For scripts and for Swagger UI testing, paste an API key (fh_live_…, created with POST /api-keys); a Cognito JWT is accepted too. Sign-in does not return a token in its body.

Type
HTTP (bearer)

Parameters​

Path Parameters

slug*

Organization slug; middleware resolves and authorizes this organization before any read or write.

Type
string
Required
id*
Type
string
Required
Format
"uuid"

Responses​

Receipt fields in integer cents, with anonymous names masked

application/json
JSON
{
"donation_id": "string",
"receipt_id": "string",
"created_at": "string",
"currency": "USD",
"amount_cents": 0,
"tip_amount_cents": 0,
"fee_amount_cents": 0,
"net_amount_cents": 0,
"total_charged_cents": 0,
"payment_status": "string",
"fundraiser_id": "string",
"fundraiser_title": "string",
"fundraiser_slug": "string",
"donor_name": "string",
"is_anonymous": true,
"donor_email": "string",
"times_sent": 0,
"sendable": true,
"reason": "string"
}

Playground​

Server
Authorization
Variables
Key
Value

Samples​

Powered by VitePress OpenAPI

Built with VitePress