get https://secure.fusebill.com/v1/customers//childPaymentActivities?query=field:querystring&pageSize=100&pageNumber=0
This request is used to get a list of a customer's child's payment activities done through one of the parent's payment methods. Customer hierarchies are not a default part of Fusebill, this must be enabled during account set up.
Path Parameters
Property | Type | Description |
---|---|---|
customerId | Integer | The Fusebill generated ID that uniquely identifies the parent customer |
This call supports string filtering (Read More) and datetime/numeric range filtering (Read More)
&query=parameterName:Value
Parameter Name | Acceptable Values | Parameter Name | Acceptable Values |
---|---|---|---|
amount | Decimal Range | parentCustomerId | Integer |
createdTimestamp | Date Range | PaymentActivityStatus | Failed, Successful, Unknown |
customerId | Integer | PaymentMethodType | Check, DirectDeposit, CreditCard, Cash, ACH, Paypal |
effectiveTimestamp | Date Range | PaymentSource | Manual, Automatic, SelfServicePortal, Import |
GatewayName | String | PaymentType | Validate, Collect, Refund |
modifiedTimestamp | Date Range |
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/customers/{CustomerId}/childPaymentActivities \
-H "Content-Type: application/json" \
-H "Authorization: Basic {APIKey}"
//Setup customer ID
Int parentId= {customerId}
//Setup API key
string apiKey = "{APIKey}";
//Configure URI
WebRequest request = WebRequest.Create("HTTPS://secure.fusebill.com/v1/customers/" + parentId + "/childPaymentActivities");
//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/customers/{paymentId}/childPaymentActivities', headers=headers)
print(r.content)
Response
[
{
"customerId": 100156,
"status": "Successful",
"effectiveTimestamp": "2019-08-11T11:13:36",
"createdTimestamp": "2019-05-11T05:49:31",
"source": "Manual",
"method": "CreditCard (Visa ending in 1111)",
"transactionType": "Collect",
"amount": 5,
"gatewayFee": null,
"currency": "USD",
"transaction": {
"paymentActivityId": 156489,
"reference": null,
"effectiveTimestamp": "2019-09-26T06:15:14",
"description": null,
"customerId": 100156,
"originalPaymentActivityId": null,
"amount": 5,
"currency": "USD",
"invoiceAllocations": [
{
"invoiceId": 12555,
"invoiceNumber": 5,
"amount": 5,
"outstandingBalance": 0,
"invoiceTotal": 5,
"netsuiteId": null,
"quickbooksId": null,
"uri": "https://secure.fusebill.com/v1/invoices/12555"
}
],
"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": 2897423,
"gatewayName": "Test CC",
"secondaryTransactionNumber": "4bc3455c-cc77-c26c-163aab839cb4319c"
},
"methodIsAch": false,
"parentCustomerId": null,
"reconciliationId": "54951b79-88f5-b879-579a12d359e",
"id": 584679,
"uri": "https://secure.fusebill.com/v1/PaymentActivities/584679"
}
]
{
"ErrorId": 0,
"HttpStatusCode": 400,
"Errors": [
{
"Key": "Api Error",
"Value": "Bad request, the query is not valid. Please check your request and try again."
}
]
}