This section covers how to retrieve the total and available amount for a Dwolla balance funding source. The funding source type balance
exists for Verified Customer accounts and represents a balance held in the Dwolla network.
A Dwolla Wallet Balance, also referred to as Dwolla Balance, is a funding source within the Dwolla platform that can be utilized like a "wallet" for holding a stored value of USD funds. It is made available for account types that have completed "KYC" requirements, which includes clients of Dwolla and their end users that have been on-boarded as Verified Customers. All funds held in a Dwolla Balance are held by Dwolla’s financial institution partner(s) and not by Dwolla.
There are two different amounts returned in the API response when retrieving a balance which correspond to a total
and available
balance. Note: Unless your application utilizes Labels functionality, the amounts that are returned in both the balance
and total
objects will be the same. Available balance can be accessed via the balance
attribute, whereas total balance can be accessed via the total
attribute within the Balance object. Both balance
and total
are JSON objects that contain key value pairs for value
and currency
.
The amount of funds readily available in a Verified Customer Record’s balance that can be sent, withdrawn, or labeled.
Represents the Verified Customer Record’s total balance held in the Dwolla network. This includes both labeled funds and the Available Balance, i.e. both labeled and unlabeled funds.
GET https://api.dwolla.com/funding-sources/{id}/balance
Parameter | Required | Type | Description |
---|---|---|---|
id | yes | string | id of funding source to retrieve a balance for. |
HTTP Status | Code | Description |
---|---|---|
404 | NotFound | Funding source not found. |
GET https://api-sandbox.dwolla.com/funding-sources/c2eb3f03-1b0e-4d18-a4a2-e552cc111418/balance
Accept: application/vnd.dwolla.v1.hal+json
Authorization: Bearer pBA9fVDBEyYZCEsLf/wKehyh1RTpzjUj5KzIRfDi0wKTii7DqY
{
"_links": {
"self": {
"href": "https://api-sandbox.dwolla.com/funding-sources/c2eb3f03-1b0e-4d18-a4a2-e552cc111418/balance",
"type": "application/vnd.dwolla.v1.hal+json",
"resource-type": "balance"
},
"funding-source": {
"href": "https://api-sandbox.dwolla.com/funding-sources/c2eb3f03-1b0e-4d18-a4a2-e552cc111418",
"type": "application/vnd.dwolla.v1.hal+json",
"resource-type": "funding-source"
}
},
"balance": {
"value": "4616.87",
"currency": "USD"
},
"total": {
"value": "4616.87",
"currency": "USD"
},
"lastUpdated": "2017-04-18T15:20:25.880Z"
}
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.