Webhooks
The additional properties that have been added to the Create Payment response have also been added to the webhook payment events, in the event that a 3-D Secure version 2 authentication was completed.
Additional response properties related to 3-D Secure version 2
It is possible that the Authentication fails and the reason why will be detailed in the errors. It is also possible that the issuer will require Strong Customer Authentication (SCA) to be provided before the issuer will authorize the transaction. This means that you should process the transaction in a way that will allow SCA through for instance a challenge to take place.
The below overview shows all properties in the output that are used in the 3-D Secure version 2 authentication. For each of the properties we have marked them as follows:
- New - The property did not previously exist in our API.
- Moved - We have decided to move or rename an existing property to a more logical location.
- Existing - This is an existing property that is used in the authentication process.
- Deprecated - One property needed for 3-D Secure version 2 has an overlap with an existing property and in this case we have decided to deprecate the existing property as the new property needed to provide more detail.
Property name | Change / Type | Description | ||||||
---|---|---|---|---|---|---|---|---|
payment | Object | Object containing data regarding the payment | ||||||
paymentOutput | Object | Object containing output data regarding the payment | ||||||
cardPaymentMethodSpecificOutput | Object | Object containing card payment method specific output | ||||||
initialSchemeTransactionId | AN100 | The unique scheme transactionId of the initial transaction that was performed with SCA. Should be stored by the merchant to allow it to be submitted in future transactions. |
||||||
schemeTransactionId | AN100 | The unique scheme transactionId of this transaction. Should be stored by the merchant to allow it to be submitted in future transactions. Use this value in case the initialSchemeTransactionId property is empty. |
||||||
threeDSecureResults | Object | Object containing results of the 3D Secure authentication | ||||||
sdkData | Object | Object containing 3-D Secure in-app SDK data | ||||||
sdkTransactionId | AN36 |
Universally unique transaction identifier assigned by the 3-D Secure SDK to identify this transaction. |
||||||
threeDSecureData | Object | Object containing data regarding the 3D Secure authentication | ||||||
acsTransactionId | AN36 |
The ACS Transaction ID for this transaction. You should store this data as you will need it for the next transaction with the same card |
||||||
method | Enum (String) | Method of authentication used for this transaction. Possible values:
You should store this data as you will need it for the next transaction with the same card |
||||||
utcTimestamp | AN12 |
Timestamp in UTC (YYYYMMDDHHmm) of the 3-D Secure authentication of this transaction You should store this data as you will need it for the next transaction with the same card |
||||||
directoryServerTransactionId | AN36 |
The 3-D Secure Directory Server transaction ID that is used for the 3-D Secure version 2 Authentication This property is used in the communication with the acquirer |
||||||
threeDServerTransactionId | AN36 |
The 3-D Secure Server transaction ID that is used for the 3-D Secure version 2 Authentication This property is used in the communication with the acquirer |
||||||
threeDSecureVersion | AN10 |
The 3-D Secure version used for the authentication This property is used in the communication with the acquirer |
The above mentioned additional properties in the response to the Create Payment request have been added generically. This means that they are also returned on a Get Payment request and all other requests that return a paymentOutput object. Please note that they are only returned in case of a 3-D Secure version 2 authentication.