103 lines
3.6 KiB
PHP
103 lines
3.6 KiB
PHP
<?php
|
||
|
||
// File generated from our OpenAPI spec
|
||
|
||
namespace Stripe\Service;
|
||
|
||
/**
|
||
* @phpstan-import-type RequestOptionsArray from \Stripe\Util\RequestOptions
|
||
*
|
||
* @psalm-import-type RequestOptionsArray from \Stripe\Util\RequestOptions
|
||
*/
|
||
class PaymentMethodDomainService extends AbstractService
|
||
{
|
||
/**
|
||
* Lists the details of existing payment method domains.
|
||
*
|
||
* @param null|array{domain_name?: string, enabled?: bool, ending_before?: string, expand?: string[], limit?: int, starting_after?: string} $params
|
||
* @param null|RequestOptionsArray|\Stripe\Util\RequestOptions $opts
|
||
*
|
||
* @return \Stripe\Collection<\Stripe\PaymentMethodDomain>
|
||
*
|
||
* @throws \Stripe\Exception\ApiErrorException if the request fails
|
||
*/
|
||
public function all($params = null, $opts = null)
|
||
{
|
||
return $this->requestCollection('get', '/v1/payment_method_domains', $params, $opts);
|
||
}
|
||
|
||
/**
|
||
* Creates a payment method domain.
|
||
*
|
||
* @param null|array{domain_name: string, enabled?: bool, expand?: string[]} $params
|
||
* @param null|RequestOptionsArray|\Stripe\Util\RequestOptions $opts
|
||
*
|
||
* @return \Stripe\PaymentMethodDomain
|
||
*
|
||
* @throws \Stripe\Exception\ApiErrorException if the request fails
|
||
*/
|
||
public function create($params = null, $opts = null)
|
||
{
|
||
return $this->request('post', '/v1/payment_method_domains', $params, $opts);
|
||
}
|
||
|
||
/**
|
||
* Retrieves the details of an existing payment method domain.
|
||
*
|
||
* @param string $id
|
||
* @param null|array{expand?: string[]} $params
|
||
* @param null|RequestOptionsArray|\Stripe\Util\RequestOptions $opts
|
||
*
|
||
* @return \Stripe\PaymentMethodDomain
|
||
*
|
||
* @throws \Stripe\Exception\ApiErrorException if the request fails
|
||
*/
|
||
public function retrieve($id, $params = null, $opts = null)
|
||
{
|
||
return $this->request('get', $this->buildPath('/v1/payment_method_domains/%s', $id), $params, $opts);
|
||
}
|
||
|
||
/**
|
||
* Updates an existing payment method domain.
|
||
*
|
||
* @param string $id
|
||
* @param null|array{enabled?: bool, expand?: string[]} $params
|
||
* @param null|RequestOptionsArray|\Stripe\Util\RequestOptions $opts
|
||
*
|
||
* @return \Stripe\PaymentMethodDomain
|
||
*
|
||
* @throws \Stripe\Exception\ApiErrorException if the request fails
|
||
*/
|
||
public function update($id, $params = null, $opts = null)
|
||
{
|
||
return $this->request('post', $this->buildPath('/v1/payment_method_domains/%s', $id), $params, $opts);
|
||
}
|
||
|
||
/**
|
||
* Some payment methods might require additional steps to register a domain. If the
|
||
* requirements weren’t satisfied when the domain was created, the payment method
|
||
* will be inactive on the domain. The payment method doesn’t appear in Elements or
|
||
* Embedded Checkout for this domain until it is active.
|
||
*
|
||
* To activate a payment method on an existing payment method domain, complete the
|
||
* required registration steps specific to the payment method, and then validate
|
||
* the payment method domain with this endpoint.
|
||
*
|
||
* Related guides: <a
|
||
* href="/docs/payments/payment-methods/pmd-registration">Payment method
|
||
* domains</a>.
|
||
*
|
||
* @param string $id
|
||
* @param null|array{expand?: string[]} $params
|
||
* @param null|RequestOptionsArray|\Stripe\Util\RequestOptions $opts
|
||
*
|
||
* @return \Stripe\PaymentMethodDomain
|
||
*
|
||
* @throws \Stripe\Exception\ApiErrorException if the request fails
|
||
*/
|
||
public function validate($id, $params = null, $opts = null)
|
||
{
|
||
return $this->request('post', $this->buildPath('/v1/payment_method_domains/%s/validate', $id), $params, $opts);
|
||
}
|
||
}
|