78 lines
3.0 KiB
PHP
78 lines
3.0 KiB
PHP
<?php
|
|
|
|
// File generated from our OpenAPI spec
|
|
|
|
namespace Stripe\Service\Treasury;
|
|
|
|
/**
|
|
* @phpstan-import-type RequestOptionsArray from \Stripe\Util\RequestOptions
|
|
*
|
|
* @psalm-import-type RequestOptionsArray from \Stripe\Util\RequestOptions
|
|
*/
|
|
class OutboundTransferService extends \Stripe\Service\AbstractService
|
|
{
|
|
/**
|
|
* Returns a list of OutboundTransfers sent from the specified FinancialAccount.
|
|
*
|
|
* @param null|array{ending_before?: string, expand?: string[], financial_account: string, limit?: int, starting_after?: string, status?: string} $params
|
|
* @param null|RequestOptionsArray|\Stripe\Util\RequestOptions $opts
|
|
*
|
|
* @return \Stripe\Collection<\Stripe\Treasury\OutboundTransfer>
|
|
*
|
|
* @throws \Stripe\Exception\ApiErrorException if the request fails
|
|
*/
|
|
public function all($params = null, $opts = null)
|
|
{
|
|
return $this->requestCollection('get', '/v1/treasury/outbound_transfers', $params, $opts);
|
|
}
|
|
|
|
/**
|
|
* An OutboundTransfer can be canceled if the funds have not yet been paid out.
|
|
*
|
|
* @param string $id
|
|
* @param null|array{expand?: string[]} $params
|
|
* @param null|RequestOptionsArray|\Stripe\Util\RequestOptions $opts
|
|
*
|
|
* @return \Stripe\Treasury\OutboundTransfer
|
|
*
|
|
* @throws \Stripe\Exception\ApiErrorException if the request fails
|
|
*/
|
|
public function cancel($id, $params = null, $opts = null)
|
|
{
|
|
return $this->request('post', $this->buildPath('/v1/treasury/outbound_transfers/%s/cancel', $id), $params, $opts);
|
|
}
|
|
|
|
/**
|
|
* Creates an OutboundTransfer.
|
|
*
|
|
* @param null|array{amount: int, currency: string, description?: string, destination_payment_method?: string, destination_payment_method_data?: array{financial_account?: string, type: string}, destination_payment_method_options?: array{us_bank_account?: null|array{network?: string}}, expand?: string[], financial_account: string, metadata?: array<string, string>, statement_descriptor?: string} $params
|
|
* @param null|RequestOptionsArray|\Stripe\Util\RequestOptions $opts
|
|
*
|
|
* @return \Stripe\Treasury\OutboundTransfer
|
|
*
|
|
* @throws \Stripe\Exception\ApiErrorException if the request fails
|
|
*/
|
|
public function create($params = null, $opts = null)
|
|
{
|
|
return $this->request('post', '/v1/treasury/outbound_transfers', $params, $opts);
|
|
}
|
|
|
|
/**
|
|
* Retrieves the details of an existing OutboundTransfer by passing the unique
|
|
* OutboundTransfer ID from either the OutboundTransfer creation request or
|
|
* OutboundTransfer list.
|
|
*
|
|
* @param string $id
|
|
* @param null|array{expand?: string[]} $params
|
|
* @param null|RequestOptionsArray|\Stripe\Util\RequestOptions $opts
|
|
*
|
|
* @return \Stripe\Treasury\OutboundTransfer
|
|
*
|
|
* @throws \Stripe\Exception\ApiErrorException if the request fails
|
|
*/
|
|
public function retrieve($id, $params = null, $opts = null)
|
|
{
|
|
return $this->request('get', $this->buildPath('/v1/treasury/outbound_transfers/%s', $id), $params, $opts);
|
|
}
|
|
}
|