diff --git a/docs/index.html b/docs/index.html new file mode 100644 index 0000000..c8a3fb0 --- /dev/null +++ b/docs/index.html @@ -0,0 +1,533 @@ + + + + + + Dwolla Connect + + + + + + + + + +
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
client_id
required
string
client_secret
required
string
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
{
  • "_links": {
    },
  • "name": "My Test Bank",
  • "bankAccountType": "checking",
  • "accountNumber": "123456789",
  • "routingNumber": "222222226"
}

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
{}

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
{
  • "_links": {
    },
  • "name": "My Test Bank",
  • "bankAccountType": "checking",
  • "accountNumber": "123456789",
  • "routingNumber": "222222226"
}

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
name
required
string
bankAccountType
required
string
Enum: "checking" "savings"
accountNumber
required
string
routingNumber
required
string

Responses

Request samples

Content type
application/json
{
  • "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
{}

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>
correlationId
string

Responses

Request samples

Content type
application/json
Example
{
  • "businessName": "John Doe Equipment, LLC",
  • "email": "john.doe@example.com",
  • "correlationId": "efac856f-fdde-459c-8af7-24e3431cd07b"
}

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

Get an External 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
name
required
string
bankAccountType
required
string
Enum: "checking" "savings"
accountNumber
required
string
routingNumber
required
string

Responses

Request samples

Content type
application/json
{
  • "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
{}

Transfers

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)
correlationId
string

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
{}

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
{
  • "_links": {},
  • "_embedded": {
    }
}

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
{
  • "_links": {},
  • "id": "e60d1372-f398-4c03-b4e7-499a4a7f8b27",
  • "name": "My JPM Account",
  • "created": "2023-07-14T19:16:46.694Z",
  • "accountId": "22926523-b517-43b9-959b-6ac4a422d71e",
  • "treasuryPartnerId": "63a5f9d2-de34-40ae-a96e-0ab02cb7abd9",
  • "treasuryPartnerContext": {
    }
}

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
{}
+ + + +