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. |
GET https://api-sandbox.dwolla.com/customers/33e56307-6754-41cb-81e2-23a7f1072295/transfers
Accept: application/vnd.dwolla.v1.hal+json
Authorization: Bearer pBA9fVDBEyYZCEsLf/wKehyh1RTpzjUj5KzIRfDi0wKTii7DqY
...
{
"_links": {
"self": {
"href": "https://api-sandbox.dwolla.com/customers/33e56307-6754-41cb-81e2-23a7f1072295/transfers"
},
"first": {
"href": "https://api-sandbox.dwolla.com/customers/33e56307-6754-41cb-81e2-23a7f1072295/transfers?&limit=25&offset=0"
},
"last": {
"href": "https://api-sandbox.dwolla.com/customers/33e56307-6754-41cb-81e2-23a7f1072295/transfers?&limit=25&offset=0"
}
},
"_embedded": {
"transfers": [
{
"_links": {
"self": {
"href": "https://api-sandbox.dwolla.com/transfers/61cbc6db-19f4-e811-8112-e8dd3bececa8"
},
"source": {
"href": "https://api-sandbox.dwolla.com/customers/39e21228-5958-4c4f-96fe-48a4bf11332d"
},
"source-funding-source": {
"href": "https://api-sandbox.dwolla.com/funding-sources/73ce02cb-8857-4f01-83fc-b6640b24f9f7"
},
"destination": {
"href": "https://api-sandbox.dwolla.com/customers/33e56307-6754-41cb-81e2-23a7f1072295"
},
"destination-funding-source": {
"href": "https://api-sandbox.dwolla.com/funding-sources/ac6d4c2a-fda8-49f6-805d-468066dd474c"
},
},
"id": "461cbc6db-19f4-e811-8112-e8dd3bececa8",
"status": "pending",
"amount": {
"value": "225.00",
"currency": "USD"
},
"created": "2018-11-29 21:00:59 UTC",
"metadata": {
"foo": "bar",
"baz": "foo"
}
},
{
"_links": {
"self": {
"href": "https://api-sandbox.dwolla.com/transfers/76e5541d-18f4-e811-8112-e8dd3bececa8"
},
"source": {
"href": "https://api-sandbox.dwolla.com/customers/0e309d41-a5df-4105-97da-2c6739e71a67"
},
"source-funding-source": {
"href": "https://api-sandbox.dwolla.com/funding-sources/73ce02cb-8857-4f01-83fc-b6640b24f9f7"
},
"destination": {
"href": "https://api-sandbox.dwolla.com/customers/33e56307-6754-41cb-81e2-23a7f1072295"
},
"destination-funding-source": {
"href": "https://api-sandbox.dwolla.com/funding-sources/ac6d4c2a-fda8-49f6-805d-468066dd474c"
}
},
"id": "76e5541d-18f4-e811-8112-e8dd3bececa8",
"status": "pending",
"amount": {
"value": "225.00",
"currency": "USD"
},
"created": "2015-10-02T19:40:41.437Z",
"metadata": {
"foo": "bar",
"baz": "foo"
}
}
]
},
"total": 2
}
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.