README

Note

A newer PHP SDK is available! We recommend using the new dwolla-php SDK for new projects. The new SDK offers improved type safety, better error handling, and a more intuitive API. This legacy SDK (dwolla-swagger-php) will continue to be available, but new features and improvements will be focused on the new SDK.

This repository contains the source code for Dwolla's PHP-based SDK as generated by this fork of swagger-codegen, which allows developers to interact with Dwolla's server-side API via a PHP API. Any action that can be performed via an HTTP request can be made using this SDK when executed within a server-side environment.

Note:

Temporary PHP 7.4 support was added using these replacements:

• \$this\->([a-z0-9\_]+) = \$data\["([a-z0-9\_]+)"\]\; into \$this->$1 = \$data\["$2"\] ?? null;

Additionally, temporary PHP 8.1 support was added using these replacements:

• ([^\n]*public function (offsetExists|offsetGet|offsetSet|offsetUnset)) into #\[\\ReturnTypeWillChange\]\n$1

Table of Contents

• Getting Started
  • Installation
  • Initialization
    • Tokens
• Making Requests
  • High-Level Requests
    • Setting Headers
    • Responses
      • Success
      • Errors
• Changelog
• Community
• Additional Resources
• Credits

Getting Started

Installation

To begin using this SDK, you will first need to download it to your machine. We use Packagist to distribute this package, which allows it to be downloaded via Composer.

$ composer require dwolla/dwollaswagger
$ composer install

To use, just require your Composer autoload.php file.

require("../path/to/vendor/autoload.php");

Initialization

Before any API requests can be made, you must first determine which environment you will be using, as well as fetch the application key and secret. To fetch your application key and secret, please visit one of the following links:

• Production: https://dashboard.dwolla.com/applications
• Sandbox: https://dashboard-sandbox.dwolla.com/applications

Finally, you can create an instance of ApiClient after configuring the username and password values as the application key and secret that you fetched from one of the aforementioned links, respectively.

DwollaSwagger\Configuration::$username = "API_KEY";
DwollaSwagger\Configuration::$password = "API_SECRET";

# For Sandbox
$apiClient = new DwollaSwagger\ApiClient("https://api-sandbox.dwolla.com");

# For Production
$apiClient = new DwollaSwagger\ApiClient("https://api.dwolla.com");

Tokens

Application access tokens are used to authenticate against the API on behalf of an application. Application tokens can be used to access resources in the API that either belong to the application itself (webhooks, events, webhook-subscriptions) or the Dwolla Account that owns the application (accounts, customers, funding-sources, etc.). Application tokens are obtained by using the client_credentials OAuth grant type:

$tokensApi = new DwollaSwagger\TokensApi($apiClient);
$appToken = $tokensApi->token();

Application access tokens are short-lived: 1 hour. They do not include a refresh_token. When it expires, generate a new one using $tokensApi->token().

Making Requests

The Dwolla client provides high-level methods for interacting with the Dwolla API.

High-Level Requests

High-level methods make development easier by embedding information you would typically refer to Dwolla's API reference for in the SDK itself, such as endpoints, request arguments, and response deserialization. DwollaSwagger contains the API module, which allows the user to make requests, as well as models, which are data access objects that the library uses to deserialize responses.

Each model represents the different kinds of requests and responses that can be made with the Dwolla API. View the full list in the models directory.

The following API modules are available:

• Accounts
• Beneficial Owners
• Business Classifications
• Customers
• Documents
• Events
• Funding Sources
• Knowledge-Based Authentication (KBA)
• Labels
• Label Reallocations
• Ledger Entries
• Mass Payment Items
• On-Demand Authorizations
• Root
• Sandbox
• Tokens
• Transfers
• Webhooks
• Webhook Subscriptions

Setting Headers

You can pass custom headers in your requests as per the schema of the API models. Here is an example of creating a Customer with an Idempotency-Key header.

$customersApi = new DwollaSwagger\CustomersApi($apiClient);

$customer = $customersApi->create([
  "firstName" => "Jane",
  "lastName" => "Merchant",
  "email" => "jmerchant@nomail.net",
  "type" => "receive-only",
  "businessName" => "Jane Corp llc",
  "ipAddress" => "99.99.99.99"
], [
  "Idempotency-Key" => "51a62-3403-11e6-ac61-9e71128cae77"
]);
$customer; # => "https://api-sandbox.dwolla.com/customers/fc451a7a-ae30-4404-aB95-e3553fcd733f"

Responses

Success

# Retrieve an Account by ID
$accountsApi = new DwollaSwagger\AccountsApi($apiClient);
$account = $accountsApi->id("8a2cdc8d-629d-4a24-98ac-40b735229fe2");

