This section details how to retrieve a Customer's list of transfers. Transaction search is supported by passing in optional querystring parameters such as: search
which represents a term to search on, correlationId
, startAmount
, endAmount
, startDate
, endDate
, and status
.
GET https://api.dwolla.com/customers/{id}/transfers
Parameter | Required | Type | Description |
---|---|---|---|
id | yes | string | Customer unique identifier to get transfers for. |
search | no | string | A string to be matched with firstName , lastName , email , businessName , Customer Id, and Account Id. (/transfers?search=Doe ) |
startAmount | no | string | Only include transactions with an amount equal to or greater than startAmount . Can optionally be used with endAmount to specify an amount range. |
endAmount | no | string | Only include transactions with an amount equal to or less than endAmount . Can optionally be used with startAmount to specify an amount range. |
startDate | no | string | Only include transactions created after this date. ISO-8601 format: YYYY-MM-DD . Can optionally be used with endDate to specify a date range. |
endDate | no | string | Only include transactions created before this date. ISO-8601 format: YYYY-MM-DD . Can optionally be used with startDate to specify a date range. |
status | no | string | Filter results on transaction status. Possible values: pending , processed , failed , or cancelled . |
correlationId | no | string | A string value to search on if a correlationId was specified on a transfer or mass payment item. |
limit | no | integer | Number of search results to return. Defaults to 25. |
offset | no | integer | Number of search results to skip. Used for pagination. |
HTTP Status | Message |
---|---|
403 | Not authorized to list transfers. |
404 | Customer not found. |
// Using dwolla-v2 - https://github.com/Dwolla/dwolla-v2-node
var customerUrl =
"http://api-sandbox.dwolla.com/customers/33e56307-6754-41cb-81e2-23a7f1072295";
dwolla
.get(`${customerUrl}/transfers`)
.then((res) => res.body._embedded["transfers"][0].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.