Dwolla Developers Logo
Back
API Reference
  • SDK Support
    Drop-in Components
    Authorization
    Root
    Accounts
    Customers
    Knowledge-based Authentication (KBA)
    Beneficial Owners
    Documents
    Funding Sources
    Transfers
    Mass payments
    OverviewInitiate a mass paymentRetrieve a mass paymentUpdate a mass paymentList items for a mass paymentRetrieve a mass payment itemList mass payments for a customer
    Labels
    Events
    Webhook subscriptions
    Webhooks
CommunityOpen in new tabChangelog
Get API Keys
CommunityOpen in new tabChangelog
JavaScript
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 #

ParameterRequiredTypeDescriptionidyesstringCustomer unique identifier to get mass payments for.limitnointegerHow many results to return. Defaults to 25.offsetnointegerHow many results to skip.correlationIdnostringA string value to search on if a correlationId was specified on a mass payment.

HTTP status and error codes #

HTTP StatusCodeDescription403NotAuthorizedNot authorized to list mass payments.404NotFoundCustomer not found.

Request and response #

JavaScript
// Using dwolla-v2 - https://github.com/Dwolla/dwolla-v2-node
var customerUrl =
  "https://api-sandbox.dwolla.com/customers/ca32853c-48fa-40be-ae75-77b37504581b";

dwolla
  .get(`${customerUrl}/mass-payments`, { limit: 10 })
  .then((res) => res.body._embedded["mass-payments"][0].status); // => "complete"

Test in the Sandbox for free today.

Use sandbox environment to test API requests.

Get API Keys
2022 All Rights Reserved

Dwolla

  • About
  • Blog
  • Pricing
  • Contact Sales
  • Terms of Service
  • Privacy Policy
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.