DocsRetrieve a mass payment item #
This section covers how to retrieve a mass payment item by its unique identifier. An item can contain _links to: the mass payment the item belongs to, the transfer created from the item, and the destination user.
HTTP request #
GET https://api.dwolla.com/mass-payment-items/{id}
Request parameters #
| Parameter | Required | Type | Description |
|---|---|---|---|
| id | yes | string | The id of the item to be retrieved in a mass payment. |
HTTP status and error codes #
| HTTP Status | Code | Description |
|---|---|---|
| 403 | Forbidden | Not authorized to list mass payment items. |
| 404 | NotFound | Mass payment not found. |
Request and response #
GET https://api-sandbox.dwolla.com/mass-payment-items/c1c7d293-63ec-e511-80df-0aa34a9b2388
Accept: application/vnd.dwolla.v1.hal+json
Authorization: Bearer pBA9fVDBEyYZCEsLf/wKehyh1RTpzjUj5KzIRfDi0wKTii7DqY
...
{
"_links": {
"self": {
"href": "https://api-sandbox.dwolla.com/mass-payment-items/c1c7d293-63ec-e511-80df-0aa34a9b2388"
},
"mass-payment": {
"href": "https://api-sandbox.dwolla.com/mass-payments/eb467252-808c-4bc0-b86f-a5cd01454563"
},
"destination": {
"href": "https://api-sandbox.dwolla.com/funding-sources/b442c936-1f87-465d-a4e2-a982164b26bd"
},
"transfer": {
"href": "https://api-sandbox.dwolla.com/transfers/fa3999db-41ed-e511-80df-0aa34a9b2388"
}
},
"id": "2f845bc9-41ed-e511-80df-0aa34a9b2388",
"status": "success",
"amount": {
"value": "1.00",
"currency": "USD"
},
"metadata": {
"item1": "item1"
}
}
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.