Skip to main content

Dwolla Data Source

The Dwolla connector enables you to ingest payment, customer, funding source, transfer, and compliance data from the Dwolla platform into your Nexla data flows. Follow the instructions below to create a new data flow that ingests data from a Dwolla source in Nexla.
dwolla_api.png

Dwolla

Create a New Data Flow

  1. To create a new data flow, navigate to the Integrate section, and click the New Data Flow button. Then, select the desired flow type from the list, and click the Create button.

  2. Select the Dwolla connector tile from the list of available connectors. Then, select the credential that will be used to connect to the Dwolla instance, and click Next; or, create a new Dwolla credential for use in this flow.

  3. In Nexla, Dwolla data sources can be created using pre-built endpoint templates, which expedite source setup for common Dwolla API endpoints. Each template is designed specifically for the corresponding Dwolla endpoint, making source configuration easy and efficient.
    • To configure this source using a template, follow the instructions in Configure Using a Template.

    Dwolla sources can also be configured manually, allowing you to ingest data from Dwolla endpoints not included in the pre-built templates or apply further customizations to exactly suit your needs.
    • To configure this source manually, follow the instructions in Configure Manually.

Configure Using a Template

Nexla provides pre-built templates that can be used to rapidly configure data sources to ingest data from common Dwolla endpoints. Each template is designed specifically for the corresponding Dwolla API endpoint, making data source setup easy and efficient.

Endpoint Settings

  • Select the endpoint from which this source will fetch data from the Endpoint pulldown menu. Available endpoint templates are listed in the expandable boxes below. Click on an endpoint to see more information about it and how to configure your data source for this endpoint.

Retrieve account details

Retrieves detailed information for a specific Dwolla account by its account ID. Use this endpoint to fetch account-level data such as name and account status for a known Dwolla account.

  • Enter the Dwolla Account ID in the Account ID field. This is the unique identifier for the Dwolla account you want to retrieve. You can find account IDs in the Dwolla Dashboard under your account overview, or by listing accounts programmatically via the Dwolla API.

  • This endpoint returns a single account record and does not paginate. No additional pagination settings are required.

For complete details on the account object returned by this endpoint, refer to the Dwolla Accounts API reference.

List and search account transfers

Retrieves a paginated list of transfers for a specific Dwolla account, with optional filtering by date range, amount range, status, and correlation ID. Use this endpoint to pull transfer history for reporting, reconciliation, or auditing purposes.

  • Enter the Dwolla Account ID in the Account ID field. This is the unique identifier for the account whose transfers you want to retrieve.
  • Optionally, apply one or more filters to narrow the results:

    • Search: Enter a search term to filter transfers by customer name or other searchable attributes.
    • Start Amount: Enter the minimum transfer amount (in USD) to include in results.
    • End Amount: Enter the maximum transfer amount (in USD) to include in results.
    • Start Date: Enter the earliest transfer creation date to include, in yyyy-MM-dd format (for example, 2024-01-01).
    • End Date: Enter the latest transfer creation date to include, in yyyy-MM-dd format.
    • Status: Filter by transfer status. Valid values include pending, processed, failed, and cancelled.
    • Correlation ID: Enter a correlation ID to retrieve only transfers that were tagged with that ID at creation time. Correlation IDs are optional identifiers your application can attach to transfers for internal tracking.
  • This endpoint uses offset-based pagination and will automatically retrieve additional pages of results as needed. The default page size is 25 records.

For complete details on transfer filtering parameters and the transfer object structure, refer to the Dwolla Transfers API reference.

List funding sources for an account

Retrieves a list of all funding sources (bank accounts) associated with a specific Dwolla account. Use this endpoint to get a complete view of the bank accounts linked to an account for payment operations, auditing, or customer service purposes.

  • Enter the Dwolla Account ID in the Account ID field. This is the unique identifier for the account whose funding sources you want to list.
  • Optionally, set the Removed parameter to control whether removed funding sources are included in the response:

    • Set to false (the default) to return only active funding sources.
    • Set to true to include funding sources that have been removed.
  • This endpoint uses offset-based pagination and will automatically retrieve additional pages as needed.

