Class: BreadMachine::SecureTrading::St3dCardQueryResponse

Inherits:
XpayResponse
  • Object
show all
Defined in:
lib/breadmachine/secure_trading/st_3d_card_query_response.rb

Overview

A response object which tells us what happened with a 3-D Secure enrollment check.

Instance Method Summary collapse

Methods inherited from XpayResponse

#error?, #initialize, #message, #result

Constructor Details

This class inherits a constructor from BreadMachine::SecureTrading::XpayResponse

Instance Method Details

#acs_url ⇒ Object

The URL of the 3-D Secure ACS page (see README) to redirect to.



89
90
91
 
# File 'lib/breadmachine/secure_trading/st_3d_card_query_response.rb', line 89

def acs_url
  @xml.xpath('//OperationResponse/AcsUrl').text
end

#auth_type ⇒ Object 



111
112
113
114
115
 
# File 'lib/breadmachine/secure_trading/st_3d_card_query_response.rb', line 111

def auth_type
  self.result == '1' ?
    BreadMachine::SecureTrading::St3dAuthRequest :
    BreadMachine::SecureTrading::AuthRequest
end

#enrolled ⇒ Object

Is the card enrolled in 3-D Secure?

Returns "Y", "N", "U", "N/A"

From our reading of the XPay documentation, N/A (not available) will be returned in cases where the result is an error. N (no) will be returned if the card is not currently enrolled. U (unknown) will be returned in cases where the credit card provider returns an ambiguous response to the enrollment check. You should redirect the user to a 3-D Secure auth check page in this case. Y (yes) will be returned if the card is enrolled. You should redirect the user to a 3-D Secure auth check page in this case.



35
36
37
 
# File 'lib/breadmachine/secure_trading/st_3d_card_query_response.rb', line 35

def enrolled
  @xml.xpath('//OperationResponse/Enrolled').text
end

#html ⇒ Object

The ACS HTML POST form returned by the request. This is an extremely ugly html page containing all of the form parameters needed to identify the user for a 3-D Secure authentication check. It's possible (and probably desirable) to make your own page and style it how you want, including the same parameters, but this page is a good first step during integration.

If you need to redirect a user to the 3-D Secure ACS page, you can do something like

if response.should_redirect? render :text => CGI.unescape(response.html) end

The returned HTML contains a javascript call which will submit the form automatically with the correct POST parameters for this request (or display an ugly HTML page telling the user to click to redirect to 3-D Secure).



137
138
139
 
# File 'lib/breadmachine/secure_trading/st_3d_card_query_response.rb', line 137

def html
  @xml.xpath('//OperationResponse/Html').text
end

#md ⇒ Object

A unique reference generated according to the 3-D Secure specification (currently up to 1024 bytes in base64 format). It will be returned to the merchant in the case of receiving an of Y. This can be used by the merchant to tie up a response obtained from an ACS after the customer’s authentication process.



72
73
74
 
# File 'lib/breadmachine/secure_trading/st_3d_card_query_response.rb', line 72

def md
  @xml.xpath('//OperationResponse/MD').text
end

#normal_auth? ⇒ Boolean

If this returns true, you can perform a regular auth check for funds.

Returns:

  • (Boolean) 


62
63
64
 
# File 'lib/breadmachine/secure_trading/st_3d_card_query_response.rb', line 62

def normal_auth?
  self.result != "1"
end

#pa_req ⇒ Object

The pa_req contains purchase transaction details upon which ACS authentication decisions are based.

If you are making your own customised redirect page instead of using the provided then this field MUST be included in that html, as a hidden field.



83
84
85
 
# File 'lib/breadmachine/secure_trading/st_3d_card_query_response.rb', line 83

def pa_req
  @xml.xpath('//OperationResponse/PaReq').text
end

#successful? ⇒ Boolean

Checks whether the request was successfully processed. A true response does not necessarily mean anything other than the XPay service acknowledged that it has talked to you successfully.

From the XPay docs: self.result '2' means "the request was successfully processed but the 3-D Secure process cannot be continued". This would happen in the case of a credit card provider which is not participating in 3-D Secure.

Returns:

  • (Boolean) 


18
19
20
 
# File 'lib/breadmachine/secure_trading/st_3d_card_query_response.rb', line 18

def successful?
  self.result == '1' || self.result == '2'
end

#term_url ⇒ Object

The URL which the ACS will send the user to after they have authenticated.

This is informational as you passed it in so hopefully you know what it is. ;)



99
100
101
 
# File 'lib/breadmachine/secure_trading/st_3d_card_query_response.rb', line 99

def term_url
  @xml.xpath('//OperationResponse/TermUrl').text
end

#three_d_auth_with_redirect? ⇒ Boolean

If this is true, you should redirect your user to a 3-D Secure access control server (ACS) page.

Result = 1 from the card enrollment query means that the card issuer is part of 3-D Secure and that a 3-D Secure auth should be performed.

Enrolled = "Y" means that the card is enrolled in 3-D Secure and that the user should be redirected to ACS to authenticate.

Returns:

  • (Boolean) 


48
49
50
 
# File 'lib/breadmachine/secure_trading/st_3d_card_query_response.rb', line 48

def three_d_auth_with_redirect?
  self.result == "1" && enrolled == "Y"
end

#three_d_auth_without_redirect? ⇒ Boolean

If a card provider is part of 3D-Secure but the card is not enrolled, it is still necessary to do a 3-D Secure auth request for funds even though we do not need to redirect the user to the ACS server.

Returns:

  • (Boolean) 


56
57
58
 
# File 'lib/breadmachine/secure_trading/st_3d_card_query_response.rb', line 56

def three_d_auth_without_redirect?
  self.result == "1" && enrolled != "Y"
end

#transaction_reference ⇒ Object 



103
104
105
 
# File 'lib/breadmachine/secure_trading/st_3d_card_query_response.rb', line 103

def transaction_reference
  @xml.xpath('//OperationResponse/TransactionReference').text
end

#transaction_verifier ⇒ Object 



107
108
109
 
# File 'lib/breadmachine/secure_trading/st_3d_card_query_response.rb', line 107

def transaction_verifier
  @xml.xpath('//OperationResponse/TransactionVerifier').text
end