charge type:
*
* Direct configurations apply to payments created on your account, including Connect destination charges, Connect separate charges and transfers, and payments not involving Connect.
*
* Child configurations apply to payments created on your connected accounts using direct charges, and charges with the on_behalf_of parameter.
*
* Child configurations have a parent that sets default values and controls which settings connected accounts may override. You can specify a parent ID at payment time, and Stripe will automatically resolve the connected account’s associated child configuration. Parent configurations are managed in the dashboard and are not available in this API.
*
* Related guides:
* - Payment Method Configurations API
* - Multiple configurations on dynamic payment methods
* - Multiple configurations for your Connect accounts
*
* @property string $id Unique identifier for the object.
* @property string $object String representing the object's type. Objects of the same type share the same value.
* @property null|\Stripe\StripeObject $acss_debit
* @property bool $active Whether the configuration can be used for new payments.
* @property null|\Stripe\StripeObject $affirm
* @property null|\Stripe\StripeObject $afterpay_clearpay
* @property null|\Stripe\StripeObject $alipay
* @property null|\Stripe\StripeObject $amazon_pay
* @property null|\Stripe\StripeObject $apple_pay
* @property null|string $application For child configs, the Connect application associated with the configuration.
* @property null|\Stripe\StripeObject $au_becs_debit
* @property null|\Stripe\StripeObject $bacs_debit
* @property null|\Stripe\StripeObject $bancontact
* @property null|\Stripe\StripeObject $blik
* @property null|\Stripe\StripeObject $boleto
* @property null|\Stripe\StripeObject $card
* @property null|\Stripe\StripeObject $cartes_bancaires
* @property null|\Stripe\StripeObject $cashapp
* @property null|\Stripe\StripeObject $customer_balance
* @property null|\Stripe\StripeObject $eps
* @property null|\Stripe\StripeObject $fpx
* @property null|\Stripe\StripeObject $giropay
* @property null|\Stripe\StripeObject $google_pay
* @property null|\Stripe\StripeObject $grabpay
* @property null|\Stripe\StripeObject $ideal
* @property bool $is_default The default configuration is used whenever a payment method configuration is not specified.
* @property null|\Stripe\StripeObject $jcb
* @property null|\Stripe\StripeObject $klarna
* @property null|\Stripe\StripeObject $konbini
* @property null|\Stripe\StripeObject $link
* @property bool $livemode Has the value true if the object exists in live mode or the value false if the object exists in test mode.
* @property null|\Stripe\StripeObject $mobilepay
* @property null|\Stripe\StripeObject $multibanco
* @property string $name The configuration's name.
* @property null|\Stripe\StripeObject $oxxo
* @property null|\Stripe\StripeObject $p24
* @property null|string $parent For child configs, the configuration's parent configuration.
* @property null|\Stripe\StripeObject $paynow
* @property null|\Stripe\StripeObject $paypal
* @property null|\Stripe\StripeObject $promptpay
* @property null|\Stripe\StripeObject $revolut_pay
* @property null|\Stripe\StripeObject $sepa_debit
* @property null|\Stripe\StripeObject $sofort
* @property null|\Stripe\StripeObject $swish
* @property null|\Stripe\StripeObject $twint
* @property null|\Stripe\StripeObject $us_bank_account
* @property null|\Stripe\StripeObject $wechat_pay
* @property null|\Stripe\StripeObject $zip
*/
class PaymentMethodConfiguration extends ApiResource
{
const OBJECT_NAME = 'payment_method_configuration';
use ApiOperations\Update;
/**
* Creates a payment method configuration.
*
* @param null|array $params
* @param null|array|string $options
*
* @throws \Stripe\Exception\ApiErrorException if the request fails
*
* @return \Stripe\PaymentMethodConfiguration the created resource
*/
public static function create($params = null, $options = null)
{
self::_validateParams($params);
$url = static::classUrl();
list($response, $opts) = static::_staticRequest('post', $url, $params, $options);
$obj = \Stripe\Util\Util::convertToStripeObject($response->json, $opts);
$obj->setLastResponse($response);
return $obj;
}
/**
* List payment method configurations.
*
* @param null|array $params
* @param null|array|string $opts
*
* @throws \Stripe\Exception\ApiErrorException if the request fails
*
* @return \Stripe\Collection<\Stripe\PaymentMethodConfiguration> of ApiResources
*/
public static function all($params = null, $opts = null)
{
$url = static::classUrl();
return static::_requestPage($url, \Stripe\Collection::class, $params, $opts);
}
/**
* Retrieve payment method configuration.
*
* @param array|string $id the ID of the API resource to retrieve, or an options array containing an `id` key
* @param null|array|string $opts
*
* @throws \Stripe\Exception\ApiErrorException if the request fails
*
* @return \Stripe\PaymentMethodConfiguration
*/
public static function retrieve($id, $opts = null)
{
$opts = \Stripe\Util\RequestOptions::parse($opts);
$instance = new static($id, $opts);
$instance->refresh();
return $instance;
}
/**
* Update payment method configuration.
*
* @param string $id the ID of the resource to update
* @param null|array $params
* @param null|array|string $opts
*
* @throws \Stripe\Exception\ApiErrorException if the request fails
*
* @return \Stripe\PaymentMethodConfiguration the updated resource
*/
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 = \Stripe\Util\Util::convertToStripeObject($response->json, $opts);
$obj->setLastResponse($response);
return $obj;
}
}