# Retrieve a Customer by ID
$customerUrl = 'https://api-sandbox.dwolla.com/customers/07d59716-ef22-4fe6-98e8-f3190233dfb8';
$customersApi = new DwollaSwagger\CustomersApi($apiClient);
$customer = $customersApi->getCustomer($customerUrl);

# Create a customer funding source
$customerUrl = "https://api-sandbox.dwolla.com/customers/AB443D36-3757-44C1-A1B4-29727FB3111C";
$fsApi = new DwollaSwagger\FundingsourcesApi($apiClient);

$fundingSource = $fsApi->createCustomerFundingSource([
  "routingNumber" => "222222226",
  "accountNumber" => "123456789",
  "bankAccountType" => "checking",
  "name" => "Jane Doe’s Checking"
], $customerUrl);
$fundingSource; # => "https://api-sandbox.dwolla.com/funding-sources/375c6781-2a17-476c-84f7-db7d2f6ffb31"

Errors

You can wrap your requests in a try/catch block to handle errors.

try{
    $new_customer = $customersApi->create([
        //request_body
    ]);
} catch (Exception $e) {
    echo 'Caught exception: ',  $e->getResponseBody(), "\n";
}

Changelog

• 1.9.1: Fix PHP 8.2+ deprecation warnings by declaring return types for ArrayAccess interface methods. (Issue #62 Thanks, @tuongdm and @whoisthisstud!) (Issue #64 Thanks, @heenasuman!)
• 1.9.0: Add support for creating bank funding source using a plaidToken for a customer.
• 1.8.0: Add Exchanges and Exchange Partners API methods.
• 1.7.1: Fix bug around on-demand authorizations not parsing Dwolla response correctly.
• 1.7.0: New getCustomerCardToken method added to CustomersAPI for creating a card funding sources token for a customer.
• 1.6.0: New TokenApi adding support for application access token and client token requests.
• 1.5.0: API schema updated, CustomersApi updated to add support for email parameter on list customers.
• 1.4.1: Fix bug in #43 to replace null-coalesce operator with backwards-compatible ternary.
• 1.4.0: Add temporary support fix for PHP 7.4. Issue #41. (Thanks, @oprypkhantc!)
• 1.3.0: Add support for custom headers on all requests. (e.g. Idempotency-Key header)
• 1.2.0: Add KbaApi. See GitHub Releases for more information.
• 1.1.0: Add LabelsApi, LabelreallocationsApi, and LedgerentriesApi.
• 1.0.20: Fix previously patched issue with parsing Location header in 201 response in ApiClient.
• 1.0.19: Patch 201 response in ApiClient.
• 1.0.18: Patch controller in CreateCustomer model.
• 1.0.17: Update CustomersApi to update support beneficial owners. Update existing models.
• 1.0.16: See GitHub Releases for more information.
• 1.0.15: Optional parameters set to null.
• 1.0.14: Trim trailing slash from host url on initialization.
• 1.0.13: Add control over IPV4 and V6 connections.
• 1.0.12: Update CustomersApi to allow for null limit, offset, and search.
• 1.0.11: Allow pausing webhook subscription pause; Added support for removed funding source query params; and more.
• 1.0.10: Patch soft delete to deserialize with FundingSource model.
• 1.0.9: Add boolean type to fix deserialization
• 1.0.8: Add balance check endpoint in FundingSourcesApi. Fix transfer failure deserialization in transfer model.
• 1.0.7: API schema updated, CustomersAPI supports Customer search, new softDelete method in FundingSourcesApi.
• 1.0.6: Update TransfersApi to include cancel and getting transfer fees. Added some new models and updated some existing models.
• 1.0.5: API schema error fixed, FundingSource object now has _embedded key to fix serialization issues. Avoid using reserved PHP function names. CustomersApi gets endpoint for IAV verification. Added VerificationToken model.
• 1.0.3: Added RootApi. Changed auth_token to access_token in compliance with RFC-6749 nomenclature.
• 1.0.2: New methods added for FundingsourcesApi. More idiomatic response logic for HTTP 201 responses.
• 1.0.1: API schema updated, new methods in CustomersApi and TransfersApi
• 1.0.0: Initial release.

Community

• If you have any feedback, please reach out to us on our forums or by creating a GitHub issue.
• If you would like to contribute to this library, bug reports and pull requests are always appreciated!

Additional Resources

To learn more about Dwolla and how to integrate our product with your application, please consider visiting the following resources and becoming a member of our community!

• Dwolla
• Dwolla Developers
• SDKs and Tools
  • Dwolla SDK for C#
  • Dwolla SDK for Kotlin
  • Dwolla SDK for Node
  • Dwolla SDK for Python
  • Dwolla SDK for Ruby
• Developer Support Forum

Credits

This wrapper is semantically generated by a fork of swagger-codegen.

• swagger-codegen contributors
• David Stancu