Skip to content

Latest commit

 

History

History
106 lines (70 loc) · 3.54 KB

File metadata and controls

106 lines (70 loc) · 3.54 KB

ExchangePartners

Overview

Available Operations

  • list - List exchange partners
  • get - Retrieve exchange partner

list

Returns a list of all supported exchange partners. Each partner includes a unique ID, name, and status indicating whether they are active or inactive.

Example Usage

declare(strict_types=1);

require 'vendor/autoload.php';

use Dwolla;
use Dwolla\Models\Components;

$sdk = Dwolla\Dwolla::builder()
    ->setSecurity(
        new Components\Security(
            clientID: '<YOUR_CLIENT_ID_HERE>',
            clientSecret: '<YOUR_CLIENT_SECRET_HERE>',
        )
    )
    ->build();



$response = $sdk->exchangePartners->list(

);

if ($response->exchangePartners !== null) {
    // handle response
}

Response

?Operations\ListExchangePartnersResponse

Errors

Error Type Status Code Content Type
Errors\ForbiddenError 403 application/vnd.dwolla.v1.hal+json
Errors\APIException 4XX, 5XX */*

get

Returns details for a specific open banking provider that integrates with Dwolla. Includes partner name, status, and creation date. Use this to verify partner availability before creating exchanges and funding sources.

Example Usage

declare(strict_types=1);

require 'vendor/autoload.php';

use Dwolla;
use Dwolla\Models\Components;

$sdk = Dwolla\Dwolla::builder()
    ->setSecurity(
        new Components\Security(
            clientID: '<YOUR_CLIENT_ID_HERE>',
            clientSecret: '<YOUR_CLIENT_SECRET_HERE>',
        )
    )
    ->build();



$response = $sdk->exchangePartners->get(
    id: '292317ec-e252-47d8-93c3-2d128e037aa4'
);

if ($response->exchangePartner !== null) {
    // handle response
}

Parameters

Parameter Type Required Description Example
id string ✔️ Exchange Partner resource unique identifier. 292317ec-e252-47d8-93c3-2d128e037aa4

Response

?Operations\GetExchangePartnerResponse

Errors

Error Type Status Code Content Type
Errors\NotFoundError 404 application/vnd.dwolla.v1.hal+json
Errors\APIException 4XX, 5XX */*