Skip to content

Latest commit

 

History

History
151 lines (107 loc) · 5.95 KB

payouts.md

File metadata and controls

151 lines (107 loc) · 5.95 KB
Raw

Payouts

$payoutsApi = $client->getPayoutsApi();

Class Name

PayoutsApi

Methods

List Payouts

Retrieves a list of all payouts for the default location. You can filter payouts by location ID, status, time range, and order them in ascending or descending order. To call this endpoint, set PAYOUTS_READ for the OAuth scope.

function listPayouts(
    ?string $locationId = null,
    ?string $status = null,
    ?string $beginTime = null,
    ?string $endTime = null,
    ?string $sortOrder = null,
    ?string $cursor = null,
    ?int $limit = null
): ApiResponse

Parameters

Parameter Type Tags Description
locationId ?string Query, Optional The ID of the location for which to list the payouts.
By default, payouts are returned for the default (main) location associated with the seller.
status ?string(PayoutStatus) Query, Optional If provided, only payouts with the given status are returned.
beginTime ?string Query, Optional The timestamp for the beginning of the payout creation time, in RFC 3339 format.
Inclusive. Default: The current time minus one year.
endTime ?string Query, Optional The timestamp for the end of the payout creation time, in RFC 3339 format.
Default: The current time.
sortOrder ?string(SortOrder) Query, Optional The order in which payouts are listed.
cursor ?string Query, Optional A pagination cursor returned by a previous call to this endpoint.
Provide this cursor to retrieve the next set of results for the original query.
For more information, see Pagination.
If request parameters change between requests, subsequent results may contain duplicates or missing records.
limit ?int Query, Optional The maximum number of results to be returned in a single page.
It is possible to receive fewer results than the specified limit on a given page.
The default value of 100 is also the maximum allowed value. If the provided value is
greater than 100, it is ignored and the default value is used instead.
Default: 100

Response Type

This method returns a Square\Utils\ApiResponse instance. The getResult() method on this instance returns the response data which is of type ListPayoutsResponse.

Example Usage

$apiResponse = $payoutsApi->listPayouts();

if ($apiResponse->isSuccess()) {
    $listPayoutsResponse = $apiResponse->getResult();
} else {
    $errors = $apiResponse->getErrors();
}

// Getting more response information
var_dump($apiResponse->getStatusCode());
var_dump($apiResponse->getHeaders());

Get Payout

Retrieves details of a specific payout identified by a payout ID. To call this endpoint, set PAYOUTS_READ for the OAuth scope.

function getPayout(string $payoutId): ApiResponse

Parameters

Parameter Type Tags Description
payoutId string Template, Required The ID of the payout to retrieve the information for.

Response Type

This method returns a Square\Utils\ApiResponse instance. The getResult() method on this instance returns the response data which is of type GetPayoutResponse.

Example Usage

$payoutId = 'payout_id6';

$apiResponse = $payoutsApi->getPayout($payoutId);

if ($apiResponse->isSuccess()) {
    $getPayoutResponse = $apiResponse->getResult();
} else {
    $errors = $apiResponse->getErrors();
}

// Getting more response information
var_dump($apiResponse->getStatusCode());
var_dump($apiResponse->getHeaders());

List Payout Entries

Retrieves a list of all payout entries for a specific payout. To call this endpoint, set PAYOUTS_READ for the OAuth scope.

function listPayoutEntries(
    string $payoutId,
    ?string $sortOrder = null,
    ?string $cursor = null,
    ?int $limit = null
): ApiResponse

Parameters

Parameter Type Tags Description
payoutId string Template, Required The ID of the payout to retrieve the information for.
sortOrder ?string(SortOrder) Query, Optional The order in which payout entries are listed.
cursor ?string Query, Optional A pagination cursor returned by a previous call to this endpoint.
Provide this cursor to retrieve the next set of results for the original query.
For more information, see Pagination.
If request parameters change between requests, subsequent results may contain duplicates or missing records.
limit ?int Query, Optional The maximum number of results to be returned in a single page.
It is possible to receive fewer results than the specified limit on a given page.
The default value of 100 is also the maximum allowed value. If the provided value is
greater than 100, it is ignored and the default value is used instead.
Default: 100

Response Type

This method returns a Square\Utils\ApiResponse instance. The getResult() method on this instance returns the response data which is of type ListPayoutEntriesResponse.

Example Usage

$payoutId = 'payout_id6';

$apiResponse = $payoutsApi->listPayoutEntries($payoutId);

if ($apiResponse->isSuccess()) {
    $listPayoutEntriesResponse = $apiResponse->getResult();
} else {
    $errors = $apiResponse->getErrors();
}

// Getting more response information
var_dump($apiResponse->getStatusCode());
var_dump($apiResponse->getHeaders());