Sign in
mass payments

Update a mass payment

Update the status of a deferred mass payment to control its processing lifecycle. Set status to pending to trigger processing and begin fund transfers, or cancelled to permanently cancel the mass payment before processing begins. Only applies to mass payments created with deferred status. Returns the updated mass payment resource with the new status.

post/mass-payments/{id}

Path parameters

idstring required

ID of mass payment to update

Headers

Accept'application/vnd.dwolla.v1.hal+json' required

The media type of the response. Must be application/vnd.dwolla.v1.hal+json

Request body

statusstring required

Example request

{
  "status": "pending"
}

Response

successful operation

Changes

Changed in 3 of the 34 revisions of this API.27

  • 633b30cf427d1See the full diff
    • ▲

      added the new required header request parameter Accept

      new-required-request-parameter

  • 231d0268586b15See the full diff
    • ▲

      request body became required

      request-body-became-required

    • ○

      api tag mass payments added

      api-tag-added

    • ○

      api tag massPayments removed

      api-tag-removed

    • ○

      added the non-success response with the status

      response-non-success-status-added

    • ○

      added the non-success response with the status

      response-non-success-status-added

    • ○

      added the non-success response with the status

      response-non-success-status-added

    This revision also has 5 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 9c0a7a5701292See the full diff
    • ○

      api tag massPayments added

      api-tag-added

    • ○

      api tag mass payments removed

      api-tag-removed