class Stripe::PaymentMethodDomainsApi
- Stripe::PaymentMethodDomainsApi
- Reference
- Object
Defined in:
stripe/api/payment_method_domains_api.crConstant Summary
-
GET_PAYMENT_METHOD_DOMAINS_MAX_LENGTH_FOR_DOMAIN_NAME =
5000 -
GET_PAYMENT_METHOD_DOMAINS_MAX_LENGTH_FOR_ENDING_BEFORE =
5000 -
GET_PAYMENT_METHOD_DOMAINS_MAX_LENGTH_FOR_STARTING_AFTER =
5000 -
GET_PAYMENT_METHOD_DOMAINS_PAYMENT_METHOD_DOMAIN_MAX_LENGTH_FOR_PAYMENT_METHOD_DOMAIN =
5000 -
POST_PAYMENT_METHOD_DOMAINS_MAX_LENGTH_FOR_DOMAIN_NAME =
5000 -
POST_PAYMENT_METHOD_DOMAINS_PAYMENT_METHOD_DOMAIN_MAX_LENGTH_FOR_PAYMENT_METHOD_DOMAIN =
5000 -
POST_PAYMENT_METHOD_DOMAINS_PAYMENT_METHOD_DOMAIN_VALIDATE_MAX_LENGTH_FOR_PAYMENT_METHOD_DOMAIN =
5000
Constructors
Instance Method Summary
- #api_client : ApiClient
- #api_client=(api_client : ApiClient)
-
#build_api_request_for_get_payment_method_domains(*, ending_before : String | Nil = nil, starting_after : String | Nil = nil, limit : Int64 | Nil = nil, expand : Array(Array(String)) | Nil = nil, domain_name : String | Nil = nil, enabled : Bool | Nil = nil) : Crest::Request
@return Crest::Request
-
#build_api_request_for_get_payment_method_domains_payment_method_domain(*, payment_method_domain : String | Nil = nil, expand : Array(Array(String)) | Nil = nil) : Crest::Request
@return Crest::Request
-
#build_api_request_for_post_payment_method_domains(*, domain_name : String | Nil = nil, enabled : Bool | Nil = nil, expand : Array(String) | Nil = nil) : Crest::Request
@return Crest::Request
-
#build_api_request_for_post_payment_method_domains_payment_method_domain(*, payment_method_domain : String | Nil = nil, enabled : Bool | Nil = nil, expand : Array(String) | Nil = nil) : Crest::Request
@return Crest::Request
-
#build_api_request_for_post_payment_method_domains_payment_method_domain_validate(*, payment_method_domain : String | Nil = nil, expand : Array(String) | Nil = nil) : Crest::Request
@return Crest::Request
- #client_side_validation?(*args, **options)
- #client_side_validation?(*args, **options, &)
- #debugging?(*args, **options)
- #debugging?(*args, **options, &)
-
#get_payment_method_domains(*, ending_before : String | Nil = nil, starting_after : String | Nil = nil, limit : Int64 | Nil = nil, expand : Array(Array(String)) | Nil = nil, domain_name : String | Nil = nil, enabled : Bool | Nil = nil) : Stripe::PaymentMethodDomainResourcePaymentMethodDomainList
Lists the details of existing payment method domains.
@optional @param ending_before [String?] A cursor for use in pagination. -
#get_payment_method_domains(*, ending_before : String | Nil = nil, starting_after : String | Nil = nil, limit : Int64 | Nil = nil, expand : Array(Array(String)) | Nil = nil, domain_name : String | Nil = nil, enabled : Bool | Nil = nil, &block : Crest::Response -> ) : Nil
<p>Lists the details of existing payment method domains.</p> @optional @param ending_before [String?] A cursor for use in pagination.
-
#get_payment_method_domains_payment_method_domain(*, payment_method_domain : String | Nil = nil, expand : Array(Array(String)) | Nil = nil) : Stripe::PaymentMethodDomain
Retrieves the details of an existing payment method domain.
@required @param payment_method_domain [String?] @optional @param expand [Array(Array(String))?] Specifies which fields in the response should be expanded. -
#get_payment_method_domains_payment_method_domain(*, payment_method_domain : String | Nil = nil, expand : Array(Array(String)) | Nil = nil, &block : Crest::Response -> ) : Nil
<p>Retrieves the details of an existing payment method domain.</p> @required @param payment_method_domain [String?] @optional @param expand [Array(Array(String))?] Specifies which fields in the response should be expanded.
-
#get_payment_method_domains_payment_method_domain_with_http_info(*, payment_method_domain : String | Nil = nil, expand : Array(Array(String)) | Nil = nil) : Tuple(Stripe::PaymentMethodDomain, Int32, Hash(String, Array(String) | String))
<p>Retrieves the details of an existing payment method domain.</p> @required @param payment_method_domain [String?] @optional @param expand [Array(Array(String))?] Specifies which fields in the response should be expanded.
-
#get_payment_method_domains_with_http_info(*, ending_before : String | Nil = nil, starting_after : String | Nil = nil, limit : Int64 | Nil = nil, expand : Array(Array(String)) | Nil = nil, domain_name : String | Nil = nil, enabled : Bool | Nil = nil) : Tuple(Stripe::PaymentMethodDomainResourcePaymentMethodDomainList, Int32, Hash(String, Array(String) | String))
<p>Lists the details of existing payment method domains.</p> @optional @param ending_before [String?] A cursor for use in pagination.
-
#post_payment_method_domains(*, domain_name : String | Nil = nil, enabled : Bool | Nil = nil, expand : Array(String) | Nil = nil) : Stripe::PaymentMethodDomain
Creates a payment method domain.
@required @param domain_name [String?] The domain name that this payment method domain object represents. -
#post_payment_method_domains(*, domain_name : String | Nil = nil, enabled : Bool | Nil = nil, expand : Array(String) | Nil = nil, &block : Crest::Response -> ) : Nil
<p>Creates a payment method domain.</p> @required @param domain_name [String?] The domain name that this payment method domain object represents.
-
#post_payment_method_domains_payment_method_domain(*, payment_method_domain : String | Nil = nil, enabled : Bool | Nil = nil, expand : Array(String) | Nil = nil) : Stripe::PaymentMethodDomain
Updates an existing payment method domain.
@required @param payment_method_domain [String?] @optional @param enabled [Bool?] Whether this payment method domain is enabled. -
#post_payment_method_domains_payment_method_domain(*, payment_method_domain : String | Nil = nil, enabled : Bool | Nil = nil, expand : Array(String) | Nil = nil, &block : Crest::Response -> ) : Nil
<p>Updates an existing payment method domain.</p> @required @param payment_method_domain [String?] @optional @param enabled [Bool?] Whether this payment method domain is enabled.
-
#post_payment_method_domains_payment_method_domain_validate(*, payment_method_domain : String | Nil = nil, expand : Array(String) | Nil = nil) : Stripe::PaymentMethodDomain
Some payment methods such as Apple Pay require additional steps to verify a domain.
-
#post_payment_method_domains_payment_method_domain_validate(*, payment_method_domain : String | Nil = nil, expand : Array(String) | Nil = nil, &block : Crest::Response -> ) : Nil
<p>Some payment methods such as Apple Pay require additional steps to verify a domain.
-
#post_payment_method_domains_payment_method_domain_validate_with_http_info(*, payment_method_domain : String | Nil = nil, expand : Array(String) | Nil = nil) : Tuple(Stripe::PaymentMethodDomain, Int32, Hash(String, Array(String) | String))
<p>Some payment methods such as Apple Pay require additional steps to verify a domain.
-
#post_payment_method_domains_payment_method_domain_with_http_info(*, payment_method_domain : String | Nil = nil, enabled : Bool | Nil = nil, expand : Array(String) | Nil = nil) : Tuple(Stripe::PaymentMethodDomain, Int32, Hash(String, Array(String) | String))
<p>Updates an existing payment method domain.</p> @required @param payment_method_domain [String?] @optional @param enabled [Bool?] Whether this payment method domain is enabled.
-
#post_payment_method_domains_with_http_info(*, domain_name : String | Nil = nil, enabled : Bool | Nil = nil, expand : Array(String) | Nil = nil) : Tuple(Stripe::PaymentMethodDomain, Int32, Hash(String, Array(String) | String))
<p>Creates a payment method domain.</p> @required @param domain_name [String?] The domain name that this payment method domain object represents.
Constructor Detail
Instance Method Detail
@return Crest::Request
@return Crest::Request
@return Crest::Request
@return Crest::Request
@return Crest::Request
Lists the details of existing payment method domains.
@optional @param ending_before [String?] A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. @optional @param starting_after [String?] A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. @optional @param limit [Int32?] A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. @optional @param expand [Array(Array(String))?] Specifies which fields in the response should be expanded. @optional @param domain_name [String?] The domain name that this payment method domain object represents. @optional @param enabled [Bool?] Whether this payment method domain is enabled. If the domain is not enabled, payment methods will not appear in Elements @return [Stripe::PaymentMethodDomainResourcePaymentMethodDomainList]<p>Lists the details of existing payment method domains.</p>
@optional @param ending_before [String?] A cursor for use in pagination. ending_before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_bar, your subsequent call can include ending_before=obj_bar in order to fetch the previous page of the list.
@optional @param starting_after [String?] A cursor for use in pagination. starting_after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include starting_after=obj_foo in order to fetch the next page of the list.
@optional @param limit [Int32?] A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
@optional @param expand [Array(Array(String))?] Specifies which fields in the response should be expanded.
@optional @param domain_name [String?] The domain name that this payment method domain object represents.
@optional @param enabled [Bool?] Whether this payment method domain is enabled. If the domain is not enabled, payment methods will not appear in Elements
@return nil
Retrieves the details of an existing payment method domain.
@required @param payment_method_domain [String?] @optional @param expand [Array(Array(String))?] Specifies which fields in the response should be expanded. @return [Stripe::PaymentMethodDomain]<p>Retrieves the details of an existing payment method domain.</p> @required @param payment_method_domain [String?] @optional @param expand [Array(Array(String))?] Specifies which fields in the response should be expanded. @return nil
<p>Retrieves the details of an existing payment method domain.</p> @required @param payment_method_domain [String?] @optional @param expand [Array(Array(String))?] Specifies which fields in the response should be expanded. @return [Tuple(Stripe::PaymentMethodDomain, Integer, Hash)] Stripe::PaymentMethodDomain, response status code and response headers
<p>Lists the details of existing payment method domains.</p>
@optional @param ending_before [String?] A cursor for use in pagination. ending_before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_bar, your subsequent call can include ending_before=obj_bar in order to fetch the previous page of the list.
@optional @param starting_after [String?] A cursor for use in pagination. starting_after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include starting_after=obj_foo in order to fetch the next page of the list.
@optional @param limit [Int32?] A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
@optional @param expand [Array(Array(String))?] Specifies which fields in the response should be expanded.
@optional @param domain_name [String?] The domain name that this payment method domain object represents.
@optional @param enabled [Bool?] Whether this payment method domain is enabled. If the domain is not enabled, payment methods will not appear in Elements
@return [Tuple(Stripe::PaymentMethodDomainResourcePaymentMethodDomainList, Integer, Hash)] Stripe::PaymentMethodDomainResourcePaymentMethodDomainList, response status code and response headers
Creates a payment method domain.
@required @param domain_name [String?] The domain name that this payment method domain object represents. @optional @param enabled [Bool?] Whether this payment method domain is enabled. If the domain is not enabled, payment methods that require a payment method domain will not appear in Elements. @optional @param expand [Array(String)?] Specifies which fields in the response should be expanded. @return [Stripe::PaymentMethodDomain]<p>Creates a payment method domain.</p> @required @param domain_name [String?] The domain name that this payment method domain object represents. @optional @param enabled [Bool?] Whether this payment method domain is enabled. If the domain is not enabled, payment methods that require a payment method domain will not appear in Elements. @optional @param expand [Array(String)?] Specifies which fields in the response should be expanded. @return nil
Updates an existing payment method domain.
@required @param payment_method_domain [String?] @optional @param enabled [Bool?] Whether this payment method domain is enabled. If the domain is not enabled, payment methods that require a payment method domain will not appear in Elements. @optional @param expand [Array(String)?] Specifies which fields in the response should be expanded. @return [Stripe::PaymentMethodDomain]<p>Updates an existing payment method domain.</p> @required @param payment_method_domain [String?] @optional @param enabled [Bool?] Whether this payment method domain is enabled. If the domain is not enabled, payment methods that require a payment method domain will not appear in Elements. @optional @param expand [Array(String)?] Specifies which fields in the response should be expanded. @return nil
Some payment methods such as Apple Pay require additional steps to verify 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 for this domain until it is active.
To activate a payment method on an existing payment method domain, complete the required validation steps specific to the payment method, and then validate the payment method domain with this endpoint.
Related guides: Payment method domains.
@required @param payment_method_domain [String?] @optional @param expand [Array(String)?] Specifies which fields in the response should be expanded. @return [Stripe::PaymentMethodDomain]<p>Some payment methods such as Apple Pay require additional steps to verify 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 for this domain until it is active.</p> <p>To activate a payment method on an existing payment method domain, complete the required validation steps specific to the payment method, and then validate the payment method domain with this endpoint.</p> <p>Related guides: <a href="/docs/payments/payment-methods/pmd-registration">Payment method domains</a>.</p> @required @param payment_method_domain [String?] @optional @param expand [Array(String)?] Specifies which fields in the response should be expanded. @return nil
<p>Some payment methods such as Apple Pay require additional steps to verify 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 for this domain until it is active.</p> <p>To activate a payment method on an existing payment method domain, complete the required validation steps specific to the payment method, and then validate the payment method domain with this endpoint.</p> <p>Related guides: <a href="/docs/payments/payment-methods/pmd-registration">Payment method domains</a>.</p> @required @param payment_method_domain [String?] @optional @param expand [Array(String)?] Specifies which fields in the response should be expanded. @return [Tuple(Stripe::PaymentMethodDomain, Integer, Hash)] Stripe::PaymentMethodDomain, response status code and response headers
<p>Updates an existing payment method domain.</p> @required @param payment_method_domain [String?] @optional @param enabled [Bool?] Whether this payment method domain is enabled. If the domain is not enabled, payment methods that require a payment method domain will not appear in Elements. @optional @param expand [Array(String)?] Specifies which fields in the response should be expanded. @return [Tuple(Stripe::PaymentMethodDomain, Integer, Hash)] Stripe::PaymentMethodDomain, response status code and response headers
<p>Creates a payment method domain.</p> @required @param domain_name [String?] The domain name that this payment method domain object represents. @optional @param enabled [Bool?] Whether this payment method domain is enabled. If the domain is not enabled, payment methods that require a payment method domain will not appear in Elements. @optional @param expand [Array(String)?] Specifies which fields in the response should be expanded. @return [Tuple(Stripe::PaymentMethodDomain, Integer, Hash)] Stripe::PaymentMethodDomain, response status code and response headers