When you Create
BatchPayments, you must provide a
payments array as part of your
BatchPaymentPayload.payments array is populated with
BatchPaymentItemPayload objects, which define the how you want your funds to be allocated.
Properties in bold are required.
|Identifies if a
BatchPaymentItem is allocated to a
Servicer or a specific
|The amount to pay to the defined
|A UUID identifying the
Borrower on behalf of whom this
BatchPaymentItem is allocated.
|An arbitrary string that must be unique for each batch.
Not required, but highly recommended.
reference_id must not be the same value as the one you provided for the
A few words about
You will notice that you can supply a
BatchPaymentItemobjects when you create them via their relevant
Payloadobjects. While these fields are not required, we highly recommend always providing a unique value for each
reference_idproperty in your API request payloads. Providing a UUID is an easy way to ensure you always have unique
reference_idvalues for your
reference_idvalues should be a unique identifier created and stored in your application to identify this
BatchPaymentItemfor your system.
We will use the
reference_id, when available, to ensure idempotency across Create
BatchPaymentrequests (ensuring you always get the same
BatchPaymentoutcome even if you resubmit the same request).
We will associate the
reference_idof an item in your
BatchPaymentItemPayloadif the Create
BatchPaymentsrequest fails—allowing you to identify the offending item in your payload that did not pass validation.
reference_idcan be used to ensure you are able to match your platform's internal representation of a
BatchPaymentItemwith its Payitoff
reference_idcan help facilitate auditing your
BatchPaymentrequests between your internal systems and the Payitoff API fulfilling
reference_idis a string field that allows any value, to provide maximum flexibility to provide your own identification scheme.
Updated about 2 years ago