/v1/payments endpoints give you a unified view of all transaction activity for your organization, with consistent field names and clear status values that make it straightforward to build reports, sync your CRM, or trigger downstream workflows.
The payment object
The following fields are returned byGET /v1/payments and GET /v1/payments/{id}.
| Field | Type | Description |
|---|---|---|
paymentID | string | Unique identifier for the payment |
email | string | Payer’s email address |
firstName | string | Payer’s first name |
lastName | string | Payer’s last name |
amount | number | Payment amount in dollars |
currency | string | Currency code (default: USD) |
status | string | Current payment status (see below) |
fund | string | Name of the designated fund |
form | string | Name of the form used to collect the payment |
frequency | string | Donation frequency (see below) |
date | string | ISO 8601 timestamp of the payment |
paymentMethod | string | Payment method used (e.g., card, bank) |
coverFees | boolean | Whether the payer opted to cover processing fees |
anonymous | boolean | Whether the payment was made anonymously |
Status values
| Value | Meaning |
|---|---|
COMPLETED | Payment was successfully processed |
PENDING | Payment is awaiting processing or confirmation |
FAILED | Payment attempt was unsuccessful |
REFUNDED | Payment was refunded to the payer |
Frequency values
| Value | Meaning |
|---|---|
ONE_TIME | Single, non-recurring payment |
DAILY | Charged every day |
WEEKLY | Charged every week |
MONTHLY | Charged every month |
ANNUALLY | Charged once per year |
API endpoints
List payments
Retrieve a paginated list of all payment records for your account.
Get payment
Fetch a single payment record by its ID.
Migrating from the donations API
The/v1/payments endpoints return the same underlying data as /v1/donations, but with cleaner field names and without several fields that were rarely used. Update your integration by replacing the endpoint path and renaming the fields you read from each response.
Field mapping
Legacy field (/v1/donations) | New field (/v1/payments) |
|---|---|
donationID | paymentID |
donorEmail | email |
donorFirstName | firstName |
donorLastName | lastName |
fundName | fund |
formName | form |
donationDate | date |
merchantName, tipAmount, and transactionID are not present in the payment object and are not available through /v1/payments.
Migration steps
Update your endpoint URL
Replace
GET /v1/donations with GET /v1/payments and GET /v1/donations/{id} with GET /v1/payments/{id}. The query parameters (limit, lastEvaluatedKey) are identical.Rename fields in your code
Update any references to the legacy field names listed in the mapping table above.
Remove references to removed fields
Drop any code that reads
merchantName, tipAmount, or transactionID. These fields have no equivalent in the payments API.