Docs

Ask AI or search...

Select Language

Get API Keys

Select Product

Select Category

Home

API Reference

API Fundamentals
Authorization
Root
Accounts
External Parties
Overview Create an external party Retrieve an external party List and search external parties
Exchanges
Open Banking
Funding Sources
Transfers
Webhook Subscriptions
Webhooks

Get API Keys

List external-parties #

This section describes how to retrieve a list of all external parties connected to the main Dwolla Connect Account. The external parties are sorted by the created timestamp, with the most recent external party at the beginning of the list. The list is returned in an _embedded list called external-parties.

Pagination #

All listing endpoints support cursor-based pagination to traverse through an existing data set. With cursor-based pagination you must always start at the beginning of a list and query your way forward in the data set. Cursor-based endpoints accept the limit and cursor query string parameters.

A limit is set to control the number of objects that are returned in the response. By default, a limit is set to 25 objects that are returned and sorted by created timestamp. Limit can have a max value of 200 external party objects. The cursor is a pointer indicating the next item in the data set. The cursor to use for the next page of results is returned in the _links object where a URL is generated and returned for the next data set (referenced below). If you omit the cursor from your request, you will receive the first page of results.

It is recommended to use the _links object in the response which includes the following relational links for paging.

self link indicates the URL of the resource itself.
next includes the URL to list the next set of objects as defined by limit that is set. The absence of a next URL indicates that you have reached the end of the data set.
prev includes the URL to list the previous set of objects as defined by limit. the absence of a prev URL indicates that you are at the beginning of the data set.

Example HTTP Request

GET https://api.dwolla.com/external-parties?limit=10&cursor={encoded-cursor}

HTTP request #

GET https://api.dwolla.com/external-parties

Request parameters #

Parameter	Required	Type	Description
correlationId	no	string	A string value to filter on if a `correlationId` was specified on an external party.
limit	no	string	A limit on the number of results to return. A minimum of 1 and a maximum of 200 objects.
cursor	no	string	A pointer indicating the next item in the data set for pagination.

HTTP status and error codes #

HTTP Status	Code	Message	Description
200	Ok	Success	The Dwolla API accepted the request and returned a response.

Request and response #

Raw

GET https://api.dwolla.com/external-parties?limit=2
Accept: application/vnd.dwolla.v1.hal+json
Authorization: Bearer connect.eyJraWQiOiJPNVVOUVR0VHdDSXBcL0lsYnNlWldtdUFVZHJaVjFuU3lIYlVubkpwYW54WT0iLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiIzZ2I3dTQyMjFkb2RwYWYwdGNyM3VrZm04MSIsInRva2VuX3VzZSI6ImFjY2VzcyIsInNjb3BlIjoiYnliLWFwaVwvZXh0ZXJuYWwtcGFydGllczpleGNoYW5nZXMuY3JlYXRlIGJ5Yi1hcGlcL2FjY291bnRzLnJlYWQgYnliLWFwaVwvZXhjaGFuZ2VzLmNyZWF0ZSBieWItYXBpXC9leHRlcm5hbC1wYXJ0aWVzLmNyZWF0ZSBieWItYXBpXC90cmFuc2ZlcnMuY3JlYXRlIGJ5Yi1hcGlcL2V4dGVybmFsLXBhcnRpZXM6ZXhjaGFuZ2VzLnJlYWQgYnliLWFwaVwvdHJlYXN1cnktYWNjb3VudHMucmVhZCBieWItYXBpXC90cmFuc2ZlcnMucmVhZCBieWItYXBpXC9leGNoYW5nZXMucmVhZCBieWItYXBpXC93ZWJob29rLXN1YnNjcmlwdGlvbnMuZGVsZXRlIGJ5Yi1hcGlcL3RyZWFzdXJ5LWFjY291bnRzLmNyZWF0ZSBieWItYXBpXC9leHRlcm5hbC1wYXJ0aWVzOmZ1bmRpbmctc291cmNlcy5yZWFkIGJ5Yi1hcGlcL3dlYmhvb2stc3Vic2NyaXB0aW9ucy5jcmVhdGUgYnliLWFwaVwvd2ViaG9va3MucmVhZCBieWItYXBpXC9leHRlcm5hbC1wYXJ0aWVzOnRyYW5zZmVycy5yZWFkIGJ5Yi1hcGlcL3dlYmhvb2stc3Vic2NyaXB0aW9ucy5yZWFkIGJ5Yi1hcGlcL2V4dGVybmFsLXBhcnRpZXMucmVhZCBieWItYXBpXC9mdW5kaW5nLXNvdXJjZXMuZGVsZXRlIGJ5Yi1hcGlcL3RyZWFzdXJ5LXBhcnRuZXJzLnJlYWQgYnliLWFwaVwvZnVuZGluZy1zb3VyY2VzLnJlYWQgYnliLWFwaVwvYXBwbGljYXRpb25zLnJlYWQgYnliLWFwaVwvZXh0ZXJuYWwtcGFydGllczpmdW5kaW5nLXNvdXJjZXMuY3JlYXRlIGJ5Yi1hcGlcL3dlYmhvb2stc3Vic2NyaXB0aW9ucy5wYXVzZSBieWItYXBpXC9mdW5kaW5nLXNvdXJjZXMuY3JlYXRlIGJ5Yi1hcGlcL3dlYmhvb2tzLnJldHJpZXMiLCJhdXRoX3RpbWUiOjE2OTQ4MDQ5NjAsImlzcyI6Imh0dHBzOlwvXC9jb2duaXRvLWlkcC51cy13ZXN0LTIuYW1hem9uYXdzLmNvbVwvdXMtd2VzdC0yX2xvT0NCOEZ2eCIsImV4cCI6MTY5NDgwODU2MCwiaWF0IjoxNjk0ODA0OTYwLCJ2ZXJzaW9uIjoyLCJqdGkiOiIzOGU0MWYwMS04YjM1LTRmOTAtODcxYy0wMTU3YzkyNzdhMjAiLCJjbGllbnRfaWQiOiIzZ2I3dTQyMjFkb2RwYWYwdGNyM3VrZm04MSJ9.tUcSnucNWvRK8g609EkO9OyD2VFqvYtJHNVz9-jeYfNf2uN_GFdogaf8HtDWXdX8QshDMZ46w3f4AQLuRdZ3a53b5JX3v9FKnDst-PtLZFV5tfIQlhY6gZyXJO_hLpgJJQ6a0m7ZBNJLS5toUp7qTdcgz_5wufB3pNz25jdV6667W1ZGVt5j6P_vMY1DYnTTZZ6KI3pAT9Mvbqp892pdcNbzZhfIvyl5gheiKnpxUdGK-mwBPpKolDWnFw4G7_gyJB4lVqPg9bXdDGwyFuvgZj2K1xQyEWHfXymveaQ6j1SPy7hLcpHwnyGzp5DXFtp7j8iOkFoqZVp9HzeDqGje2g

