Skip to main content
API docs by Redocly

Donations API (v1)

Download OpenAPI specification:Download

The Donation API provides features that specifically support fundraising

Agreements

Endpoints for managing and retrieving donation agreements

Get detailed information about a specific agreement

Returns comprehensive details about a donation agreement including payer information

path Parameters
agreementId
required
string
Example: 2518f497-bfad-43a6-8914-fd0168a6c221

The unique identifier for the donation agreement

Responses

Response samples

Content type
application/json
{
  • "id": "2518f497-bfad-43a6-8914-fd0168a6c221",
  • "recipientHandle": "NO:6666",
  • "startedAt": "2026-01-31T17:26:50.8789251+00:00",
  • "externalReference": "123abc",
  • "schedule": {
    },
  • "amount": {
    },
  • "payer": {
    }
}

Reports

Get a list of payments marked as donations

Returns a list of payments marked as donations made to any sales unit belonging to the merchant of the sales unit identified in the token.

query Parameters
from
required
string <date-time>

Timestamp where payments made after should be included in the report

to
required
string <date-time>

Timestamp where payments made after should not be included in the report

recipientHandles
string
Example: recipientHandles=NO:1234

Optional filter of recipientHandles that should be included in the response, if omitted donation data for all recipientHandles of the merchant are returned.
To use multiple handles repeat the query parameter

includeGDPRSensitiveData
boolean
Default: false

When true the response will include the message input by the user when making the payment

Responses

Response samples

Content type
application/json
{
  • "from": "2019-08-24T14:15:22Z",
  • "to": "2019-08-24T14:15:22Z",
  • "payments": [
    ]
}