Home

Download this help site
(PDF 82MB)

Download

Refunds V2 API call

Icon

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.

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.

Retrieving a particular refund

Syntax

Example

Retrieving multiple refunds

You can use the Refunds API call to retrieve multiple refunds. You must include filter criteria to narrow the results. For details, see Filtering the results (below).

The refund IDs will be listed by document date in descending order.

Syntax

Example:

Parameters

The following parameters are used within the Refunds API call:

Variable

Description

{baseAPIaddress}

The base address of the API. For more information, see API access options .

{version}The version number of the API. Versions 2 and 2.1 are supported for this call. To retrieve a list of API versions, use the base API call.

{accountID}

The account identifier that appears on the Account and billing screen and is returned by the Accounts API call.

{refundID}The unique identifier for a refunds. Refund IDs are returned by the Refunds API call.
{filterCriteria}The criteria used to filter the search results. This is a required parameter. For details, see Filtering the results (below).
Icon

Each API call must include an authentication information that verifies your account and prevents others from accessing your data. For more information, see Authenticating API access from a 3rd-party server or application or Authenticating API access from a Wild Apricot site page.

Filtering the results

When retrieving information for 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

Example:

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

where date is the start or end date of the range (using the yyyy-mm-dd date format).

Example:

Specifying a set of refund IDs 

You can filter the refunds by specifying a set of refund IDs. 

Syntax 

where id is the unique identifier of a refund.

Example: 

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 

Paging 

Using the $skip and $top parameters, you can retrieve records in sets or pages. You use the $top parameter to specify the maximum number of records to be returned, and the $skip parameter to specify the number of records to skip. The $skip parameter is incremented each call to return the next set or page of records. 

 

Example  

You want to retrieve 50 records using an application that can only process 20 records at a time. Using the following calls, the application retrieves the first set of 20 records, then a second set of 20, and finally, the remaining 10 records.  

In this example, the $top specifies the maximum number of records to retrieve (20), and the $skip parameter is incremented from 0 to 20 to 40 to skip the recordsretrieved by the previous call(s).

Response fields

The Refunds API call retrieves the following information for each refund.

Field

Description

TenderThe method used to refund the payment. For each tender, the tender name, tender ID, and tender URL are returned.
CommentAny internal notes entered for the refund.
PublicCommentAny comments entered for the payer.
SettledValueThe previously settled amount of the payment.
ValueThe amount of the refund. 
DocumentDateThe date and time the refund was made.
ContactThe contact to whom the refund was made. For each contact, the contact ID and contact URL are returned.
CreatedDateThe date the refund was created.
CreatedByThe contact who created the refund (if manually created).
UpdatedDateThe date the refund was last updated.
UpdatedByThe contact who updated the refund.
IDThe unique identifier of the refund.
URLThe address of the URL call for the refund.

Sample JSON response

Sample XML response

Creating a new refund

You can use the Refunds API call to create a new refund.

Syntax

where refundField is a field returned by the Refunds API call.

Example

If successful, the call will return the new refund ID.

Updating a refund

You can update an existing refund using a Refunds API call.

Syntax

where refundField is a field returned by the Refunds API call.

Icon

The refund ID must be specified both as a field and within the requesting URL. All other refund fields are optional.

Example

If successful, the call returns an HTTP status code 200 without any data in the response body.

Deleting a refund

You can use a Refunds API call to delete an existing refund.

Syntax

where refundID is the ID of the refund you want to delete.

Example

If successful, the call returns HTTP 200 Success. If unsuccessful, returns HTTP 400 bad request.

On this page:   

See also:

  • No labels