Docs

Ask AI or search...

Select Language

Get API Keys

Select Product

Select Category

Home

API Reference

API Fundamentals
SDK Support
Drop-in Components
Authorization
Root
Accounts
Customers
Knowledge-based Authentication (KBA)
Beneficial Owners
Documents
Exchanges
Open Banking
Funding Sources
Transfers
Labels
Mass payments
Overview Initiate a mass payment Retrieve a mass payment Update a mass payment List items for a mass payment Retrieve a mass payment item List mass payments for a customer
Events
Webhook subscriptions
Webhooks

Get API Keys

List mass payments for a customer #

This section covers how to retrieve a verified Customer's list of previously created mass payments. Mass payments are returned ordered by date created, with most recent mass payments appearing first.

HTTP request #

GET https://api.dwolla.com/customers/{id}/mass-payments

Request parameters #

Parameter	Required	Type	Description
id	yes	string	Customer unique identifier to get mass payments for.
limit	no	integer	How many results to return. Defaults to 25.
offset	no	integer	How many results to skip.
correlationId	no	string	A string value to search on if a correlationId was specified on a mass payment.

HTTP status and error codes #

HTTP Status	Code	Description
403	NotAuthorized	Not authorized to list mass payments.
404	NotFound	Customer not found.

Request and response #

Raw

GET https://api-sandbox.dwolla.com/customers/39e21228-5958-4c4f-96fe-48a4bf11332d/mass-payments
Accept: application/vnd.dwolla.v1.hal+json
Authorization: Bearer pBA9fVDBEyYZCEsLf/wKehyh1RTpzjUj5KzIRfDi0wKTii7DqY

....

{
  "_links": {
    "self": {
      "href": "https://api-sandbox.dwolla.com/customers/39e21228-5958-4c4f-96fe-48a4bf11332d/mass-payments"
    },
    "first": {
      "href": "https://api-sandbox.dwolla.com/customers/39e21228-5958-4c4f-96fe-48a4bf11332d/mass-payments?limit=25&offset=0"
    },
    "last": {
      "href": "https://api-sandbox.dwolla.com/customers/39e21228-5958-4c4f-96fe-48a4bf11332d/mass-payments?limit=25&offset=0"
    }
  },
  "_embedded": {
    "mass-payments": [
      {
        "_links": {
          "self": {
            "href": "https://api-sandbox.dwolla.com/mass-payments/89ca72d2-63bf-4a8f-92ef-a5d00140aefa"
          },
          "source": {
            "href": "https://api-sandbox.dwolla.com/funding-sources/e1c972d4-d8d9-4c30-861a-9081dcbaf4ab"
          },
          "items": {
            "href": "https://api-sandbox.dwolla.com/mass-payments/89ca72d2-63bf-4a8f-92ef-a5d00140aefa/items"
          }
        },
        "id": "89ca72d2-63bf-4a8f-92ef-a5d00140aefa",
        "status": "complete",
        "created": "2016-03-21T19:27:34.000Z",
        "metadata": {
          "masspay1": "masspay1"
        },
        "correlationId": "8a2cdc8d-629d-4a24-98ac-40b735229fe2"
      }
    ]
  },
  "total": 1
}

Retrieve a mass payment item

Test in the Sandbox for free today.

Use sandbox environment to test API requests.

Get API Keys

Dwolla

Product

Developers

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.