Dwolla

Dwolla API

Dwolla API Documentation

Payments#openapi

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

Dwolla API Documentation

Endpoints 84

tokens

  • POSTCreate an application access token/tokenGenerate an application access token using OAuth 2.0 client credentials flow for server-to-server authentication. Requires client ID and secret sent via Basic…

root

  • GETroot/Retrieve the API root entry point to discover available resources and endpoints based on your OAuth access token permissions. Returns HAL+JSON with navigation…

accounts

  • GETRetrieve account details/accounts/:idReturns basic account information for your authorized Main Dwolla Account, including account ID, name, and links to related resources such as funding sources,…
  • POSTCreate a funding source for an account/funding-sourcesCreate a funding source by adding a bank account to a Main Dwolla Account. This endpoint allows you to connect a checking or savings account using either…
  • GETList funding sources for an account/accounts/:id/funding-sourcesGet a list of all funding sources associated with a specific Main Dwolla Account. This endpoint returns both bank accounts and balance funding sources, with…
  • GETList and search account transfers/accounts/:id/transfersReturns a paginated, searchable list of transfers associated with the specified Main Dwolla account. Supports advanced filtering by amount range, date range,…
  • GETList account mass payments/accounts/:id/mass-paymentsReturns a paginated list of mass payments created by your Main Dwolla account. Results are sorted by creation date in descending order (newest first) and can…

customers

  • GETList and search customers/customersReturns a paginated list of customers sorted by creation date. Supports fuzzy search across customer names, business names, and email addresses, plus exact…
  • POSTCreate a customer/customersCreates a new customer with different verification levels and capabilities. Supports personal verified customers (individuals), business verified customers…
  • GETRetrieve a customer/customers/:idRetrieve identifying information for a specific customer. The returned data varies by customer type - verified customers include contact details, address…
  • POSTUpdate a customer/customers/:idUpdate Customer information, upgrade an unverified Customer to a verified Customer, suspend a Customer, deactivate a Customer, reactivate a Customer, and…
  • GETList business classifications/business-classificationsReturns a directory of business and industry classifications required for creating business verified customers. Each business classification contains multiple…
  • GETRetrieve a business classification/business-classifications/:idReturns a specific business classification with its embedded industry classifications. Use this endpoint to browse available industry options within a…

kba

  • POSTInitiate a KBA session/customers/:id/kbaCreates a new KBA (Knowledge-Based Authentication) session for a personal Verified Customer. Returns a KBA identifier that represents the session and is used…
  • GETRetrieve KBA Questions/kba/:idReturns the KBA questions for a specific KBA session. The questions are used to verify the customer's identity during the KBA process.
  • POSTVerify KBA Questions/kba/:idSubmits customer answers to KBA questions for identity verification. Requires four question-answer pairs with questionId and answerId values. Returns…

beneficial owners

  • GETList customer beneficial owners/customers/:id/beneficial-ownersReturns all beneficial owners associated with a business verified customer. Beneficial owners are individuals who directly or indirectly own 25% or more of…
  • POSTCreate customer beneficial owner/customers/:id/beneficial-ownersCreates a new beneficial owner for a business verified customer. Beneficial owners are individuals who own 25% or more of the company's equity. Requires…
  • GETRetrieve beneficial owner/beneficial-owners/:idReturns detailed information for a specific beneficial owner, including personal information, address, and verification status. The verification status…
  • POSTUpdate beneficial owner/beneficial-owners/:idUpdates a beneficial owner's information to retry verification when their status is "incomplete". Only beneficial owners with incomplete verification status…
  • DELETERemove beneficial owner/beneficial-owners/:idPermanently removes a beneficial owner from a business customer. This action is irreversible and the beneficial owner cannot be retrieved after removal.…
  • GETRetrieve beneficial ownership status/customers/:id/beneficial-ownershipReturns the certification status of beneficial ownership for a business verified customer. Status indicates whether beneficial owner information has been…
  • POSTCertify beneficial ownership/customers/:id/beneficial-ownershipUpdates the beneficial ownership certification status to "certified", confirming that all beneficial owner information is accurate and complete. This action…

