You can use the Refunds API call to retrieve information for a particular refund, or for multiple refunds, filtered by date, contact, or event. You can also create, edit, or delete a refund.
Wild Apricot's API is intended for use by developers with technical expertise. If you need assistance, we provide support via email or through our Developers forum. If you are not an experienced programmer, consider using Make (formerly Integromat) to build automated workflows with Wild Apricot.
Refunds API functions
The Refunds API call supports the following functions. To view the Swagger documentation, click the appropriate function below.
- Retrieving a specific refund
- Retrieving multiple refunds using filter criteria
- Creating a new refund
- Updating a refund
- Deleting a refund
Filtering the results
When retrieving multiple refunds, you must include filter criteria. You can filter the results by specifying a contact or event, by specifying a start and/or end date, and by specifying a set of refund ids. You can combine multiple filter criteria to further narrow the results.
Specifying a contact or event
You can filter the refunds by specifying a particular contact and/or event.
Syntax
GET
{baseAPIaddress}/{version}/Accounts/{accountID}/Refunds/?contactId={contactID}&eventId={eventID}Example:
GET https://api.wildapricot.org/v2/Accounts/58293/Refunds?contactId=725191&eventId=11769
Specifying a start or end document date
You can filter the refunds by specifying a start date and/or an end date (using the DocumentDate field).
Syntax:
GET
{baseAPIaddress}/{version}/Accounts/{accountID}/Refunds/?StartDate={date}&EndDate={date}where date is the start or end date of the range (using the yyyy-mm-dd date format).
Example:
GET https://api.wildapricot.org/v2/Accounts/58293/Refunds/?StartDate=2016-11-01&EndDate=2016-11-30
Specifying a set of refund IDs
You can filter the refunds by specifying a set of refund IDs.
Syntax:
GET
{baseAPIaddress}/{version}/Accounts/{accountID}/Refunds/?ids={id1},{id2},{id3}...where id is the unique identifier of a refund.
Example:
GET https://api.wildapricot.org/v2/Accounts/58293/Refunds/?ids=25291887,25291888
Retrieving just refund IDs
You can retrieve just the refund IDs that match the filter criteria by including the idsOnly parameter. This parameter is only available when you specify v2.1 as the API version. The refund IDs will be listed by document date in descending order.
Example:
GET https://api.wildapricot.org/v2/Accounts/58293/Refunds?eventId=11769&idsOnly=true
