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

Update a mass payment #

This section covers how to update a mass payment's status to pending which triggers processing on a created and deferred mass payment, or cancelled which cancels a created and deferred mass payment.

HTTP request #

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

Request parameters #

ParameterRequiredTypeDescriptionidyesstringid of mass payment to update.statusyesstringEither pending or cancelled depending on the action you want to take on a deferred mass payment.

HTTP status and error codes #

HTTP StatusCodeDescription404NotFoundMass payment not found.400ValidationErrorInvalid status. Allowed types are pending, cancelled.

Request and response #

JavaScript
// Using dwolla-v2 - https://github.com/Dwolla/dwolla-v2-node
var massPaymentUrl =
  "https://api-sandbox.dwolla.com/mass-payments/692486f8-29f6-4516-a6a5-c69fd2ce854c";
var requestBody = {
  status: "pending",
};

dwolla.post(massPaymentUrl, requestBody).then((res) => res.body.status); // => "pending"

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.