documents

  • GETList documents for customer/customers/:id/documentsReturns all identity verification documents submitted for a customer. Includes document status, verification results, document type (passport, driver's…
  • POSTCreate a document for customer/customers/:id/documentsUploads an identity verification document for a customer using multipart form-data. Required when a customer has "document" status during the verification…
  • GETList documents for beneficial owner/beneficial-owners/:id/documentsReturns all identity verification documents submitted for a beneficial owner. Includes document status, verification results, document type (passport,…
  • POSTCreate a document for beneficial owner/beneficial-owners/:id/documentsUploads an identity verification document for a beneficial owner using multipart form-data. Required when a beneficial owner has "document" status during the…
  • GETRetrieve a document/documents/:idReturns detailed information about a specific identity verification document, including its status, type, and verification results. Used to track document…

exchanges

  • GETList exchange partners/exchange-partnersReturns a list of all supported exchange partners. Each partner includes a unique ID, name, and status indicating whether they are active or inactive.
  • GETRetrieve exchange partner/exchange-partners/:idReturns details for a specific open banking provider that integrates with Dwolla. Includes partner name, status, and creation date. Use this to verify partner…
  • GETList exchanges for an account/exchangesReturns all exchanges for your Dwolla account. Exchanges represent connections between external bank accounts and your account through open banking partners.…
  • POSTCreate an exchange for an account/exchangesCreate an exchange for an account. The request body will vary based on the exchange partner. For Finicity, the request body will include finicity-specific…
  • GETRetrieve exchange resource/exchanges/:idReturns details for a specific exchange connection between Dwolla and an open banking partner for a customer's bank account. Includes exchange status,…
  • GETList exchanges for a customer/customers/:id/exchangesReturns all exchanges for a specific customer. Exchanges represent connections between the customer's external bank accounts and open banking partners.…
  • POSTCreate an exchange for a customer/customers/:id/exchangesCreates an exchange connection between a customer and Dwolla. Request body varies by partner (Plaid, MX, Flinks, Finicity, Checkout.com). For bank accounts,…

exchange sessions

  • POSTCreate customer exchange session/customers/:id/exchange-sessionsCreates an exchange session for a customer. Use cases include: Plaid / MX: Instant bank account verification (open banking). For faster verification as…
  • GETRetrieve exchange session/exchange-sessions/:idReturns details of a previously created exchange session. Response varies by partner: MX: _links.external-provider-session.href (redirect URL for…
  • POSTCreate re-authentication exchange session/exchanges/:id/exchange-sessionsCreates a re-authentication exchange session to refresh a user's bank account connection when their existing authorization is no longer valid. Required when…
  • GETList available exchange connections/customers/:id/available-exchange-connectionsReturns available exchange connections for a customer's bank accounts authorized through MX Connect. Each connection includes an account name and…

funding sources

  • GETList customer funding sources/customers/:id/funding-sourcesReturns all funding sources for a customer, including bank accounts, debit card funding sources, and Dwolla balance (verified customers only). Shows…
  • POSTCreate customer funding source/customers/:id/funding-sourcesCreates a bank account or debit card funding source for a customer. Supports multiple methods including manual entry with routing/account numbers, instant…
  • GETRetrieve a funding source/funding-sources/:idReturns detailed information for a specific funding source, including its type, status, and verification details. Supports bank accounts (via Open Banking),…
  • POSTUpdate or remove a funding source/funding-sources/:idUpdates a bank or debit card funding source's details, or soft deletes it. For bank funding sources you can change the name (any status), or modify…
  • GETRetrieve micro-deposits details/funding-sources/:id/micro-depositsReturns the status and details of micro-deposits for a funding source to check verification eligibility. Includes deposit status (pending, processed, failed),…
  • POSTInitiate or Verify micro-deposits/funding-sources/:id/micro-depositsHandles micro-deposit bank verification process. Make a request without a request body to initiate two small deposits to the customer's bank account. Include…
  • GETRetrieve funding source balance/funding-sources/:id/balanceReturns the current balance for a specific funding source. For bank accounts, includes available and closing balances; for Dwolla balance, includes balance…
  • GETRetrieve VAN account and routing numbers/funding-sources/:id/ach-routingReturns the unique account and routing numbers for a Virtual Account Number (VAN) funding source. These numbers can be used by external systems to initiate…
  • POSTCreate an on-demand transfer authorization/on-demand-authorizationsCreate an on-demand transfer authorization that allows Customers to pre-authorize variable amount ACH transfers from their bank account for future payments.…

transfers

  • POSTInitiate a transfer/transfersInitiate a transfer between funding sources from a Dwolla Account or API Customer resource. Supports ACH, Instant Payments (RTP/FedNow), Push-to-Debit Card,…
  • GETRetrieve a transfer/transfers/:idRetrieve detailed information for a specific transfer by its unique identifier belonging to an Account or Customer. Returns transfer status, amount, creation…
  • POSTCancel a transfer/transfers/:idCancel a pending transfer by setting its status to cancelled. Only transfers in pending status can be cancelled before processing begins. Returns the updated…
  • GETList and search transfers for a customer/customers/:id/transfersRetrieve and search transfers for a specific Customer with comprehensive filtering and pagination support. Supports searching by customer details (name,…
  • GETList fees for a transfer/transfers/:id/feesRetrieve detailed fee information for a specific transfer by its unique identifier. Returns the total number of fees and individual fee transaction details…
  • GETRetrieve a transfer failure reason/transfers/:id/failureRetrieve detailed failure information for a failed bank or VAN transfer including the ACH return code, description, and explanation. Returns failure details…

labels

  • GETRetrieve a label/labels/:idRetrieve details for a specific Label used to categorize and track funds within your account. Returns Label information including unique identifier, current…
  • DELETERemove a label/labels/:idDelete a Label to stop tracking funds and remove it from your account. Returns success status if the Label is successfully removed. Use this to streamline…
  • GETList labels for a customer/customers/:id/labelsReturns all labels for a specified Verified Customer, sorted by creation date (most recent first). Supports pagination with limit and offset parameters. Each…
  • POSTCreate a label for a customer/customers/:id/labelsCreates a new label for a Verified Customer with a specified amount. Labels help organize and track funds within a customer's balance. Returns the location of…
  • GETList label ledger entries/labels/:id/ledger-entriesReturns all ledger entries for a specific Label, sorted by creation date (newest first). Supports pagination with limit and offset parameters. Each ledger…
  • POSTCreate a label ledger entry/labels/:id/ledger-entriesCreate a new ledger entry to track fund adjustments on a Label by specifying a positive or negative amount value. Returns the location of the created ledger…
  • GETRetrieve a label ledger entry/ledger-entries/:ledgerEntryIdReturns detailed information for a specific ledger entry on a Label, including its amount, currency, and creation timestamp.
  • POSTCreate a label reallocation/label-reallocationsReallocates funds between two labels belonging to the same Verified Customer. Moves the specified amount from the source label to the destination label,…
  • GETRetrieve a label reallocation/label-reallocations/:reallocationIdRetrieve details for a specific label reallocation that transfers funds between Labels. Returns reallocation information including source and destination…

mass payments

  • POSTInitiate a mass payment/mass-paymentsCreate a mass payment containing up to 5,000 individual payment items from a Dwolla Main Account or Verified Customer funding source. Supports optional…
  • GETRetrieve a mass payment/mass-payments/:idRetrieve detailed information for a mass payment by its unique identifier. Returns the current processing status (pending, processing, or complete), creation…
  • POSTUpdate a mass payment/mass-payments/:idUpdate the status of a deferred mass payment to control its processing lifecycle. Set status to pending to trigger processing and begin fund transfers, or…
  • GETList items for a mass payment/mass-payments/:id/itemsRetrieve individual payment items within a mass payment with optional status filtering and pagination support. Each item represents a distinct payment with…
  • GETRetrieve mass payment item/mass-payment-items/:itemIdRetrieve detailed information for a specific mass payment item by its unique identifier. Returns item status, amount, metadata, and links to the parent mass…
  • GETList mass payments for customer/customers/:id/mass-paymentsRetrieve all previously created mass payments for a Verified Customer account with optional correlation ID filtering and pagination support. Mass payments are…

events

  • GETList events/eventsReturns a paginated list of events representing state changes to resources in your Dwolla application. Events track actions on customers, transfers, funding…
  • GETRetrieve event/events/:idReturns detailed information for a specific event representing a state change that occurred on a resource in your Dwolla application. Includes the event…

alerts

  • GETList alerts/alertsReturns the alerts for your Dwolla account, newest first. Alerts notify you of activity that may need your attention, such as unusual transfer activity for…
  • GETRetrieve alert/alerts/:idReturns a single alert for your Dwolla account. Alerts notify you of activity that may need your attention, such as unusual transfer activity for one of your…

webhook subscriptions

  • GETList webhook subscriptions/webhook-subscriptionsRetrieve all webhook subscriptions that belong to an application including their configuration details and status. Returns subscription details including…
  • POSTCreate a webhook subscription/webhook-subscriptionsCreate a webhook subscription to deliver webhook notifications to a specified URL endpoint for your application. Requires a destination URL where Dwolla will…
  • GETRetrieve a webhook subscription/webhook-subscriptions/:idRetrieve detailed information for a specific webhook subscription by its unique identifier. Returns subscription configuration including URL endpoint,…
  • POSTUpdate a webhook subscription/webhook-subscriptions/:idUpdate a webhook subscription to pause or resume webhook delivery notifications. Allows toggling the paused status to temporarily stop webhook notifications…
  • DELETEDelete a webhook subscription/webhook-subscriptions/:idDelete a webhook subscription to permanently remove webhook notifications for your application. This action stops all future webhook deliveries and cannot be…
  • GETList webhooks for a webhook subscription/webhook-subscriptions/:id/webhooksRetrieve all fired webhooks for a specific webhook subscription with comprehensive filtering and pagination support. Returns webhook delivery history…

webhooks

  • GETRetrieve a webhook/webhooks/:idRetrieve detailed information for a specific webhook by its unique identifier including delivery attempts and response data. Returns webhook details with…
  • GETList retries for a webhook/webhooks/:id/retriesRetrieve all retry attempts for a specific webhook including timestamps and delivery details. Returns a list of retry attempts with unique identifiers,…
  • POSTRetry a webhook/webhooks/:id/retriesRetry a webhook by its unique identifier to redeliver the notification to your endpoint. Creates a new retry attempt and returns the location of the new…

client tokens

  • POSTCreate a client token/client-tokensCreate a client token for secure authentication within Dwolla Drop-in components. Requires a granular permission action and a Customer link to define what…

sandbox simulations

  • POSTSandbox simulations (bank transfers, VAN transfers, or customer verification directives)/sandbox-simulationsSandbox-only endpoint with three modes: Simulate bank transfer processing — Omit the body or send an empty JSON object. Processes or fails the last 500 bank…

API details

Base URL
https://api.dwolla.com
https://api-sandbox.dwolla.com
Authentication
OAuth 2.0 (client credentials flow)
Operations
84 operations on 61 pathsGET 50POST 31DELETE 3
Main resources
funding sources 9labels 9beneficial owners 7exchanges 7customers 6mass payments 6transfers 6webhook subscriptions 6accounts 5documents 5
Response formats
application/vnd.dwolla.v1.hal+json application/json
Description format
OpenAPI 3.1.0, API version 2.0

How to test the Dwolla API in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the Dwolla API collection, without the publisher's secrets.
  3. Add your credentialsThis API uses OAuth 2.0 (client credentials flow). Add yours in the collection's variables or an environment; the requests already reference it.
  4. Send a requestPick an endpoint, for example “Create an application access token” (POST /token), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the Dwolla API?

Dwolla API Documentation It is listed under Payments and has 84 endpoints.

Who publishes the Dwolla API?

It is listed from Dwolla's public API description (an OpenAPI document), not published by Dwolla on Swastik Codes. Anyone who controls dwolla.com can claim the profile by adding a DNS TXT record.

What is the base URL of the Dwolla API?

Its description lists 2 base URLs: https://api.dwolla.com, https://api-sandbox.dwolla.com. The first is the usual one; the others are typically sandbox or regional servers.

How do I authenticate with the Dwolla API?

With OAuth 2.0 (client credentials flow).

How many endpoints does the Dwolla API have?

84 operations on 61 paths (50 GET, 31 POST, 3 DELETE). The largest groups are funding sources, labels, beneficial owners, exchanges.

Is forking the Dwolla API free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.