For complete details on the funding source object returned by this endpoint, refer to the Dwolla Funding Sources API reference.

List and search customers

Retrieves a paginated list of customers in your Dwolla account, with optional filtering by search term and status. Use this endpoint to sync customer records into your data pipeline for analytics, compliance, or CRM integrations.

  • Optionally, apply one or more of the following filters:

    • Search: Enter a search term to filter customers by name, email, or business name.
    • Status: Filter by customer status. Common values include unverified, verified, suspended, and deactivated.
  • This endpoint uses offset-based pagination (default page size: 25) and will automatically retrieve additional pages as needed.

Customers in Dwolla represent end users (individuals or businesses) who participate in payment flows. The status field reflects their identity verification state. For complete details, refer to the Dwolla Customers API reference.

Retrieve a customer

Retrieves detailed profile information for a specific Dwolla customer by their customer ID. Use this endpoint when you need to fetch the full record for a single known customer.

  • Enter the Dwolla Customer ID in the Customer ID field. Customer IDs can be obtained from the "List and search customers" endpoint or from the Dwolla Dashboard.
  • This endpoint returns a single customer record and does not paginate.

For complete details on the customer object, refer to the Dwolla Customers API reference.

List documents for customer

Returns a list of identity verification documents that have been uploaded for a specific customer. Use this endpoint to monitor document upload status as part of customer KYC (Know Your Customer) verification workflows.

  • Enter the Dwolla Customer ID in the Customer ID field. This is the unique identifier for the customer whose documents you want to list.
  • This endpoint returns all documents for the specified customer and does not paginate.

Documents are required for verifying certain customer types in Dwolla (for example, personal verified customers and business verified customers). For complete details, refer to the Dwolla Documents API reference.

List documents for beneficial owner

Returns a list of identity verification documents uploaded for a specific beneficial owner. Use this endpoint in compliance workflows for business customers that require beneficial ownership certification.

  • Enter the Dwolla Beneficial Owner ID in the Owner ID field. This is the unique identifier for the beneficial owner record. Beneficial owner IDs can be retrieved from the Dwolla API after listing beneficial owners for a business customer.
  • This endpoint returns all documents for the specified beneficial owner and does not paginate.

Beneficial ownership documentation is required for business verified customers as part of Dwolla's regulatory compliance requirements. For complete details, refer to the Dwolla Documents API reference.

List available exchange connections

Returns a list of available open banking exchange connections for a specific customer. Exchange connections represent bank account verification integrations through Dwolla's open banking partners (such as Plaid or MX), enabling instant account verification.

  • Enter the Dwolla Customer ID in the Customer ID field. This is the unique identifier for the customer whose exchange connections you want to list.
  • This endpoint returns all exchange connections for the specified customer and does not paginate.

For complete details on exchange connections, refer to the Dwolla Exchanges API reference.

List exchange partners

Returns a list of all available open banking exchange partners supported by your Dwolla integration. Use this endpoint to discover which open banking providers (such as Plaid, MX, or Finicity) are available for account verification in your environment.

  • No parameters are required for this endpoint. It returns all exchange partners available to your Dwolla account.
  • This endpoint returns a flat list and does not paginate.

For complete details on exchange partners, refer to the Dwolla Exchanges API reference.

List exchanges for a customer

Returns a list of open banking exchanges associated with a specific customer. An exchange represents an active bank account verification session linked to a customer through a specific exchange partner.

  • Enter the Dwolla Customer ID in the Customer ID field. This is the unique identifier for the customer whose exchanges you want to list.
  • This endpoint returns all exchanges for the specified customer and does not paginate.

For complete details on customer exchanges, refer to the Dwolla Exchanges API reference.

List exchanges for an account

Returns a list of all open banking exchanges associated with the authenticated Dwolla account. Use this endpoint to get a high-level view of all exchange integrations active across your platform.

  • No parameters are required. This endpoint returns all exchanges for the authenticated account and does not paginate.

For complete details, refer to the Dwolla Exchanges API reference.

