BatchPaymentItemPayload
Payitoff API: BatchPaymentItemPayload
Schema
When you Create BatchPayments
, you must provide a payments
array as part of your BatchPaymentPayload
. The BatchPaymentPayload.payments
array is populated with BatchPaymentItemPayload
objects, which define the how you want your funds to be allocated.
Schema Definition
Properties in bold are required.
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 to pay to the defined allocation . |
borrower_id | string | uuid | A UUID identifying the Borrower on behalf of whom this BatchPaymentItem is allocated. |
reference_id | string | An arbitrary string that must be unique for each batch. Not required, but highly recommended. NOTE: This reference_id must not be the same value as the one you provided for the BatchPayment . |
A few words about
reference_id
valuesYou will notice that you can supply a
reference_id
forBatchPayment
andBatchPaymentItem
objects when you create them via their relevantPayload
objects. While these fields are not required, we highly recommend always providing a unique value for eachreference_id
property in your API request payloads. Providing a UUID is an easy way to ensure you always have uniquereference_id
values for yourBatchPayment
andBatchPaymentItem
objects.
Get the most out ofreference_id
Your
reference_id
values should be a unique identifier created and stored in your application to identify thisBatchPaymentItem
for your system.We will use the
reference_id
, when available, to ensure idempotency across CreateBatchPayment
requests (ensuring you always get the sameBatchPayment
outcome even if you resubmit the same request).We will associate the
reference_id
of an item in yourBatchPaymentItemPayload
if the CreateBatchPayments
request fails—allowing you to identify the offending item in your payload that did not pass validation.The
reference_id
can be used to ensure you are able to match your platform's internal representation of aBatchPaymentItem
with its PayitoffBatchPaymentItem
record.The
reference_id
can help facilitate auditing yourBatchPayment
requests between your internal systems and the Payitoff API fulfillingBatchPayment
requests.The
reference_id
is a string field that allows any value, to provide maximum flexibility to provide your own identification scheme.
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": "b123-1"
}
Updated over 2 years ago