Create a mass payment
POST https://api-sandbox.dwolla.com/mass-payments
Initiate a mass payment from an Account or verified Customer resource. A mass payment contains a list of items representing individual payments. Optionally, mass payments can contain metadata on the mass payment itself as well as items contained in the mass payment which can be used to pass along additional information with the mass payment and item respectively.
Request parameters
| Parameter | Data Type | Parameter Type | Required | Description |
|---|---|---|---|---|
| _links | object | body | yes | A _links JSON object describing the desired source of a mass payment. Reference the Source and Destination object to learn more about possible values for source and destination. |
| items | array | body | yes | an array of item JSON objects that contain unique payments. See below |
| metadata | object | body | yes | A metadata JSON object with a maximum of 10 key-value pairs (each key and value must be less than 255 characters). |
| status | string | body | yes | Acceptable value is: deferred. |
| achDetails | object | body | no | An ACH details JSON object which represents additional information sent along with a transfer created from a mass payment item to an originating or receiving financial institution. Details within this object can be used to reference a transaction that has settled with a financial institution. See below |
| correlationId | string | body | no | A unique string value attached to a mass payment which can be used for traceability between Dwolla and your application. Must be less than 255 characters and contain no spaces. Acceptable characters are: a-Z, 0-9, -, ., and _. |
Request Body
{"_links"=>{"source"=>{"href"=>"https://api-sandbox.dwolla.com/funding-sources/{{sourceFundingSourceId}}"}}, "items"=>[{"_links"=>{"destination"=>{"href"=>"https://api-sandbox.dwolla.com/funding-sources/{{destinationFundingSourceId1}}"}}, "amount"=>{"currency"=>"USD", "value"=>"1.00"}}, {"_links"=>{"destination"=>{"href"=>"https://api-sandbox.dwolla.com/funding-sources/{{destinationFundingSourceId2}}"}}, "amount"=>{"currency"=>"USD", "value"=>"5.00"}}]}
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Content-Type | string | ||
Accept | string | ||
Authorization | string | ||
Idempotency-Key | string |