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.
POST https://api.dwolla.com/mass-payments/{id}
Parameter | Required | Type | Description |
---|---|---|---|
id | yes | string | id of mass payment to update. |
status | yes | string | Either pending or cancelled depending on the action you want to take on a deferred mass payment. |
HTTP Status | Code | Description |
---|---|---|
404 | NotFound | Mass payment not found. |
400 | ValidationError | Invalid status. Allowed types are pending, cancelled. |
// 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"
Use sandbox environment to test API requests.
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.