Resources

Bulk Payments

BulkPayments is a JSON:API resource returned by Create Bulk Payment. Top-level fields:

Name	Type	Description
type	string	Type of the resource. The value is always bulkPayments.
attributes	JSON Object	JSON object representing the bulk payment run.

Attributes

Name	Type	Description
bulkId	string	Identifier of the bulk payment run. Generated by Unit. Used to correlate bulkPayments.failed and bulkPayments.finished webhook events.

The individual payments created by the bulk are standard payment resources (ACH, Book, Wire).

Example BulkPayments resource:

{
  "data": {
    "type": "bulkPayments",
    "attributes": {
      "bulkId": "18"
    }
  }
}