While the payment object represents the details of a payment made by a customer, the payment activities object covers events even if there's no associated transaction ID or activity in accounts receivable. For example, It includes card validations and failed collection attempts. All payment objects contain a payment activity ID for the (successful) payment activity and possibly a payment activity ID for the (successful) refund payment activity.
Payment Activity Object Fields
| Property | Type | Description |
|---|---|---|
customerId | Integer | The Fusebill generated ID that uniquely identifies the customer object. [Read Only] |
status | Enum:{Successful, Failed, Unknown} | Indicates whether the activity failed, succeeded, or is an unknown status |
effectiveTimestamp | Timestamp | The time this payment activity effectively occurred |
createdTimestamp | Timestamp | The time this object was created |
source | Enum:{Manual, Automatic, SelfServicePortal, Import} | Indicates the source of this activity |
method | String | A description of the payment method involved e.g "CreditCard (Visa ending in 1234)" [Read Only] |
transactionType | Enum: {NSF, Validate, Collect, Refund} | Indicates the type of transaction this payment activity relates to |
amount | Decimal | The amount involved with this payment activity. Potentially zero if the payment activity does not involve monetary movement such as a credit card validation. |
gatewayFee | Decimal | The amount charged by the gateway. Null if not applicable. |
currency | 3 character ISO code | The unit of financial measurements on this object |
transaction | Object. See Payments: Payment Object for details | A payment object if this payment activity has an associated payment. |
methodIsAch | Boolean | True if the method used was ACH |
parentCustomerId | Integer | The Fusebill generated ID of the parent customer if customer hierarchy is being used. [Read Only] |
reconciliationId | String | The ID to be used for reconciliation |
id | Integer | The Fusebill generated ID that identifies this payment activity [Read Only] |
uri | String | The full string path to this resource [Read Only] |