BatchPaymentItem

A BatchPaymentItem is an object representing a singular allocation of funds within a BatchPayment.

When you Create BatchPayments you provide an array of BatchPaymentItemPayload objects in the payments array to describe how to allocate the BatchPayment. These will, upon passing validation, be returned from the API as BatchPaymentItem objects.

Schema Definition

Property	Type	Format	Description
`allocation`	`object`	`BatchPaymentAllocation`	Identifies if a `BatchPaymentItem` is allocated to a `Servicer` or a specific `PortfolioLoan`.
`amount`	`string`	`decimal`	The amount that will be paid to the defined `allocation`.
`borrower_id`	`string`	`uuid`	A UUID identifying the `Borrower` on behalf of whom this `BatchPaymentItem` is allocated.
`id`	`string`	`uuid`	The UUID that identifies this `BatchPaymentItem`.
`reference_id`	`string`		The `reference_id` value provided in your `BatchPaymentItemPayload`.
`status`	`string`		The status of this `BatchPaymentItem`.

Example

{
  "allocation": {
    "id": "75715081-e513-4008-ad68-fa195c9de9f9",
    "type": "loan"
  },
  "amount": "1.00",
  "borrower_id": "b72c6b71-5eaa-42e8-bd1b-7b0f12caea4c",
  "id": "fd3acad2-5e34-4718-bbe6-212a55cb4cbf",
  "reference_id": null,
  "status": "pending"
}