Retrieve a funding source

Retrieves the full details for a specific funding source (bank account) by its ID. Use this endpoint when you need to fetch the complete record for a known funding source, such as account name, type, status, and bank details.

  • Enter the Dwolla Funding Source ID in the Funding Source ID field. Funding source IDs can be obtained from the "List funding sources for an account" endpoint or from the Dwolla Dashboard.
  • This endpoint returns a single record and does not paginate.

For complete details on the funding source object, refer to the Dwolla Funding Sources API reference.

Retrieve funding source balance

Retrieves the current balance for a specific Dwolla Balance funding source. This endpoint applies to Dwolla Balance funding sources (digital wallet accounts held on the Dwolla platform), not to external bank accounts.

  • Enter the Dwolla Funding Source ID in the Funding Source ID field. This must be the ID of a Dwolla Balance funding source. You can identify balance funding sources by their type: balance attribute when listing funding sources.
  • This endpoint returns a single balance record and does not paginate.

For complete details on the balance response, refer to the Dwolla Funding Sources API reference.

Retrieve VAN account and routing numbers

Retrieves the virtual account number (VAN) and routing number for a specific funding source. Dwolla can provision virtual account and routing numbers for Dwolla Balance funding sources, enabling external parties to send ACH transfers directly to a Dwolla Balance.

  • Enter the Dwolla Funding Source ID in the Funding Source ID field. This must be a funding source that has been provisioned with VAN/routing numbers.
  • This endpoint returns a single record and does not paginate.

For complete details on VAN provisioning and the ACH routing response, refer to the Dwolla Funding Sources API reference.

Retrieve KBA Questions

Retrieves the knowledge-based authentication (KBA) questions for an active KBA session. KBA is one of the identity verification methods Dwolla uses for verifying personal customers. This endpoint returns the set of questions that the customer must answer to complete KBA verification.

  • Enter the KBA Session ID in the KBA ID field. This ID is returned when a KBA session is initiated via the "Initiate a KBA Session" endpoint. KBA sessions are time-sensitive and must be completed promptly after initiation.
  • This endpoint returns a single set of KBA questions and does not paginate.

For complete details on KBA sessions and question formats, refer to the Dwolla KBA API reference.

Retrieve a Mass Payment

Retrieves details about a specific mass payment by its ID. Mass payments in Dwolla allow you to disburse funds to many recipients simultaneously with a single API request. Use this endpoint to check the status and details of a previously initiated mass payment.

  • Enter the Mass Payment ID in the Mass Payment ID field. This ID is returned when a mass payment is created via the Dwolla API. It can also be found in the Dwolla Dashboard under the Mass Payments section.
  • This endpoint returns a single mass payment record and does not paginate.

For complete details on the mass payment object and status values, refer to the Dwolla Mass Payments API reference.

Retrieve a Transfer

Retrieves detailed information about a specific transfer by its ID. Use this endpoint to check the status, amount, funding sources, and other details of a single known transfer.

  • Enter the Transfer ID in the Transfer ID field. Transfer IDs are returned when a transfer is initiated and can also be retrieved by listing transfers for an account or customer.
  • This endpoint returns a single transfer record and does not paginate.

Transfer statuses include pending, processed, failed, and cancelled. For complete details on the transfer object, refer to the Dwolla Transfers API reference.

List Customer Transfers

Returns a paginated list of transfers for a specified customer. Use this endpoint to retrieve all transfer history for a single customer, with optional filtering by correlation ID. This is useful for customer-level reconciliation, reporting, and customer service workflows.

  • Enter the Dwolla Customer ID in the Customer ID field. This is the unique identifier for the customer whose transfers you want to list.
  • Optionally, enter a Correlation ID to filter results to only transfers that were tagged with that identifier at creation time. Correlation IDs are optional customer-defined tags that can be attached to transfers for internal tracking and reconciliation.
  • This endpoint uses cursor-based pagination (following the next link in responses) and will automatically retrieve additional pages as needed.

For complete details on the customer transfers endpoint and response structure, refer to the Dwolla Customers API reference.

