Read All Payment Activities

This request returns a list of payment activities across your account

Due to the likely size of the response, It is strongly recommended that query parameters are used to filter the response in addition to pagination.

This call supports string filtering (Read More) and datetime/numeric range filtering (Read More)
&query=parameterName:Value

Parameter NameAcceptable ValuesParameter NameAcceptable Values
amountDecimal RangeCustomer.MonthlyRecurringRevenueDecimal Range
createdTimestampDate RangeCustomer.NetMRRDecimal Range
customerIdIntegerCustomer.NetSuiteIdString
Customer.AccountStatusGood, PoorStanding, CollectionCustomer.ParentIdInteger
Customer.ArbalanceDecimal RangeCustomer.QuickBooksIdInteger
Customer.CompanyNameStringCustomer.ReferenceString
Customer.CreatedTimestampDate RangeCustomer.SalesforceIdString
Customer.CurrencyIdInteger (1-24)*Customer.StatusDraft, Active, Cancelled, Hold, Suspended
Customer.CurrentMrrDecimal RangeeffectiveTimestampDate Range
Customer.CustomerReference.Reference1StringGatewayNameString
Customer.CustomerReference.Reference2StringmodifiedTimestampDate Range
Customer.CustomerReference.Reference3StringparentCustomerIdInteger
Customer.FirstNameStringPaymentActivityStatusFailed, Successful, Unknown
Customer.LastNameStringPaymentMethodTypeCheck, DirectDeposit, CreditCard, Cash, ACH, Paypal
Customer.MiddleNameStringPaymentSourceManual, Automatic, SelfServicePortal, Import
Customer.ModifiedTimestampDate RangePaymentTypeValidate, Collect, Refund

* See here for Fusebill currency codes
This call supports pagination (Read More)
&pageSize=100&pageNumber=0
This call supports sorting (Read More)
&sortOrder=Ascending or &sortOrder=Descending
&sortExpression=expression

Examples
curl –X GET https://secure.fusebill.com/v1/PaymentActivities/GetByAccountID \ 
-H "Content-Type: application/json" \ 
-H "Authorization: Basic {APIKey}"
//Setup API key 
string apiKey = "{APIKey}"; 
//Configure URI 
WebRequest request = WebRequest.Create("HTTPS://secure.fusebill.com/v1/PaymentActivities/GetByAccountID"); 
//Add Content type 
request.ContentType = "application/json"; 
request.ContentLength = 0; 
//Add Api key authorization 
request.Headers.Add(HttpRequestHeader.Authorization, "Basic "+apiKey); 
//Set request method 
request.Method = "GET"; 
//Perform the request 
var httpResponse = (HttpWebResponse)request.GetResponse(); 
//Record the response from our request 
var result = ""; 
using (var streamReader = new StreamReader(httpResponse.GetResponseStream())) 
{ 
  result = streamReader.ReadToEnd(); 
}
#Import library Requests 
import requests 
#Pass in a dictionary to the Headers parameter 
headers = {'Authorization' : 'Basic {APIKey}', 'Content-Type' : 'application/json'} 
#Pass in your URI and Headers 
r = requests.get('https://secure.fusebill.com/v1/PaymentActivities/GetByAccountID', headers=headers) 
print(r.content)
Response
[
  {
    "customerId": 100156,
    "status": "Successful",
    "effectiveTimestamp": "2019-08-25T11:58:24",
    "createdTimestamp": "2019-06-20T06:50:21",
    "source": "Manual",
    "method": "CreditCard (Visa ending in 1111)",
    "transactionType": "Collect",
    "amount": 5,
    "gatewayFee": null,
    "currency": "USD",
    "transaction": {
      "paymentActivityId": 56137456,
      "reference": null,
      "effectiveTimestamp": "2019-07-21T08:38:26",
      "description": null,
      "customerId": 100156,
      "originalPaymentActivityId": null,
      "amount": 5,
      "currency": "USD",
      "invoiceAllocations": [],
      "refunds": [],
      "unallocatedAmount": 5,
      "refundableAmount": 5,
      "gatewayFee": null,
      "settlement": null,
      "id": 87874562,
      "uri": "https://secure.fusebill.com/v1/payments/87874562"
    },
    "paymentGateway": {
      "authorizationCode": "4f25ecdd-9911-4381-b046-ab45156cf175",
      "authorizationResponse": null,
      "gatewayId": 2987320,
      "gatewayName": "Test CC",
      "secondaryTransactionNumber": "4bc3455c-cc77-c26c-163aab839cb4319c"
    },
    "methodIsAch": false,
    "parentCustomerId": null,
    "reconciliationId": "54951b79-88f5-b879-579a12d359e",
    "id": 593374,
    "uri": "https://secure.fusebill.com/v1/PaymentActivities/593374"
  }
]
{
    "ErrorId": 0,
    "HttpStatusCode": 400,
    "Errors": [
        {
            "Key": "Api Error",
            "Value": "Bad request, the query is not valid.  Please check your request and try again."
        }
    ]
}
Language
Authorization