Skip to main content
The GET /v1/payments endpoint returns payment records associated with your merchant account. Results are sorted by date descending and support cursor-based pagination so you can retrieve large datasets incrementally. This endpoint requires the donations:read permission on your API key.
The /v1/payments endpoint replaces the deprecated /v1/donations endpoint. If you are still using /v1/donations, migrate before the 2026-07-01 sunset date.

​
Request

​
limit
integer
default:"50"
Maximum number of payment records to return per page. Accepts values between 1 and 100.
​
lastEvaluatedKey
string
Pagination cursor returned by a previous response. Pass this value to retrieve the next page of results. Omit on the first request.

​
Response

​
payments
Payment[]
required
Array of payment objects for this page of results.
​
count
integer
required
Number of payment records returned in this response.
​
hasMore
boolean
required
true if additional pages of results exist beyond this response.
​
lastEvaluatedKey
string
Pagination cursor for the next page. Pass this as the lastEvaluatedKey query parameter on your next request. Absent when hasMore is false.

​
Example

curl https://0k90mc4jjj.execute-api.us-east-2.amazonaws.com/v1/payments?limit=2 \
  -H "Authorization: Bearer cs_live_your_key"
Response
{
  "payments": [
    {
      "paymentID": "pay_01HXYZ1234ABCDEF",
      "email": "jane.doe@example.com",
      "firstName": "Jane",
      "lastName": "Doe",
      "amount": 100.00,
      "currency": "USD",
      "status": "COMPLETED",
      "fund": "General Fund",
      "form": "Annual Appeal",
      "frequency": "ONE_TIME",
      "date": "2025-04-15T14:32:00Z",
      "paymentMethod": "card",
      "coverFees": true,
      "anonymous": false
    },
    {
      "paymentID": "pay_01HXYZ5678GHIJKL",
      "email": "john.smith@example.com",
      "firstName": "John",
      "lastName": "Smith",
      "amount": 25.00,
      "currency": "USD",
      "status": "COMPLETED",
      "fund": "Scholarship Fund",
      "form": "Monthly Giving",
      "frequency": "MONTHLY",
      "date": "2025-04-14T09:10:00Z",
      "paymentMethod": "bank",
      "coverFees": false,
      "anonymous": false
    }
  ],
  "count": 2,
  "hasMore": true,
  "lastEvaluatedKey": "eyJwYXltZW50SUQiOiJwYXlfMDFIWFlaNTY3OEdISUpLTCJ9"
}