Introduction

Introduction

The documentation section has full usage instructions for each Virgin Money Giving API along with example responses and useful information for developing and testing your applications.

When you're ready you can use IO Docs to make test calls against our sandbox environment.

Description of our APIs

API Description
Fundraiser search You can use this API to search our database using a full or partial fundraiser name. This will return details of fundraisers who match or partially match that name.

For each fundraiser returned a URI link is also provided for the fundraiser details API.
Fundraiser details You can use this API to return information about all of the pages a fundraiser may have.
Fundraising page details This API returns the donation totals and charities the page is fundraising for.
Charity search This returns a list of charities from a full or partial charity name.
Validate URL To create a fundraising account or to create a team page you need to choose a unique URL which is used to identify the fundraiser or the team page.

This API confirms that either a fundraiser URL or a team page URL is unique with in the VMG system and can be used to create an account or team page.
Country code lookup A fundraising account requires an address to be entered with a valid country code. In VMG we have a list of countries and their corresponding codes. This API returns our list of countries and their codes.
Address lookup This API returns a list of full addresses for a given postcode.
Account exists This API identifies whether an account exists on VMG for a given date of birth and email address. The API also returns whether it is possible to create a page for this account.
Create fundraiser account This API creates an account on VMG, you need an account to be able to create a fundraising page.
Activity lookup If you are not setting up a page for an event in VMG you need to specify a fundraising activity for the page – running, cycling etc. This API returns a list of activities and the code you need to use.
Event search For a full or partial event name this API provides a list of matching events to allow an event to be selected for fundraising.
Create fundraiser page To start fundraising you need to create a fundraising page, this API creates a fundraising page for an account.
Event summary This API provides a summarised view of fundraising pages set up against a specific event.
Event fundraisers This API returns details of all the fundraising pages for an event.
Event fundraisers 2 This API returns details of all the fundraising pages for an event, with additional content re charity categorisation (e.g. Mental Health).
Charity fundraisers This API returns details of all the fundraising pages for a charity.
Charity details This returns details relating to a specific charity.

API packages

Our APIs are grouped into packages as follows:

Fundraiser
Find fundraisers and return information from their pages.

Charity
Everything you need to fetch donation information for your charity. Create new fundraiser accounts and pages directly from your site.

Event
Everything you need to fetch donation information for your event. Create new fundraiser accounts and pages directly from your site.

API packages include

API Fundraiser developer Charity developer Event developer
Fundraiser search Included Not included Not included
Fundraiser details Included Included Included
Fundraising page details Included Not included Not included
Charity search Not included Not included Included
Validate URL Not included Included Included
Country code lookup Not included Included Included
Address lookup Not included Included Included
Account exists Not included Included Included
Create fundraiser account Not included Included Included
Activity lookup Not included Included Included
Event search Not included Included Not included
Create fundraiser page Not included Included Included
Event summary Not included Included Included
Event fundraisers Not included Included Included
Event fundraisers 2 Not included Not included Included
Charity fundraisers Not included Included Not included
Charity details Not included Not included Included