GetTransactions

Description

The GetTransactions API method returns a list of transactions accessible to the current user.  There are optional parameters to allow for filtering and sorting of the results.

URL

https://www.regonline.com/api/default.asmx/GetTransactions

Parameters

Note: Although not all parameters are required, if you do not want to use a particular parameter, an empty value must still be passed with the request.

filter
This parameter can be used to restrict the results returned from the methods.  Valid filter expressions are basically C# syntax and can contain some .NET framework method calls.  So, for example, if no filter is passed to GetTransactions(), then all transactions in the user’s account are returned (limited to 1000).  Or, filters such as the following can be used:

   Amount.HasValue && Amount.Value > 100
 
   Date.HasValue && Date.Value >= DateTime(2010, 1, 1)
 
   EventID == 555555

orderBy
This parameter defines the sort order of the results returned.  Valid expression syntax is similar to a SQL ORDER BY clause.  Taking the example of GetTransactions() again, if no orderBy is given, then the sort order is undefined.  Or, expressions such as the following can be used:

   Date DESC

Maximum Results

This method will return a maximum of 1000 results.

Returns

    <GetTransactionsResponse xmlns="https://www.regonline.com/api">
      <GetTransactionsResult>
        <Success>boolean</Success>
        <Message>string</Message>
        <Data>
          <APITransaction>
            <ID>int</ID>
            <EventID>int</EventID>
            <RegistrationID>int</RegistrationID>
            <Date>dateTime</Date>
            <TypeID>int</TypeID>
            <Type>string</Type>
            <Amount>decimal</Amount>
            <EventCurrency>string</EventCurrency>
            <GatewayAmount>decimal</GatewayAmount>
            <GatewayCurrency>string</GatewayCurrency>
            <CCName>string</CCName>
            <CCType>string</CCType>
            <CCLast4>string</CCLast4>
            <CCExpDate>dateTime</CCExpDate>
            <AuthCode>string</AuthCode>
            <GatewayTxnID>string</GatewayTxnID>
            <Gateway>string</Gateway>
            <SystemNotes>string</SystemNotes>
          </APITransaction>
          <APITransaction>
            ...
          </APITransaction>
        </Data>
      </GetTransactionsResult>
    </GetTransactionsResponse>

Transaction types

ID Description
1 Transaction Amount
2 Online Credit Card Payment
3 Online Credit Card Refund
4 Online Credit Card Chargeback
5 Offline Credit Card Payment
6 Offline Credit Card Refund
7 Offline Credit Card Chargeback
8 Check Payment
9 Check Refund
10 Credit Due to Cancellation
11 Other Payments
12 Other Credits
13 Other Charges
14 Adjustment Due to Changes in Fees
15 Cash Payment
16 Online Credit Card Chargeback Reversal
17 Other Refunds
18 Wire Transfer Payment
19 Wire Transfer Refund
20 ECheck Payment
21 ECheck Reversal – Generic
22 ECheck Reversal – Payment Authorization Invalid
23 ECheck Reversal – Clearance Request Invalid
24 ECheck Reversal – Transfer Amount Invalid
25 ECheck Reversal – Account Disabled
26 ECheck Reversal – Customer's Account Invalid
27 ECheck Reversal – Stop Payment
28 ECheck Reversal – Insufficient Funds
29 PayPal Payment
31 Charge Due to Uncancellation
32 Credit Due to Registration Transfer
33 Payment Due to Registration Transfer
34 Online Credit Card Void
36 Service Fee
37 Registration Protection
38 Merchandise Shipping Fee

Authentication

See Login documentation

Posted: June 30th, 2011

RegOnline by Lanyon is the easy-to-use, affordable online registration and event management software. Turn your next conference, meeting, trade show into a huge success. Event management solutions include online registration forms, event websites, badges, event marketing, credit card processing and so much more. Sign up today for a free trial.

TRUSTe online privacy certification Lanyon Solutions, Inc.
717 North Harwood
Dallas, Texas 75201
email: info@lanyon.com | Toll Free: 1-888-351-9948

 

© Copyright 2017 | RegOnline by Lanyon | All Rights Reserved