Skip to content
English
Contact us
  • There are no suggestions because the search field is empty.

 My Well Platform API

The My Well Platform API provides programmatic access to your organization's giving data. Build custom integrations to manage customers, process transactions, handle subscriptions, and access donation records.

Getting Started

Step 1: Create an API Integration
  1. Log into your My Well admin dashboard
  2. Navigate to Settings → API Access
  3. Click Create Integration
  4. Save your Access Token immediately (displayed only once)
  5. <li>Note your Organization ID for API requests
Step 2: View Full Documentation
 
Access complete API documentation with live examples, authentication details, and interactive testing:
 
 
The documentation includes:
  • All available endpoints with code examples
  • Request and response schemas
  • Authentication flow (token exchange & refresh)
  • Pagination, filtering, and search options

 
API Capabilities
  • Customers- Create, update, search, and manage customer records and payment methods
  • Transactions- Process one-time payments, refunds, and voids
  • Subscriptions- Create and manage recurring giving schedules
  • Campuses- Search and retrieve campus information
  • Funds- Search available giving funds
 
SDK Downloads

Download our official SDKs to integrate the My Well Platform API into your application.

Click the links below to download the SDK zip files:

PHP:
https://mywell-next-develop.s3.us-east-1.amazonaws.com/static/sdk/v1.0.0/php.zip

Python:
https://mywell-next-develop.s3.us-east-1.amazonaws.com/static/sdk/v1.0.0/python.zip

TypeScript:
"https://mywell-next-develop.s3.us-east-1.amazonaws.com/static/sdk/v1.0.0/typescript.zip


Key Information
 
Base URLs
  • Production: https://api.mywell.org/api/v2
  • Development: https://dev-api.mywell.io/api/v2
Authentication
All API requests require two headers:
 
  • X-Authorization: Bearer YOUR_API_TOKEN
  • X-Organization: YOUR_ORGANIZATION_ID

API tokens expire after 24 hours and must be refreshed. See the interactive documentation for authentication examples.
 

Important Notes
  • Amounts: All monetary amounts are in cents (e.g., $50.00 = 5000)
  • Pagination: Search endpoints return max 100 results per page with cursor-based pagination
  • Security: Never expose tokens in client-side code - use server-to-server only
  • Multi-Fund Giving: Split donations across multiple funds (requires organization feature enabled)