Get API Keys

Retrieve 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 #


Request parameters #

idyesstringThe id of the item to be retrieved in a mass payment.

HTTP status and error codes #

HTTP StatusCodeDescription
403ForbiddenNot authorized to list mass payment items.
404NotFoundMass payment not found.

Request and response #

Accept: application/vnd.dwolla.v1.hal+json
Authorization: Bearer pBA9fVDBEyYZCEsLf/wKehyh1RTpzjUj5KzIRfDi0wKTii7DqY


  "_links": {
    "self": {
      "href": ""
    "mass-payment": {
      "href": ""
    "destination": {
      "href": ""
    "transfer": {
      "href": ""
  "id": "2f845bc9-41ed-e511-80df-0aa34a9b2388",
  "status": "success",
  "amount": {
    "value": "1.00",
    "currency": "USD"
  "metadata": {
    "item1": "item1"
Test in the Sandbox for free today.
Use sandbox environment to test API requests.
Get API Keys
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.