itflow/plugins/stripe-php/lib/BalanceSettings.php

62 lines
2.5 KiB
PHP
Raw Permalink Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<?php
// File generated from our OpenAPI spec
namespace Stripe;
/**
* Options for customizing account balances and payout settings for a Stripe platforms connected accounts.
*
* @property string $object String representing the object's type. Objects of the same type share the same value.
* @property (object{debit_negative_balances: null|bool, payouts: null|(object{minimum_balance_by_currency: null|StripeObject, schedule: null|(object{interval: null|string, monthly_payout_days?: int[], weekly_payout_days?: string[]}&StripeObject), statement_descriptor: null|string, status: string}&StripeObject), settlement_timing: (object{delay_days: int, delay_days_override?: int}&StripeObject)}&StripeObject) $payments
*/
class BalanceSettings extends SingletonApiResource
{
const OBJECT_NAME = 'balance_settings';
use ApiOperations\Update;
/**
* Retrieves balance settings for a given connected account. Related guide: <a
* href="/connect/authentication">Making API calls for connected accounts</a>.
*
* @param null|array|string $opts
*
* @return BalanceSettings
*
* @throws Exception\ApiErrorException if the request fails
*/
public static function retrieve($opts = null)
{
$opts = Util\RequestOptions::parse($opts);
$instance = new static(null, $opts);
$instance->refresh();
return $instance;
}
/**
* Updates balance settings for a given connected account. Related guide: <a
* href="/connect/authentication">Making API calls for connected accounts</a>.
*
* @param string $id the ID of the resource to update
* @param null|array{expand?: string[], payments?: array{debit_negative_balances?: bool, payouts?: array{minimum_balance_by_currency?: null|array<string, null|int>, schedule?: array{interval?: string, monthly_payout_days?: int[], weekly_payout_days?: string[]}, statement_descriptor?: string}, settlement_timing?: array{delay_days_override?: null|int}}} $params
* @param null|array|string $opts
*
* @return BalanceSettings the updated resource
*
* @throws Exception\ApiErrorException if the request fails
*/
public static function update($id, $params = null, $opts = null)
{
self::_validateParams($params);
$url = static::resourceUrl($id);
list($response, $opts) = static::_staticRequest('post', $url, $params, $opts);
$obj = Util\Util::convertToStripeObject($response->json, $opts);
$obj->setLastResponse($response);
return $obj;
}
}