<?php
// File generated from our OpenAPI spec
namespace Stripe\Service\Treasury;
class OutboundPaymentService extends \Stripe\Service\AbstractService
{
/**
* Returns a list of OutboundPayments sent from the specified FinancialAccount.
*
* @param null|array $params
* @param null|array|\Stripe\Util\RequestOptions $opts
*
* @throws \Stripe\Exception\ApiErrorException if the request fails
*
* @return \Stripe\Collection<\Stripe\Treasury\OutboundPayment>
*/
public function all($params = null, $opts = null)
{
return $this->requestCollection('get', '/v1/treasury/outbound_payments', $params, $opts);
}
/**
* Cancel an OutboundPayment.
*
* @param string $id
* @param null|array $params
* @param null|array|\Stripe\Util\RequestOptions $opts
*
* @throws \Stripe\Exception\ApiErrorException if the request fails
*
* @return \Stripe\Treasury\OutboundPayment
*/
public function cancel($id, $params = null, $opts = null)
{
return $this->request('post', $this->buildPath('/v1/treasury/outbound_payments/%s/cancel', $id), $params, $opts);
}
/**
* Creates an OutboundPayment.
*
* @param null|array $params
* @param null|array|\Stripe\Util\RequestOptions $opts
*
* @throws \Stripe\Exception\ApiErrorException if the request fails
*
* @return \Stripe\Treasury\OutboundPayment
*/
public function create($params = null, $opts = null)
{
return $this->request('post', '/v1/treasury/outbound_payments', $params, $opts);
}
/**
* Retrieves the details of an existing OutboundPayment by passing the unique
* OutboundPayment ID from either the OutboundPayment creation request or
* OutboundPayment list.
*
* @param string $id
* @param null|array $params
* @param null|array|\Stripe\Util\RequestOptions $opts
*
* @throws \Stripe\Exception\ApiErrorException if the request fails
*
* @return \Stripe\Treasury\OutboundPayment
*/
public function retrieve($id, $params = null, $opts = null)
{
return $this->request('get', $this->buildPath('/v1/treasury/outbound_payments/%s', $id), $params, $opts);
}
}