API docs by Redocly

Dwolla Connect (1.0.0)

Download OpenAPI specification:Download

Developer Relations: developers@dwolla.com URL: https://dwolla.com License: MIT Terms of Service

Dwolla Connect API Documentation

Authentication

Generate Access Token

Generate an access token for Dwolla's Connect API

Authorizations:
basicAuth
Request Body schema: application/x-www-form-urlencoded
grant_type
required
string
Value: "client_credentials"

Responses

Response samples

Content type
application/json
{
  • "access_token": "connect.eyJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJUaGlzIGlzIE5PVCBhIHJlYWwgRHdvbGxhIENvbm5lY3QgdG9rZW4ifQ.TB05eEU58XdygDMPcIlYVDRZvX3aQMbwJRYoQhu_KP0",
  • "token_type": "Bearer",
  • "expires_in": 3599
}

Root

Root

Entrypoint to Dwolla's API. Can be used to fetch Account, Funding Sources, and more.

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/vnd.dwolla.v1.hal+json
{}

Accounts

Create Funding Source for Account

Create a Funding Source that is attached to your Main Account.

The created Funding Source can be used as the sender for debit Transfers, or as the destination for credit Transfers.

Authorizations:
bearerAuth
Request Body schema: application/json
object
name
required
string
bankAccountType
required
string
Enum: "checking" "savings"
accountNumber
required
string
routingNumber
required
string

Responses

Request samples

Content type
application/json
{}

Get Account

Get Account by ID

Authorizations:
bearerAuth
path Parameters
id
required
string <uuid>

UUID of Account

Responses

Response samples

Content type
application/vnd.dwolla.v1.hal+json
{}

List Funding Sources for Account

List all Funding Sources that have been created for your Main Account.

Authorizations:
bearerAuth
path Parameters
id
required
string <uuid>

UUID of Main Account

Responses

Response samples

Content type
application/vnd.dwolla.v1.hal+json
{}

List Transfers for Account

List all Transfers that have been created by your Main Account.

Authorizations:
bearerAuth
path Parameters
id
required
string <uuid>

UUID of Main Account

Responses

Response samples

Content type
application/vnd.dwolla.v1.hal+json
{}

Funding Sources

Create Funding Source for Account

Create a Funding Source that is attached to your Main Account.

The created Funding Source can be used as the sender for debit Transfers, or as the destination for credit Transfers.

Authorizations:
bearerAuth
Request Body schema: application/json
object
name
required
string
bankAccountType
required
string
Enum: "checking" "savings"
accountNumber
required
string
routingNumber
required
string

Responses

Request samples

Content type
application/json
{}

List Funding Sources for Account

List all Funding Sources that have been created for your Main Account.

Authorizations:
bearerAuth
path Parameters
id
required
string <uuid>

UUID of Main Account

Responses

Response samples

Content type
application/vnd.dwolla.v1.hal+json
{}

Create Funding Source for External Party

Create a bank Funding Source that's attached to an External Party.

A Funding Source is required when creating a Transfer, as a sender or destination.

Authorizations:
bearerAuth
path Parameters
id
required
string <uuid>

UUID of External Party

Request Body schema: application/json
One of
name
required
string
bankAccountType
required
string
Enum: "checking" "savings"
accountNumber
required
string
routingNumber
required
string

Responses

Request samples

Content type
application/json
Example
{
  • "name": "Test Bank",
  • "bankAccountType": "checking",
  • "accountNumber": "123456789",
  • "routingNumber": "222222226"
}

List Funding Sources for External Party

List all Funding Sources that your application has created for an External Party.

Authorizations:
bearerAuth
path Parameters
id
required
string <uuid>

UUID of External Party

Responses

Response samples

Content type
application/vnd.dwolla.v1.hal+json
{}

Get Funding Source

Get detailed information of a Funding Source by its ID.

Authorizations:
bearerAuth
path Parameters
id
required
string <uuid>

UUID of Funding Source

Responses

Response samples

Content type
application/vnd.dwolla.v1.hal+json
{}

Transfers

List Transfers for Account

List all Transfers that have been created by your Main Account.

Authorizations:
bearerAuth
path Parameters
id
required
string <uuid>

UUID of Main Account

Responses

Response samples

Content type
application/vnd.dwolla.v1.hal+json
{}

List Transfers for External Party

List all Transfers that that belong to an External Party.

Authorizations:
bearerAuth
path Parameters
id
required
string <uuid>

UUID of External Party

Responses

Response samples

Content type
application/vnd.dwolla.v1.hal+json
{}

Create Transfer

Create a new Transfer, sending money from a source Funding Source to a destination Funding Source.

If the sender Funding Source has a treasuryAccount link, the Transfer type will be credit; otherwise, if the treasuryAccount link is on the destination Funding Source, the Transfer type will be debit.

Authorizations:
bearerAuth
Request Body schema: application/json
required
object
required
object (Amount)

Responses

Request samples

Content type
application/json
{}

Get Transfer

Get detailed information of a Transfer by ID.

Authorizations:
bearerAuth
path Parameters
id
required
string <uuid>

UUID of Transfer

Responses

Response samples

Content type
application/vnd.dwolla.v1.hal+json
{}

External Parties

Create External Party

Create a business or personal External Party, to which a Funding Source can be later attached.

Authorizations:
bearerAuth
Request Body schema: application/json
One of
businessName
required
string
email
required
string <email>

Responses

Request samples

Content type
application/json
Example
{
  • "businessName": "John Doe Equipment, LLC",
  • "email": "john.doe@example.com"
}

List External Parties

