Follow

Tenders API call

You can use the Tenders API call to retrieve information about tenders – the methods by which payments are received. You can retrieve information about a particular tender or about all tenders within the specified account.

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.

Retrieving information for a particular tender

Syntax
GET [baseAPIaddress]/v2/Accounts/[accountID]/Tenders/[tenderID]
Example
GET https://api.wildapricot.org/v2/Accounts/58293/Tenders/49490

Retrieving information for all tenders

Syntax
GET [baseAPIaddress]/v2/Accounts/[accountID]/Tenders
Example
GET https://api.wildapricot.org/v2/Accounts/58293/Tenders
Each API call must include an authentication information that verifies your account and prevents others from accessing your data. For more information, see API access options.

Parameters

The following parameters are used within the Tenders API call:

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

accountID
The account identifier that is returned by the Accounts API call.

tenderID
The unique identifier of the tender. Tender IDs are returned by the Tenders API call.

Response fields

For each tender, the Tenders API call retrieves the following information.

DisplayPosition
The position of the tender within the tenders list.

ID
The unique identifier of the tender.

IsCustom
Indicates whether the tender was created by an administrator.

Name
The name assigned to the tender.

URL
The address of the API call for this tender.

Sample JSON response

[
{
"DisplayPosition": 1,
"IsCustom": true,
"Id": 49489,
"Url": "http://api.wildapricot.org/v2/accounts/42353/Tenders/49489",
"Name": "Cash"
},
{
"DisplayPosition": 2,
"IsCustom": true,
"Id": 49490,
"Url": "http://api.wildapricot.org/v2/accounts/42353/Tenders/49490",
"Name": "Check"
},
{
"DisplayPosition": 3,
"IsCustom": true,
"Id": 49491,
"Url": "http://api.wildapricot.org/v2/accounts/42353/Tenders/49491",
"Name": "Wire transfer"
},
{
"DisplayPosition": 4,
"IsCustom": true,
"Id": 49492,
"Url": "http://api.wildapricot.org/v2/accounts/42353/Tenders/49492",
"Name": "PayPal"
},
{
"DisplayPosition": 5,
"IsCustom": true,
"Id": 49493,
"Url": "http://api.wildapricot.org/v2/accounts/42353/Tenders/49493",
"Name": "Credit Card"
},
{
"DisplayPosition": 6,
"IsCustom": true,
"Id": 49494,
"Url": "http://api.wildapricot.org/v2/accounts/42353/Tenders/49494",
"Name": "Special discount"
},
{
"DisplayPosition": 120,
"IsCustom": false,
"Id": 1,
"Url": "http://api.wildapricot.org/v2/accounts/42353/Tenders/1",
"Name": "PayPal Payments Standard"
},
{
"DisplayPosition": 121,
"IsCustom": false,
"Id": 2,
"Url": "http://api.wildapricot.org/v2/accounts/42353/Tenders/2",
"Name": "PayPal Subscription Payment"
},
{
"DisplayPosition": 210,
"IsCustom": false,
"Id": 3,
"Url": "http://api.wildapricot.org/v2/accounts/42353/Tenders/3",
"Name": "PayPal Credit Card"
},
{
"DisplayPosition": 211,
"IsCustom": false,
"Id": 4,
"Url": "http://api.wildapricot.org/v2/accounts/42353/Tenders/4",
"Name": "PayPal Credit Card Recurring Payment"
},
{
"DisplayPosition": 220,
"IsCustom": false,
"Id": 5,
"Url": "http://api.wildapricot.org/v2/accounts/42353/Tenders/5",
"Name": "PayPal Express Checkout"
},
{
"DisplayPosition": 221,
"IsCustom": false,
"Id": 6,
"Url": "http://api.wildapricot.org/v2/accounts/42353/Tenders/6",
"Name": "PayPal Recurring Payment"
},
{
"DisplayPosition": 230,
"IsCustom": false,
"Id": 48326,
"Url": "http://api.wildapricot.org/v2/accounts/42353/Tenders/48326",
"Name": "PayPal Payments Advanced"
},
{
"DisplayPosition": 240,
"IsCustom": false,
"Id": 48324,
"Url": "http://api.wildapricot.org/v2/accounts/42353/Tenders/48324",
"Name": "PayPal Payflow Pro Credit Card"
},
{
"DisplayPosition": 241,
"IsCustom": false,
"Id": 48325,
"Url": "http://api.wildapricot.org/v2/accounts/42353/Tenders/48325",
"Name": "PayPal Payflow Pro Recurring Payment"
},
{
"DisplayPosition": 310,
"IsCustom": false,
"Id": 7,
"Url": "http://api.wildapricot.org/v2/accounts/42353/Tenders/7",
"Name": "Authorize.NET Credit Card"
},
{
"DisplayPosition": 311,
"IsCustom": false,
"Id": 8,
"Url": "http://api.wildapricot.org/v2/accounts/42353/Tenders/8",
"Name": "Authorize.NET Recurring Payment"
},
{
"DisplayPosition": 420,
"IsCustom": false,
"Id": 9,
"Url": "http://api.wildapricot.org/v2/accounts/42353/Tenders/9",
"Name": "Google Account"
},
{
"DisplayPosition": 510,
"IsCustom": false,
"Id": 48314,
"Url": "http://api.wildapricot.org/v2/accounts/42353/Tenders/48314",
"Name": "2Checkout"
},
{
"DisplayPosition": 511,
"IsCustom": false,
"Id": 48359,
"Url": "http://api.wildapricot.org/v2/accounts/42353/Tenders/48359",
"Name": "2Checkout Recurring Payment"
},
{
"DisplayPosition": 610,
"IsCustom": false,
"Id": 48315,
"Url": "http://api.wildapricot.org/v2/accounts/42353/Tenders/48315",
"Name": "BluePay Credit Card"
},
{
"DisplayPosition": 611,
"IsCustom": false,
"Id": 48316,
"Url": "http://api.wildapricot.org/v2/accounts/42353/Tenders/48316",
"Name": "BluePay Recurring Payment"
},
{
"DisplayPosition": 710,
"IsCustom": false,
"Id": 48317,
"Url": "http://api.wildapricot.org/v2/accounts/42353/Tenders/48317",
"Name": "CRE Secure Credit Card"
},
{
"DisplayPosition": 711,
"IsCustom": false,
"Id": 48318,
"Url": "http://api.wildapricot.org/v2/accounts/42353/Tenders/48318",
"Name": "CRE Secure Recurring Payment"
},
{
"DisplayPosition": 810,
"IsCustom": false,
"Id": 48319,
"Url": "http://api.wildapricot.org/v2/accounts/42353/Tenders/48319",
"Name": "Global Payments Credit Card"
},
{
"DisplayPosition": 910,
"IsCustom": false,
"Id": 48320,
"Url": "http://api.wildapricot.org/v2/accounts/42353/Tenders/48320",
"Name": "IATS Credit Card"
},
{
"DisplayPosition": 911,
"IsCustom": false,
"Id": 48321,
"Url": "http://api.wildapricot.org/v2/accounts/42353/Tenders/48321",
"Name": "IATS Recurring Payment"
},
{
"DisplayPosition": 1010,
"IsCustom": false,
"Id": 48322,
"Url": "http://api.wildapricot.org/v2/accounts/42353/Tenders/48322",
"Name": "Moneris Credit Card"
},
{
"DisplayPosition": 1011,
"IsCustom": false,
"Id": 48323,
"Url": "http://api.wildapricot.org/v2/accounts/42353/Tenders/48323",
"Name": "Moneris Recurring Payment"
},
{
"DisplayPosition": 1110,
"IsCustom": false,
"Id": 48327,
"Url": "http://api.wildapricot.org/v2/accounts/42353/Tenders/48327",
"Name": "Skrill"
},
{
"DisplayPosition": 1111,
"IsCustom": false,
"Id": 48328,
"Url": "http://api.wildapricot.org/v2/accounts/42353/Tenders/48328",
"Name": "Skrill Recurring Payment"
}
]

