Class: Stripe::ThreeDSecure::AuthenticationService

Inherits:
StripeService
  • Object
show all
Defined in:
lib/stripe/services/three_d_secure/authentication_service.rb

Instance Method Summary collapse

Methods inherited from StripeService

#initialize, #request, #request_stream

Constructor Details

This class inherits a constructor from Stripe::StripeService

Instance Method Details

#cancel(authentication, params = {}, opts = {}) ⇒ Object

This endpoint cancels a 3DS Authentication. You can cancel a 3DS Authentication object when it's in a non-final status: requires_submission or requires_challenge.



9
10
11
12
13
14
15
16
17
 
# File 'lib/stripe/services/three_d_secure/authentication_service.rb', line 9

def cancel(authentication, params = {}, opts = {})
  request(
    method: :post,
    path: format("/v1/three_d_secure/authentications/%<authentication>s/cancel", { authentication: CGI.escape(authentication) }),
    params: params,
    opts: opts,
    base_address: :api
  )
end

#create(params = {}, opts = {}) ⇒ Object

This endpoint creates a 3DS Authentication. Refer to the Create a 3DS Authentication object section of the Standalone 3DS guide for more information.

You can pass the submit parameter to automatically submit the 3DS Authentication object when you create it. Refer to the Submit at creation section of the Standalone 3DS guide for more information.



22
23
24
25
26
27
28
29
30
 
# File 'lib/stripe/services/three_d_secure/authentication_service.rb', line 22

def create(params = {}, opts = {})
  request(
    method: :post,
    path: "/v1/three_d_secure/authentications",
    params: params,
    opts: opts,
    base_address: :api
  )
end

#list(params = {}, opts = {}) ⇒ Object

Returns a list of 3D Secure Authentications.



33
34
35
36
37
38
39
40
41
 
# File 'lib/stripe/services/three_d_secure/authentication_service.rb', line 33

def list(params = {}, opts = {})
  request(
    method: :get,
    path: "/v1/three_d_secure/authentications",
    params: params,
    opts: opts,
    base_address: :api
  )
end

#retrieve(authentication, params = {}, opts = {}) ⇒ Object

This endpoint retrieves a 3DS Authentication.



44
45
46
47
48
49
50
51
52
 
# File 'lib/stripe/services/three_d_secure/authentication_service.rb', line 44

def retrieve(authentication, params = {}, opts = {})
  request(
    method: :get,
    path: format("/v1/three_d_secure/authentications/%<authentication>s", { authentication: CGI.escape(authentication) }),
    params: params,
    opts: opts,
    base_address: :api
  )
end

#submit(authentication, params = {}, opts = {}) ⇒ Object

This endpoint submits a 3DS Authentication. You can submit a 3DS Authentication object when it has status requires_submission. Refer to the Submit the 3DS Authentication object section of the Standalone 3DS guide for more information.



55
56
57
58
59
60
61
62
63
 
# File 'lib/stripe/services/three_d_secure/authentication_service.rb', line 55

def submit(authentication, params = {}, opts = {})
  request(
    method: :post,
    path: format("/v1/three_d_secure/authentications/%<authentication>s/submit", { authentication: CGI.escape(authentication) }),
    params: params,
    opts: opts,
    base_address: :api
  )
end