mass payments
Initiate a mass payment
Create a mass payment containing up to 5,000 individual payment items from a Dwolla Main Account or Verified Customer funding source. Supports optional metadata, correlation IDs for traceability, deferred processing, and expedited transfer options including same-day ACH clearing. Returns the location of the created mass payment resource with a unique identifier for tracking and management.
post/mass-payments
Headers
Accept'application/vnd.dwolla.v1.hal+json' required
The media type of the response. Must be application/vnd.dwolla.v1.hal+json
Idempotency-Keystring
Request body
Example request
{
"_links": {
"source": {
"href": "https://api.dwolla.com/funding-sources/707177c3-bf15-4e7e-b37c-55c3898d9bf4"
}
},
"items": [
{
"_links": {
"destination": {
"href": "https://api.dwolla.com/funding-sources/9c7f8d57-cd45-4e7a-bf7a-914dbd6131db"
}
},
"amount": {
"value": "5.00",
"currency": "USD"
},
"processingChannel": {
"destination": "real-time-payments"
},
"clearing": {
"destination": "next-available"
},
"achDetails": {
"destination": {
"addenda": {
"values": [
"XYZ987_AddendaValue"
]
}
}
},
"correlationId": "ad6ca82d-59f7-45f0-a8d2-94c2cd4e8841"
}
],
"status": "deferred",
"achDetails": {
"source": {
"addenda": {
"values": [
"ZYX987_AddendaValue"
]
}
}
},
"clearing": {
"source": "next-available"
},
"correlationId": "ad6ca82d-59f7-45f0-a8d2-94c2cd4e8841"
}Response
created