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 donations made to any sales unit belonging to the merchant of the sales unit identified in the token.

query Parameters

from	string <date-time> Timestamp where payments made after should be included in the report
fromDateTimeUtc	string <date-time> Deprecated
to	string <date-time> Timestamp where payments made after should not be included in the report
toDateTimeUtc	string <date-time> Deprecated
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

{"from": "2019-08-24T14:15:22Z",
"fromDateTimeUtc": "2019-08-24T14:15:22Z",
"to": "2019-08-24T14:15:22Z",
"toDateTimeUtc": "2019-08-24T14:15:22Z",
"payments": [{"externalReference": "string",
"agreementId": "79458f91-82b5-4c38-a886-56df6a6b7980",
"message": "string",
"payer": {"name": "John Doe",
"phoneNumber": "4712345678"
},
"paymentDateTimeUtc": "2019-08-24T14:15:22Z",
"capturedAt": "2019-08-24T14:15:22Z",
"pspReference": "11268125611",
"recipientHandle": "api:922061",
"amount": "50001",
"currency": "NOK"
}
]
}