Skip to content

Latest commit

 

History

History
66 lines (45 loc) · 3.05 KB

File metadata and controls

66 lines (45 loc) · 3.05 KB

Accounts.MassPayments

Overview

Available Operations

  • list - List account mass payments

list

Returns a paginated list of mass payments created by your Main Dwolla account. Results are sorted by creation date in descending order (newest first) and can be filtered by correlation ID.

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->accounts->massPayments->list(
    id: '<id>',
    limit: 25,
    offset: 0

);

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

Parameters

Parameter Type Required Description Example
id string ✔️ Account's unique identifier
limit ?int Maximum number of results to return 25
offset ?int How many results to skip. 0
correlationId ?string Correlation ID to search by.

Response

?Operations\ListMassPaymentsResponse

Errors

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