List all External Parties that have been created by your application.

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/vnd.dwolla.v1.hal+json
{}

Get External Party

Retrieve basic deails about an exernal party by ID.

Authorizations:
bearerAuth
path Parameters
id
required
string <uuid>

UUID of External Party

Responses

Response samples

Content type
application/vnd.dwolla.v1.hal+json
Example
{}

Create Funding Source for External Party

Create a bank Funding Source that's attached to an External Party.

A Funding Source is required when creating a Transfer, as a sender or destination.

Authorizations:
bearerAuth
path Parameters
id
required
string <uuid>

UUID of External Party

Request Body schema: application/json
One of
name
required
string
bankAccountType
required
string
Enum: "checking" "savings"
accountNumber
required
string
routingNumber
required
string

Responses

Request samples

Content type
application/json
Example
{
  • "name": "Test Bank",
  • "bankAccountType": "checking",
  • "accountNumber": "123456789",
  • "routingNumber": "222222226"
}

List Funding Sources for External Party

List all Funding Sources that your application has created for an External Party.

Authorizations:
bearerAuth
path Parameters
id
required
string <uuid>

UUID of External Party

Responses

Response samples

Content type
application/vnd.dwolla.v1.hal+json
{}

List Transfers for External Party

List all Transfers that that belong to an External Party.

Authorizations:
bearerAuth
path Parameters
id
required
string <uuid>

UUID of External Party

Responses

Response samples

Content type
application/vnd.dwolla.v1.hal+json
{}

Exchanges

Create exchange for an External Party

Create exchange for an External Party

Authorizations:
bearerAuth
path Parameters
id
required
string <uuid>

UUID of External Party

Request Body schema: application/json
One of
required
object
required
object

Responses

Request samples

Content type
application/json
Example
{
  • "_links": {
    },
  • "finicity": {
    }
}

List exchanges for an External Party

List exchanges for an External Party

Authorizations:
bearerAuth
path Parameters
id
required
string <uuid>

UUID of External Party

Responses

Response samples

Content type
application/vnd.dwolla.v1.hal+json
{}

List exchange partners

List exchange partners

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/vnd.dwolla.v1.hal+json
{}

Retrieve exchange partner

Retrieve exchange partner

Authorizations:
bearerAuth
path Parameters
id
required
string <uuid>
Example: 292317ec-e252-47d8-93c3-2d128e037aa4

Exchange Partner resource unique identifier.

Responses

Response samples

Content type
application/vnd.dwolla.v1.hal+json
{}

Create exchange for an Account

Create exchange for an Account

Authorizations:
bearerAuth
Request Body schema: application/json
One of
required
object
required
object

Responses

Request samples

Content type
application/json
Example
{
  • "_links": {
    },
  • "finicity": {
    }
}

List exchanges for an Account

List exchanges for an Account

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/vnd.dwolla.v1.hal+json
{}

Retrieve exchange resource

Retrieve exchange resource

Authorizations:
bearerAuth
path Parameters
id
required
string
Example: 292317ec-e252-47d8-93c3-2d128e037aa4

UUID of Exchange resource

Responses

Response samples

Content type
application/vnd.dwolla.v1.hal+json
{}

Treasury Accounts

Create Treasury Account

Create a Treasury Account that can be attached to a Funding Source.

Authorizations:
bearerAuth
Request Body schema: application/json
required
object
name
required
string
required
TreasuryPartnerContextJPM (object) or TreasuryPartnerContextWF (object)

Responses

Request samples

Content type
application/json
{}

List Treasury Accounts

List all Treasury Accounts that have been created by your application.

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/vnd.dwolla.v1.hal+json
{}

Get Treasury Account

Get detailed information of a Treasury Account by ID.

Authorizations:
bearerAuth
path Parameters
id
required
string <uuid>

UUID of Treasury Account

Responses

Response samples

Content type
application/vnd.dwolla.v1.hal+json
{}

Treasury Partners

Get Treasury Partner

Get detailed information of a Transfer Partner by its UUID.

Authorizations:
bearerAuth
path Parameters
id
required
string <uuid>

UUID of Treasury Partner

Responses

Response samples

Content type
application/vnd.dwolla.v1.hal+json
{}

List Treasury Partners

List all Transfer Partners that Dwolla currently supports.

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/vnd.dwolla.v1.hal+json
{}

Webhook Subscriptions

Create a Webhook Subscription

Create a webhook subscription to receive POST requests from Dwolla (called webhooks) when events associated with your application occur.

Authorizations:
bearerAuth
Request Body schema: application/json
url
required
string
secret
required
string

Responses

Request samples

Content type
application/json
{}

List Webhook Subscriptions

List all Webhook Subscriptions that belong to an application.

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/vnd.dwolla.v1.hal+json
{}

Get Webhook Subscription

Get a Webhook Subscription by ID

Authorizations:
bearerAuth
path Parameters
id
required
string <uuid>

UUID of Webhook Subscription

Responses

Response samples

Content type
application/vnd.dwolla.v1.hal+json
{}

Delete a Webhook Subscription

Delete a webhook subscription to stop receiving POST requests from Dwolla webhooks.

Authorizations:
bearerAuth
path Parameters
id
required
string <uuid>

UUID of Webhook Subscription to delete

Responses

Response samples

Content type
application/vnd.dwolla.v1.hal+json
{}

List Webhooks for a Webhook Subscription

List all Webhooks fired for a Webhook Subscriptions

Authorizations:
bearerAuth
path Parameters
id
required
string <uuid>

UUID of Webhook Subscription

Responses

Response samples

Content type
application/vnd.dwolla.v1.hal+json
{}