Endpoint Testing

Once the selected endpoint template has been configured, Nexla can retrieve a sample of the data that will be fetched according to the current settings. This allows users to verify that the source is configured correctly before saving.

  • To test the current endpoint configuration, click the Test button to the right of the endpoint selection menu. Sample data will be fetched & displayed in the Endpoint Test Result panel on the right.

  • If the sample data is not as expected, review the selected endpoint and associated settings, and make any necessary adjustments. Then, click the Test button again, and check the sample data to ensure that the correct information is displayed.

Configure Manually

Dwolla data sources can be manually configured to ingest data from any valid Dwolla API endpoint. Manual configuration provides maximum flexibility for accessing endpoints not covered by pre-built templates or when you need custom API configurations.

With manual configuration, you can also create more complex Dwolla sources, such as sources that use chained API calls to fetch data from multiple endpoints or sources that require custom request parameters.

API Method

  1. To manually configure this source, select the Advanced tab at the top of the configuration screen.

  2. Select the API method that will be used for calls to the Dwolla API from the Method pulldown menu. The most common methods are:

    • GET: For retrieving data from the API
    • POST: For sending data to the API or triggering actions
    • PUT: For updating existing data
    • PATCH: For partial updates to existing data
    • DELETE: For removing data

API Endpoint URL

  1. Enter the URL of the Dwolla API endpoint from which this source will fetch data in the Set API URL field. This should be the complete URL including the base URL for your selected environment and any required path parameters.

    • For Sandbox: https://api-sandbox.dwolla.com/{endpoint_path}
    • For Production: https://api.dwolla.com/{endpoint_path}

    For example, to list all customers, enter https://api-sandbox.dwolla.com/customers (Sandbox) or https://api.dwolla.com/customers (Production).

Ensure the API endpoint URL is correct and accessible with your current credentials. You can test the endpoint using the Test button after configuring the URL. All Dwolla API endpoints require HTTPS; plain HTTP requests will not be accepted.

Date/Time Macros (API URL)

Optional

Optionally, the API URL can be customized using macros—all macros added to the API URL will be converted into values when Nexla executes the API call. Macros are dynamic placeholders that allow you to create flexible API endpoints that can adapt to different time periods or data requirements. This is particularly useful for Dwolla endpoints that accept date range parameters, such as startDate and endDate on the transfers endpoint.