...

HTTP/1.1 200 Ok
{
    "_links": {
        "self": {
            "href": "https://api.dwolla.com/external-parties",
            "type": "application/vnd.dwolla.v1.hal+json",
            "resource-type": "external-party"
        },
        "next": {
            "href": "https://api.dwolla.com/external-parties?cursor=pkRCuXGXtIXuX4lYR3rxzsOAUzB4xs-aJwCztcz2i2f5-C8M4NhitjEfPGdJsTSit6eKVvTtS5KQ32dl3Urq1ukwYrz0ebXtYaJGJQNlFJ0mUruIRmaMqbBj-5UKl3piqzoGwdIUjw3_umKrJUC8obrSOlAbSoNu5N7ANPc8tIKiKHfYJVLHcVeuV7EbCYDmBByXHFSP0TIEtRJwP_FV_o4V6gdcBSJpRq2EIYN7qPC9FJtTvYMcvPZH6KnEiziq_A04jhftCmU1pTabEnpNMLha2ZkXghZuk64Fpy49MugYH94itx5skcYr1ANatYycKKpUgKGhdfXMLyV1V3iDAG-y3NDd6cfvuC-2DonZ2xF5TklF8MzRkbTnOnstpF5t",
            "type": "application/vnd.dwolla.v1.hal+json",
            "resource-type": "external-party"
        }
    },
    "_embedded": {
        "external-parties": [
            {
                "_links": {
                    "self": {
                        "href": "https://api.dwolla.com/external-parties/b8edab05-105c-4600-84b9-9c6f2965ce1b",
                        "type": "application/vnd.dwolla.v1.hal+json",
                        "resource-type": "external-party"
                    }
                },
                "id": "b8edab05-105c-4600-84b9-9c6f2965ce1b",
                "created": "2023-09-19T16:14:31.986Z",
                "email": "john.doe@email.com",
                "businessName": "Business name",
                "externalPartyType": "business"
            },
            {
                "_links": {
                    "self": {
                        "href": "https://api.dwolla.com/external-parties/585176d7-97d8-49d0-b94d-3aa2719dde58",
                        "type": "application/vnd.dwolla.v1.hal+json",
                        "resource-type": "external-party"
                    }
                },
                "id": "585176d7-97d8-49d0-b94d-3aa2719dde58",
                "created": "2023-09-19T16:22:42.910Z",
                "firstName": "Jane",
                "lastName": "Doe",
                "email": "email@email.com",
                "externalPartyType": "personal"
            },
        ]
    }
}

Retrieve an external party

Test in the Sandbox for free today.

Use sandbox environment to test API requests.

Get API Keys

Dwolla

Product

Developers

Financial institutions play an important role in our network.

All funds transfers made using the Dwolla Platform are performed by a financial institution partner, and any funds held in a Dwolla Balance are held by a financial institution partner. Learn more about our financial institution partners.