Donations API (v1)

Download OpenAPI specification:Download

The Donation API provides features that specifically support fundraising

Reports

Get a list of payments marked as donations

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

query Parameters

fromDateTimeUtc required	string <date-time> Timestamp where payments made after should be included in the report
toDateTimeUtc required	string <date-time> Timestamp where payments made after should not be included in the report
includeGDPRSensitiveData	boolean Default: false When `true` the response will include the message input by the user when making the payment

header Parameters

Ocp-Apim-Subscription-Key

required

string

Example: da7d5b0e18a84aeda961c0c31b75c2a9

APIM Subscription Key

Responses

Response samples

Content type

application/json

{"fromDateTimeUtc": "2019-08-24T14:15:22Z",
"toDateTimeUtc": "2019-08-24T14:15:22Z",
"payments": [{"recipientHandle": "string",
"paymentDateTimeUtc": "2019-08-24T14:15:22Z",
"amount": 0,
"currency": "string",
"externalReference": "string",
"agreementId": "79458f91-82b5-4c38-a886-56df6a6b7980",
"pspReference": "string",
"message": "string",
"payer": {"name": "string",
"phoneNumber": "string"
}
}
]
}