The payments resource represents the details of a successful payment made by a customer. This can be a manual payment, such as a check, or an automatically captured payment such as a payment made to cover the customer's recurring monthly charge. You are able to create new payments and view previous payments. Failed payment attempts do not result in a payment object. These instead result in a payment activity object
Payment Object Fields
| Property | Type | Description |
|---|---|---|
paymentActivityId | Integer | The Fusebill generated ID of the associated payment activity object [Read Only] |
reference | String | A custom string intended to explain why the payment was processed. [Max Length: 500 characters] |
effectiveTimestamp | Timestamp | The timestamp for when this payment occurred |
customerId | Integer | The Fusebill generated ID that uniquely identifies the customer [Read Only] |
amount | Decimal | The amount collected |
currency | 3 character ISO currency code | Indicates the unit of measurement used on this object |
invoiceAllocations | List of objects. See below for definition | Describes how this payment is allocated across the invoices of the customer |
refunds | List of objects. See Payments: Refund Object for definition | A list of refunds applied against this payment |
unallocatedAmount | Decimal | The amount of this payment which is neither refunded nor allocated to an invoice. This amount contributes to the customer's available funds |
refundableAmount | Decimal | The amount of the payment that is not yet refunded. |
gatewayFee | Decimal | The fee charged by the gateway |
settlement | Object. Defined below | Contains settlement details for the payment. Can be null |
id | Integer | The Fusebill generated ID that uniquely identifies this payment object [Read Only] |
uri | String | The full string path to this resource [Read Only] |
Invoice Allocation Fields
| Property | Type | Description |
|---|---|---|
invoiceId | Integer | The Fusebill generated ID that uniquely identifies this invoice [Read Only] |
invoiceNumber | Integer | The invoice number [Read Only] |
amount | Decimal | The amount of the payment that was allocated to this invoice |
outstandingBalance | Decimal | The current outstanding balance of the invoice. Not the amount that was outstanding at the time of payment |
invoiceTotal | Decimal | The total of the invoice |
netsuiteId | String | The ID of this invoice in Netsuite |
quickBooksId | Number | The ID of this invoice in QuickBooks |
uri | String | The full string path to the invoice [Read Only] |
Settlement Object
| Property | Type | Description |
|---|---|---|
status | Enum: {Unknown, Pending, Successful, Failed} | The status of the settlement |
modifiedTimestamp | Timestamp | The last modified timestamp |
lastCheckedTimestamp | Timestamp | The last settlement check timestamp |
nextCheckTimestamp | Timestamp | The next settlement check timestamp |
message | String | The settlement status message |