Macros are useful for Dwolla time-based filtering parameters. For example, you can use macros to dynamically populate the startDate and endDate query parameters on the transfers endpoint to fetch only transfers from a rolling time window.

  1. To add a macro, type { at the appropriate position in the API URL (within the Set API URL field), and select the desired macro from the dropdown list.

    • {now} – The current datetime
    • {now-1} – The datetime one time unit before the current datetime
    • {now+1} – The datetime one time unit after the current datetime
    • custom – Datetime macros can reference any number of time units before or after the current datetime—for example, enter (now-4) to indicate the datetime four time units before the current datetime
  2. Select the format that will be applied to datetime macros from the Date Format for Date/Time Macro pulldown menu. This format will be applied to the base datetime value of the macro—i.e., the value of {now} in {now-1}. Dwolla date parameters use the format yyyy-MM-dd.

  3. Select the datetime unit that will be used to perform mathematical operations in the included macro(s) from the Time Unit for Operations pulldown menu—for example, for the macro {now-1}, when Day is selected, {now-1} will be converted to the datetime one day before the current datetime.

Lookup-Based Macros (API URL)

Optional

Column values from existing lookups can also be included as macros in the API URL. Lookup-based macros allow you to reference data from previously configured data sources or lookups, enabling dynamic API endpoints that can adapt based on existing data. For Dwolla, this is useful when you need to build dynamic URLs that incorporate customer IDs, funding source IDs, or other identifiers retrieved from another Nexla source.

Lookup-based macros are useful when creating Dwolla sources that reference IDs from other Nexla data, such as using a customer ID from a customer list source to dynamically fetch transfer records for each customer.

  1. To include a lookup column value macro, select the relevant lookup from the Add Lookups to Supported Macros pulldown menu.

  2. Type { at the appropriate position in the API URL, and select the lookup column-based macro from the dropdown list. Lookup-based macros are automatically populated into the macro list when a lookup is selected in the Add Lookups to Supported Macros pulldown menu.

Path to Data

Optional

If only a subset of the data returned by a Dwolla API endpoint is needed, you can designate the part of the response that should be included in the Nexset(s) produced from this source by specifying the path to the relevant data within the response. Dwolla API responses typically use a HAL (Hypertext Application Language) format with an _embedded object containing the relevant data arrays alongside pagination links and metadata.

For example, when fetching a list of customers, the Dwolla API returns the customer records nested within _embedded.customers, along with pagination links in _links. By specifying the path $._embedded.customers[*], you can configure Nexla to treat each customer object as a separate record.

Path to Data is important for most Dwolla list endpoints, which nest their results under $._embedded.{resource-type}[*]. Without specifying the correct path, Nexla may parse the entire response object (including pagination metadata) as a single record rather than the individual resource records.

  • To specify which data should be treated as relevant in responses from this source, enter the path to the relevant data in the Set Path to Data in Response field.

    • For responses in JSON format, enter the JSON path that points to the object or array that should be treated as relevant data. JSON paths use dot notation (e.g., $._embedded.customers[*] to access the array of customer objects).
    Dwolla Path to Data Examples:
    • Customers list: $._embedded.customers[*]
    • Transfers list: $._embedded.transfers[*]
    • Funding sources list: $._embedded.funding-sources[*]
    • Single resource (no embedding): $
Autogenerate Path Suggestions

Nexla can also autogenerate data path suggestions based on the response from the API endpoint. These suggested paths can be used as-is or modified to exactly suit your needs.

  • To use this feature, click the Test button next to the Set API URL field to fetch a sample response from the API endpoint. Suggested data paths generated based on the content & format of the response will be displayed in the Suggestions box below the Set Path to Data in Response field.

  • Click on a suggestion to automatically populate the Set Path to Data in Response field with the corresponding path. The populated path can be modified directly within the field if further customization is needed.

    PathSuggestions.png

Metadata

If metadata is included in the response but is located outside of the defined path to relevant data, you can configure Nexla to include this data as common metadata in each record. For Dwolla API responses, this is useful when you want to preserve pagination information (such as total record counts) or top-level _links alongside the individual resource records.

Metadata paths are particularly useful for preserving Dwolla response context like total counts, pagination cursors, or request timestamps that apply to all records in the response but are not part of the embedded resource array.

  • To specify the location of metadata that should be included with each record, enter the path to the relevant metadata in the Path to Metadata in Response field.

    • For Dwolla responses in JSON format, enter the JSON path to the object or array that contains the metadata (for example, $.total for the total record count, or $._links for pagination links).

Request Headers

Optional
  • If Nexla should include any additional request headers in API calls to this source, enter the headers & corresponding values as comma-separated pairs in the Request Headers field (e.g., header1:value1,header2:value2). The Dwolla API supports an Accept header for specifying the response content type (e.g., Accept:application/vnd.dwolla.v1.hal+json).

    You do not need to include the Authorization header or any other headers already present in the credentials. Nexla automatically includes Bearer token authentication based on your Dwolla credential configuration.

Endpoint Testing

After configuring all settings for the selected endpoint, Nexla can retrieve a sample of the data that will be fetched according to the current configuration. This allows users to verify that the source is configured correctly before saving.

  • To test the current endpoint configuration, click the Test button to the right of the endpoint selection menu. Sample data will be fetched & displayed in the Endpoint Test Result panel on the right.

  • If the sample data is not as expected, review the selected endpoint and associated settings, and make any necessary adjustments. Then, click the Test button again, and check the sample data to ensure that the correct information is displayed.

Save & Activate the Source

  1. Once all of the relevant steps in the above sections have been completed, click the Create button in the upper right corner of the screen to save and create the new Dwolla data source. Nexla will now begin ingesting data from the configured endpoint and will organize any data that it finds into one or more Nexsets.