Donations

Manage donation campaigns for fundraising.

Create Donation Campaign

Create a new donation campaign.

Endpoint: POST /v1/pay/donations

Authentication: Required

Request Body:

Field	Type	Required	Description
`title`	string	Yes	Campaign title
`description`	string	Yes	Campaign description
`goal_amount`	string	Yes	Fundraising goal amount
`currency`	string	Yes	Currency code (e.g., `GMD`)
`end_date`	string	No	Campaign end date (ISO 8601)
`image_url`	string	No	Campaign image URL
`beneficiary`	string	No	Beneficiary name or organization
`category`	string	No	Campaign category
`is_active`	boolean	No	Whether campaign is active (default: true)
`metadata`	object	No	Custom metadata

Example:

HTTP

TypeScript

Python

Success Response (201):

{
  "data": {
    "id": "don_abc123",
    "slug": "school-building-fund",
    "title": "School Building Fund",
    "description": "Help us build a new school for our community",
    "goal_amount": "50000.00",
    "raised_amount": "0.00",
    "currency": "GMD",
    "beneficiary": "Community Education Trust",
    "category": "Education",
    "donation_url": "https://donate.jokoor.com/school-building-fund",
    "is_active": true,
    "donors_count": 0,
    "mode": "test",
    "livemode": false,
    "created_at": "2024-01-15T10:30:00Z"
  }
}

INFO

Donation URL: Each campaign has a unique, SEO-friendly slug used in the donation URL. The slug is auto-generated from the title (e.g., "School Building Fund" → "school-building-fund") but can be customized when creating the campaign.

Donors visit this URL to:

View campaign details

See progress toward goal

Make one-time or recurring donations

View recent donors (if enabled)

Get Donation Campaign

Get details of a specific donation campaign.

Endpoint: GET /v1/pay/donations/{id}

Authentication: Required

List Donation Campaigns

Get a paginated list of donation campaigns.

Endpoint: GET /v1/pay/donations

Authentication: Required

Query Parameters:

Parameter	Type	Required	Description
`offset`	integer	No	Number of items to skip (default: 0)
`limit`	integer	No	Maximum number of items to return (default: 20, max: 100)
`is_active`	boolean	No	Filter by active status
`category`	string	No	Filter by category

Update Donation Campaign

Update an existing donation campaign.

Endpoint: PUT /v1/pay/donations/{id}

Authentication: Required

Request Body:

Field	Type	Required	Description
`title`	string	No	Campaign title
`description`	string	No	Campaign description
`goal_amount`	string	No	Fundraising goal amount
`end_date`	string	No	Campaign end date
`image_url`	string	No	Campaign image URL
`is_active`	boolean	No	Whether campaign is active
`metadata`	object	No	Custom metadata

Delete Donation Campaign

Delete a donation campaign.

Endpoint: DELETE /v1/pay/donations/{id}

Authentication: Required

Success Response (204): No content

WARNING

Cannot Delete Active Campaigns: You cannot delete a campaign that has received donations. Deactivate it instead by setting is_active to false.

Donations

Create Donation Campaign#

Get Donation Campaign#

List Donation Campaigns#

Update Donation Campaign#

Delete Donation Campaign#

Create Donation Campaign

Get Donation Campaign

List Donation Campaigns

Update Donation Campaign

Delete Donation Campaign