Frequently asked questions
How do I get access to the donations API?​
In order to use the Donations API you need to have order and be approved for the Donations product, who can be approved is market dependent. More information can be found on our web pages.
What is the difference between the Donations API's Payment Report endpoint and the Report API​
The payment report in the Donations API is meant to support the use case of identifying the customer in your system. It does not contain any information related to reconciliation.
What data is included in the payment report?​
The payment report contains a single entry per payment corresponding to the capture of the payment, in addition to identification of the sales unit through the recipient handle you get the id of the agreement if applicable, amount, time and the payers full name and number. If the includeGDPRSensitiveData flag is set the user provided message is included for all single donations payments (legacy)
More details about the response can be found in the API specification
What products are included in the payment report?​
The payment report contains payments made on the Donations product. It also contains payments made to the older solutions Recurring Donations and VM# with fundraising report.
How long after payment is the entry available in the payment report endpoint?​
There is no SLA for this but as a general rule you can expect it to be there within 10 minutes of the payment being performed