- SDK Support
Drop-in ComponentsAuthorizationRootAccountsOverviewRetrieve account detailsCreate a funding source for an accountList funding sources for an accountList and search transfers for an accountList mass payments for an account
CustomersKnowledge-based Authentication (KBA)Beneficial OwnersDocumentsExchangesFunding SourcesTransfersMass paymentsLabelsEventsWebhook subscriptionsWebhooks
List mass payments for an account #
This section covers how to retrieve an Account'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/accounts/{id}/mass-payments
Request parameters #
| Parameter | Required | Type | Description |
|---|---|---|---|
| id | yes | string | Account 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 | Account not found. |
Request and response #
// Using dwolla-v2 - https://github.com/Dwolla/dwolla-v2-node
var accountUrl =
"https://api-sandbox.dwolla.com/accounts/ca32853c-48fa-40be-ae75-77b37504581b";
dwolla
.get(`${accountUrl}/mass-payments`)
.then((res) => res.body._embedded["mass-payments"][0].status); // => 'complete'
PreviousTest in the Sandbox for free today.
Use sandbox environment to test API requests.
2023 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.