Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

WildApricot Finances.Payments API

The Finances.Payments API from WildApricot — 7 operation(s) for finances.payments.

WildApricot Finances.Payments API is one of 29 APIs that WildApricot publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Finances.Payments. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, and authentication docs.

This API exposes 10 operations across 7 paths, and defines 12 schemas. It is described by OpenAPI 3.0.3, at version 7.24.0.

Requests are made against a single base URL, https://api.wildapricot.org/v2.2.

10 operations 7 paths 12 schemas 1 DELETE2 GET6 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
7.24.0
Base URL
https://api.wildapricot.org/v2.2
Authentication
OAuth 2.0
License
Proprietary
Resource Areas
1

Authentication & Security 1

WildApricot Finances.Payments API declares 1 security scheme for authenticating requests. It supports OAuth 2.0 (OAuth2) using the clientCredentials flow, exposing 1 scope.

  • OAuth2 — OAuth2 authentication for WildApricot API

Paths & Operations 10

Across 7 paths, the API surfaces 10 operations — 1 DELETE, 2 GET, 6 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Finances.Payments 10
GET
/accounts/{accountId}/payments
WildApricot Get List of Payments by Criteria.
GetPaymentsList 11 params → 200400401429
POST
/accounts/{accountId}/payments
WildApricot Creates a New Payment.
CreatePayment 1 param body → 200400401429
GET
/accounts/{accountId}/payments/{paymentId}
WildApricot Retrieve Information About Specific Payment
GetPaymentDetails 2 params → 200401404429
PUT
/accounts/{accountId}/payments/{paymentId}
WildApricot Update Existing Payment Information
UpdatePayment 2 params body → 200400401429
DELETE
/accounts/{accountId}/payments/{paymentId}
WildApricot Delete Existing Payment
DeletePayment 2 params → 200401404429
POST
/accounts/{accountId}/payments/{paymentId}/AllocateInvoice
WildApricot Allocate Invoice to Specific Payment
AllocateInvoice 3 params → 200401404429
POST
/accounts/{accountId}/payments/{paymentId}/AllocateRefundToPayment
WildApricot Allocate Refund to Specific Payment
AllocateRefundToPayment 3 params → 200401404429
POST
/accounts/{accountId}/payments/{donationId}/AllocateRefundToDonation
WildApricot Allocate Refund to Specific Donation
AllocateRefundToDonation 3 params → 200401404429
POST
/accounts/{accountId}/payments/{paymentId}/UnallocateFromPayment
WildApricot Unallocate Finance Document from Specific Payment
UnallocateFinanceDocumentFromPayment 3 params → 200401404429
POST
/accounts/{accountId}/payments/{donationId}/UnallocateFromDonation
WildApricot Unallocate Finance Document from Specific Donation
UnallocateFinanceDocumentFromDonation 3 params → 200401404429

Schemas 12

The contract defines 12 schemas that model the data the API accepts and returns. The most detailed are FinanceDocument (9 properties), CreatePaymentModel (8 properties), FieldValue (3 properties), LinkedResource (2 properties). Each schema is shown below with its type and property counts.

FieldValue
object
3 properties
PaymentType
string
Payment type.
FinanceDocument
object
9 properties
LinkedResource
object
2 properties
PaymentsResponse
LinkedResourceWithName
UpdatePaymentParams
CreatePaymentModel
object
8 properties
Payment
PaymentIdsResponse
object
1 property
PaymentListResponse
object
1 property
ResourceUrl
string
Permanent resource URL in API.

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

wildapricot-finances-payments-api-openapi.yml Raw ↑

Other APIs WildApricot publishes across the network.

WildApricot Accounts API
WildApricot Attachments API
WildApricot Contacts API
WildApricot Contacts.CustomFields API
WildApricot Contacts.SavedSearch API
WildApricot Donation.CustomFields API
WildApricot Emailing.Drafts API
WildApricot Emailing.Operations API
WildApricot Emailing.SentEmailRecipients API
WildApricot Emailing.SentEmails API
WildApricot Events API
WildApricot Events.EventRegistrations API