Sample XML response

ArrayOfTender xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Bonasource.MembershipFS.PublicAPI.Model.V2.Finances">
<Tender>
<Id xmlns="http://api.wildapricot.org">49489</Id>
<Url xmlns="http://api.wildapricot.org">http://api.wildapricot.org/v2/accounts/42353/Tenders/49489</Url>
<Name xmlns="http://api.wildapricot.org">Cash</Name>
<DisplayPosition>1</DisplayPosition>
<IsCustom>true</IsCustom>
</Tender>
<Tender>
<Id xmlns="http://api.wildapricot.org">49490</Id>
<Url xmlns="http://api.wildapricot.org">http://api.wildapricot.org/v2/accounts/42353/Tenders/49490</Url>
<Name xmlns="http://api.wildapricot.org">Check</Name>
<DisplayPosition>2</DisplayPosition>
<IsCustom>true</IsCustom>
</Tender>
<Tender>
<Id xmlns="http://api.wildapricot.org">49491</Id>
<Url xmlns="http://api.wildapricot.org">http://api.wildapricot.org/v2/accounts/42353/Tenders/49491</Url>
<Name xmlns="http://api.wildapricot.org">Wire transfer</Name>
<DisplayPosition>3</DisplayPosition>
<IsCustom>true</IsCustom>
</Tender>
<Tender>
<Id xmlns="http://api.wildapricot.org">49492</Id>
<Url xmlns="http://api.wildapricot.org">http://api.wildapricot.org/v2/accounts/42353/Tenders/49492</Url>
<Name xmlns="http://api.wildapricot.org">PayPal</Name>
<DisplayPosition>4</DisplayPosition>
<IsCustom>true</IsCustom>
</Tender>
<Tender>
<Id xmlns="http://api.wildapricot.org">49493</Id>
<Url xmlns="http://api.wildapricot.org">http://api.wildapricot.org/v2/accounts/42353/Tenders/49493</Url>
<Name xmlns="http://api.wildapricot.org">Credit Card</Name>
<DisplayPosition>5</DisplayPosition>
<IsCustom>true</IsCustom>
</Tender>
<Tender>
<Id xmlns="http://api.wildapricot.org">49494</Id>
<Url xmlns="http://api.wildapricot.org">http://api.wildapricot.org/v2/accounts/42353/Tenders/49494</Url>
<Name xmlns="http://api.wildapricot.org">Special discount</Name>
<DisplayPosition>6</DisplayPosition>
<IsCustom>true</IsCustom>
</Tender>
<Tender>
<Id xmlns="http://api.wildapricot.org">1</Id>
<Url xmlns="http://api.wildapricot.org">http://api.wildapricot.org/v2/accounts/42353/Tenders/1</Url>
<Name xmlns="http://api.wildapricot.org">PayPal Payments Standard</Name>
<DisplayPosition>120</DisplayPosition>
<IsCustom>false</IsCustom>
</Tender>
<Tender>
<Id xmlns="http://api.wildapricot.org">2</Id>
<Url xmlns="http://api.wildapricot.org">http://api.wildapricot.org/v2/accounts/42353/Tenders/2</Url>
<Name xmlns="http://api.wildapricot.org">PayPal Subscription Payment</Name>
<DisplayPosition>121</DisplayPosition>
<IsCustom>false</IsCustom>
</Tender>
<Tender>
<Id xmlns="http://api.wildapricot.org">3</Id>
<Url xmlns="http://api.wildapricot.org">http://api.wildapricot.org/v2/accounts/42353/Tenders/3</Url>
<Name xmlns="http://api.wildapricot.org">PayPal Credit Card</Name>
<DisplayPosition>210</DisplayPosition>
<IsCustom>false</IsCustom>
</Tender>
<Tender>
<Id xmlns="http://api.wildapricot.org">4</Id>
<Url xmlns="http://api.wildapricot.org">http://api.wildapricot.org/v2/accounts/42353/Tenders/4</Url>
<Name xmlns="http://api.wildapricot.org">PayPal Credit Card Recurring Payment</Name>
<DisplayPosition>211</DisplayPosition>
<IsCustom>false</IsCustom>
</Tender>
<Tender>
<Id xmlns="http://api.wildapricot.org">5</Id>
<Url xmlns="http://api.wildapricot.org">http://api.wildapricot.org/v2/accounts/42353/Tenders/5</Url>
<Name xmlns="http://api.wildapricot.org">PayPal Express Checkout</Name>
<DisplayPosition>220</DisplayPosition>
<IsCustom>false</IsCustom>
</Tender>
<Tender>
<Id xmlns="http://api.wildapricot.org">6</Id>
<Url xmlns="http://api.wildapricot.org">http://api.wildapricot.org/v2/accounts/42353/Tenders/6</Url>
<Name xmlns="http://api.wildapricot.org">PayPal Recurring Payment</Name>
<DisplayPosition>221</DisplayPosition>
<IsCustom>false</IsCustom>
</Tender>
<Tender>
<Id xmlns="http://api.wildapricot.org">48326</Id>
<Url xmlns="http://api.wildapricot.org">http://api.wildapricot.org/v2/accounts/42353/Tenders/48326</Url>
<Name xmlns="http://api.wildapricot.org">PayPal Payments Advanced</Name>
<DisplayPosition>230</DisplayPosition>
<IsCustom>false</IsCustom>
</Tender>
<Tender>
<Id xmlns="http://api.wildapricot.org">48324</Id>
<Url xmlns="http://api.wildapricot.org">http://api.wildapricot.org/v2/accounts/42353/Tenders/48324</Url>
<Name xmlns="http://api.wildapricot.org">PayPal Payflow Pro Credit Card</Name>
<DisplayPosition>240</DisplayPosition>
<IsCustom>false</IsCustom>
</Tender>
<Tender>
<Id xmlns="http://api.wildapricot.org">48325</Id>
<Url xmlns="http://api.wildapricot.org">http://api.wildapricot.org/v2/accounts/42353/Tenders/48325</Url>
<Name xmlns="http://api.wildapricot.org">PayPal Payflow Pro Recurring Payment</Name>
<DisplayPosition>241</DisplayPosition>
<IsCustom>false</IsCustom>
</Tender>
<Tender>
<Id xmlns="http://api.wildapricot.org">7</Id>
<Url xmlns="http://api.wildapricot.org">http://api.wildapricot.org/v2/accounts/42353/Tenders/7</Url>
<Name xmlns="http://api.wildapricot.org">Authorize.NET Credit Card</Name>
<DisplayPosition>310</DisplayPosition>
<IsCustom>false</IsCustom>
</Tender>
<Tender>
<Id xmlns="http://api.wildapricot.org">8</Id>
<Url xmlns="http://api.wildapricot.org">http://api.wildapricot.org/v2/accounts/42353/Tenders/8</Url>
<Name xmlns="http://api.wildapricot.org">Authorize.NET Recurring Payment</Name>
<DisplayPosition>311</DisplayPosition>
<IsCustom>false</IsCustom>
</Tender>
<Tender>
<Id xmlns="http://api.wildapricot.org">9</Id>
<Url xmlns="http://api.wildapricot.org">http://api.wildapricot.org/v2/accounts/42353/Tenders/9</Url>
<Name xmlns="http://api.wildapricot.org">Google Account</Name>
<DisplayPosition>420</DisplayPosition>
<IsCustom>false</IsCustom>
</Tender>
<Tender>
<Id xmlns="http://api.wildapricot.org">48314</Id>
<Url xmlns="http://api.wildapricot.org">http://api.wildapricot.org/v2/accounts/42353/Tenders/48314</Url>
<Name xmlns="http://api.wildapricot.org">2Checkout</Name>
<DisplayPosition>510</DisplayPosition>
<IsCustom>false</IsCustom>
</Tender>
<Tender>
<Id xmlns="http://api.wildapricot.org">48359</Id>
<Url xmlns="http://api.wildapricot.org">http://api.wildapricot.org/v2/accounts/42353/Tenders/48359</Url>
<Name xmlns="http://api.wildapricot.org">2Checkout Recurring Payment</Name>
<DisplayPosition>511</DisplayPosition>
<IsCustom>false</IsCustom>
</Tender>
<Tender>
<Id xmlns="http://api.wildapricot.org">48315</Id>
<Url xmlns="http://api.wildapricot.org">http://api.wildapricot.org/v2/accounts/42353/Tenders/48315</Url>
<Name xmlns="http://api.wildapricot.org">BluePay Credit Card</Name>
<DisplayPosition>610</DisplayPosition>
<IsCustom>false</IsCustom>
</Tender>
<Tender>
<Id xmlns="http://api.wildapricot.org">48316</Id>
<Url xmlns="http://api.wildapricot.org">http://api.wildapricot.org/v2/accounts/42353/Tenders/48316</Url>
<Name xmlns="http://api.wildapricot.org">BluePay Recurring Payment</Name>
<DisplayPosition>611</DisplayPosition>
<IsCustom>false</IsCustom>
</Tender>
<Tender>
<Id xmlns="http://api.wildapricot.org">48317</Id>
<Url xmlns="http://api.wildapricot.org">http://api.wildapricot.org/v2/accounts/42353/Tenders/48317</Url>
<Name xmlns="http://api.wildapricot.org">CRE Secure Credit Card</Name>
<DisplayPosition>710</DisplayPosition>
<IsCustom>false</IsCustom>
</Tender>
<Tender>
<Id xmlns="http://api.wildapricot.org">48318</Id>
<Url xmlns="http://api.wildapricot.org">http://api.wildapricot.org/v2/accounts/42353/Tenders/48318</Url>
<Name xmlns="http://api.wildapricot.org">CRE Secure Recurring Payment</Name>
<DisplayPosition>711</DisplayPosition>
<IsCustom>false</IsCustom>
</Tender>
<Tender>
<Id xmlns="http://api.wildapricot.org">48319</Id>
<Url xmlns="http://api.wildapricot.org">http://api.wildapricot.org/v2/accounts/42353/Tenders/48319</Url>
<Name xmlns="http://api.wildapricot.org">Global Payments Credit Card</Name>
<DisplayPosition>810</DisplayPosition>
<IsCustom>false</IsCustom>
</Tender>
<Tender>
<Id xmlns="http://api.wildapricot.org">48320</Id>
<Url xmlns="http://api.wildapricot.org">http://api.wildapricot.org/v2/accounts/42353/Tenders/48320</Url>
<Name xmlns="http://api.wildapricot.org">IATS Credit Card</Name>
<DisplayPosition>910</DisplayPosition>
<IsCustom>false</IsCustom>
</Tender>
<Tender>
<Id xmlns="http://api.wildapricot.org">48321</Id>
<Url xmlns="http://api.wildapricot.org">http://api.wildapricot.org/v2/accounts/42353/Tenders/48321</Url>
<Name xmlns="http://api.wildapricot.org">IATS Recurring Payment</Name>
<DisplayPosition>911</DisplayPosition>
<IsCustom>false</IsCustom>
</Tender>
<Tender>
<Id xmlns="http://api.wildapricot.org">48322</Id>
<Url xmlns="http://api.wildapricot.org">http://api.wildapricot.org/v2/accounts/42353/Tenders/48322</Url>
<Name xmlns="http://api.wildapricot.org">Moneris Credit Card</Name>
<DisplayPosition>1010</DisplayPosition>
<IsCustom>false</IsCustom>
</Tender>
<Tender>
<Id xmlns="http://api.wildapricot.org">48323</Id>
<Url xmlns="http://api.wildapricot.org">http://api.wildapricot.org/v2/accounts/42353/Tenders/48323</Url>
<Name xmlns="http://api.wildapricot.org">Moneris Recurring Payment</Name>
<DisplayPosition>1011</DisplayPosition>
<IsCustom>false</IsCustom>
</Tender>
<Tender>
<Id xmlns="http://api.wildapricot.org">48327</Id>
<Url xmlns="http://api.wildapricot.org">http://api.wildapricot.org/v2/accounts/42353/Tenders/48327</Url>
<Name xmlns="http://api.wildapricot.org">Skrill</Name>
<DisplayPosition>1110</DisplayPosition>
<IsCustom>false</IsCustom>
</Tender>
<Tender>
<Id xmlns="http://api.wildapricot.org">48328</Id>
<Url xmlns="http://api.wildapricot.org">http://api.wildapricot.org/v2/accounts/42353/Tenders/48328</Url>
<Name xmlns="http://api.wildapricot.org">Skrill Recurring Payment</Name>
<DisplayPosition>1111</DisplayPosition>
<IsCustom>false</IsCustom>
</Tender>
</ArrayOfTender>

0 Comments

Please sign in to leave a comment.

Search: WildApricot.com 

About results ( seconds) Sort by: 
Sorry, an error occured when performing search.