Authentication insight
Use Authentication Insight to find out whether a transaction is regulated under PSD2 SCA rules before you decide whether to run 3D Secure authentication.
Prerequisites
- A working Hosted Fields integration, if you're requesting insight at tokenization time.
- A payment method already saved to the vault, if you're requesting insight for a vaulted payment method.
- Your merchant account ID.
Authentication Insight gives you more information about the regulatory environment and applicable customer authentication regulation for a potential transaction. This helps you decide whether to run 3D Secure authentication.
Use the regulation environment information in the Authentication Insight to decide whether to run a 3D Secure verification, or continue without one. If you choose to run a 3D Secure verification, continue using the payment method nonce as you would for any transaction.
The regulation environment field currently has three possible values:
| Regulation environment | Description |
|---|---|
psd2 | The impending transaction, when using the provided payment method nonce and merchant account, is believed to be within scope of PSD2 SCA regulations and requires 3D Secure authentication. |
unregulated | The impending transaction is not believed to be within scope of any SCA regulations, PSD2 or otherwise. |
unavailable | The impending transaction's SCA regulation environment could not be determined. |
These values may change as global regulations evolve.
To request Authentication Insight, include authenticationInsight.merchantAccountId in
the options object you pass to Hosted Fields:
- Async/Await
async function tokenize() {
try {
const payload = await hostedFieldsInstance.tokenize({
authenticationInsight: {
merchantAccountId: 'merchant-account-id'
}
});
// access regulation environment
const regulationEnvironment = payload.authenticationInsight.regulationEnvironment;
} catch (error) {
// Handle error
}
}A successful call returns payload.authenticationInsight.regulationEnvironment set to
psd2, unregulated, or unavailable.
Request authentication insight for a vaulted payment method
You can request Authentication Insight for a customer's payment method stored in the vault. To
retrieve the Authentication Insight for a single-use token, set authentication_insight
to true and specify your merchant_account_id.
- Ruby
- C#
- Java
- Node
- PHP
- Python
create_request = {
merchant_account_id: "merchant-account-id",
authentication_insight: true
}
result = gateway.payment_method_nonce.create(
"payment-method-token",
payment_method_nonce: create_request
)
regulation_environment = result.payment_method_nonce.authentication_insight[:regulation_environment]A successful call returns the payment method nonce's authentication insight with a regulation
environment value of psd2, unregulated, or unavailable.
For example, in Node, this is response.paymentMethodNonce.authenticationInsight.regulationEnvironment.
Test with sandbox cards
Use the following test cards to return the different regulation environment values when you request Authentication Insight on tokenization. The value returned depends on the merchant account you specify.
| Test value | Card information | Regulation environment value |
|---|---|---|
4012000033330620 | Country of issuance: USA |
|
4023490000000008 | Country of issuance: IRL |
|