Overview
Labels represent a designated portion of funds within a Verified Customer’s balance. Create, remove, and list them using the Dwolla API.
Labels
A Label represents a designated portion of funds within a Verified Customer’s balance. To create a label, you’ll specify the ID of a Verified Customer and an amount. Your application will maintain any other Label information or associations. Labels can be created, updated, and deleted. You can also list all Labels for a Verified Customer Record and list all entries for a specified Label. Note that a Verified Customer’s labeled amounts cannot exceed the balance available in such Verified Customer’s account.
This section outlines a premium feature for the Dwolla API. To learn more about pricing and enabling this functionality, please contact Sales.
Label Links
Link | Description |
---|---|
self | URL of the Label resource. |
ledger-entries | GET this link to list the ledger entries for a Label. |
update | GET this link to update the ledger for this Verified Customer. |
remove | GET this link to remove the Label for this Verified Customer. |
Label resource
Parameter | Description |
---|---|
_links | A _links JSON object that contains links to suggested resources and actions available based on the current context. |
id | A Label unique identifier. |
amount | An Amount JSON object that contains value and currency keys. Reference the amount object to learn more. |
created | ISO-8601 timestamp. |
Amount object
Parameter | Description |
---|---|
value | Amount of funds. |
currency | Acceptable values: USD |