DocsRetrieve a mass payment #
This section outlines how to retrieve a mass payment by its id. All mass payments will have a status of pending upon creation and will move to processing and finally complete as the service runs. It is recommended that you retrieve your list of mass payment items when your mass payment has a status of complete to determine if any items failed to process successfully.
HTTP request #
GET https://api.dwolla.com/mass-payments/{id}
Request parameters #
| Parameter | Required | Type | Description |
|---|---|---|---|
| id | yes | string | The id of the mass payment to retrieve information for. |
HTTP status and error codes #
| HTTP Status | Code | Description |
|---|---|---|
| 404 | NotFound | Mass payment not found. |
Request and response #
GET https://api-sandbox.dwolla.com/mass-payments/eb467252-808c-4bc0-b86f-a5cd01454563
Accept: application/vnd.dwolla.v1.hal+json
Authorization: Bearer pBA9fVDBEyYZCEsLf/wKehyh1RTpzjUj5KzIRfDi0wKTii7DqY
...
{
"_links": {
"self": {
"href": "https://api-sandbox.dwolla.com/mass-payments/eb467252-808c-4bc0-b86f-a5cd01454563"
},
"source": {
"href": "https://api-sandbox.dwolla.com/funding-sources/707177c3-bf15-4e7e-b37c-55c3898d9bf4"
},
"items": {
"href": "https://api-sandbox.dwolla.com/mass-payments/eb467252-808c-4bc0-b86f-a5cd01454563/items"
}
},
"id": "eb467252-808c-4bc0-b86f-a5cd01454563",
"status": "processing",
"created": "2016-03-18T19:44:16.000Z",
"metadata": {}
}
Previous
2024 All Rights Reserved
Financial institutions play an important role in our network.
All funds transfers made using the Dwolla Platform are performed by a financial institution partner, and any funds held in a Dwolla Balance are held by a financial institution partner. Learn more about our financial institution partners.