@paydock/client-sdk 1.10.73-beta → 1.10.73
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +36 -4
- package/package.json +1 -1
- package/slate.md +36 -4
package/README.md
CHANGED
|
@@ -4603,10 +4603,42 @@ After you initialized the 3ds charge via `v1/charges/standalone-3ds` API endpoin
|
|
|
4603
4603
|
</html>
|
|
4604
4604
|
```
|
|
4605
4605
|
|
|
4606
|
-
|
|
4607
|
-
|
|
4608
|
-
|
|
4609
|
-
|
|
4606
|
+
The chargeAuthSuccess event is executed both for frictionless flow, or for challenge flow after the customer has correctly authenticated with the bank using whatever challenge imposed.
|
|
4607
|
+
The chargeAuthChallenge event is sent before starting a challenge flow (i.e. opening an IFrame for the customer to complete a challenge with ther bank)
|
|
4608
|
+
The chargeAuthDecoupled event is sent when the flow is a decoupled challenge, alongside a `data.result.description` field that you must show to the customer, indicating the method the user must use to authenticate. For example this may happen by having the cardholder authenticating directly with their banking app through biometrics. Once the end customer does this, the Canvas3ds will be able to recognize the challenge result is ready and will either produce a chargeAuthSuccess or chargeAuthReject event
|
|
4609
|
+
The error event is sent if an unexpected issue with the client library occurs. In such scenarios, you should consider the autentication process as interrupted
|
|
4610
|
+
|
|
4611
|
+
### Event and Values
|
|
4612
|
+
|
|
4613
|
+
| Event Value | Type | Description |
|
|
4614
|
+
| ------------------- | ------------------- | -------------------------------------------------------------- |
|
|
4615
|
+
| chargeAuthSuccess | <code>object</code> | Instance of [ChargeEventResponse](#cb_chargeEventResponse) |
|
|
4616
|
+
| chargeAuthReject | <code>object</code> | Instance of [ChargeEventResponse](#cb_chargeEventResponse) |
|
|
4617
|
+
| chargeAuthChallenge | <code>object</code> | Instance of [ChargeEventResponse](#cb_chargeEventResponse) |
|
|
4618
|
+
| chargeAuthDecoupled | <code>object</code> | Instance of [ChargeEventResponse](#cb_chargeEventResponse) |
|
|
4619
|
+
| error | <code>object</code> | Instance of [chargeError](#cb_chargeError) |
|
|
4620
|
+
|
|
4621
|
+
## Response Values
|
|
4622
|
+
|
|
4623
|
+
<a name="cb_chargeEventResponse" id="cb_chargeEventResponse"></a>
|
|
4624
|
+
|
|
4625
|
+
### ChargeEventResponse
|
|
4626
|
+
|
|
4627
|
+
| Param | Type | Description |
|
|
4628
|
+
| ------------------------------- | ------------------------------ | -------------------------------------------------------------------------------------------------- |
|
|
4629
|
+
| status | <code>string</code> | status for the event transaction |
|
|
4630
|
+
| charge_3ds_id | <code>string</code> | Universal unique transaction identifier to identify the transaction |
|
|
4631
|
+
| <code>result.description</code> | <code>string</code> [Optional] | field that you must show to the customer, indicating the method the user must use to authenticate. |
|
|
4632
|
+
|
|
4633
|
+
### ChargeError
|
|
4634
|
+
|
|
4635
|
+
<a name="cb_chargeError" id="cb_chargeError"></a>
|
|
4636
|
+
|
|
4637
|
+
| Param | Type | Description |
|
|
4638
|
+
| ------------- | ------------------- | ------------------------------------------------------------------- |
|
|
4639
|
+
| error | <code>object</code> | error response |
|
|
4640
|
+
| charge_3ds_id | <code>string</code> | Universal unique transaction identifier to identify the transaction |
|
|
4641
|
+
|
|
4610
4642
|
|
|
4611
4643
|
## Vault Display Widget
|
|
4612
4644
|
You can find description of all methods and parameters [here](https://www.npmjs.com/package/@paydock/client-sdk#vault-display-widget)
|
package/package.json
CHANGED
package/slate.md
CHANGED
|
@@ -875,10 +875,42 @@ After you initialized the 3ds charge via `v1/charges/standalone-3ds` API endpoin
|
|
|
875
875
|
</html>
|
|
876
876
|
```
|
|
877
877
|
|
|
878
|
-
|
|
879
|
-
|
|
880
|
-
|
|
881
|
-
|
|
878
|
+
The chargeAuthSuccess event is executed both for frictionless flow, or for challenge flow after the customer has correctly authenticated with the bank using whatever challenge imposed.
|
|
879
|
+
The chargeAuthChallenge event is sent before starting a challenge flow (i.e. opening an IFrame for the customer to complete a challenge with ther bank)
|
|
880
|
+
The chargeAuthDecoupled event is sent when the flow is a decoupled challenge, alongside a `data.result.description` field that you must show to the customer, indicating the method the user must use to authenticate. For example this may happen by having the cardholder authenticating directly with their banking app through biometrics. Once the end customer does this, the Canvas3ds will be able to recognize the challenge result is ready and will either produce a chargeAuthSuccess or chargeAuthReject event
|
|
881
|
+
The error event is sent if an unexpected issue with the client library occurs. In such scenarios, you should consider the autentication process as interrupted
|
|
882
|
+
|
|
883
|
+
### Event and Values
|
|
884
|
+
|
|
885
|
+
| Event Value | Type | Description |
|
|
886
|
+
| ------------------- | ------------------- | -------------------------------------------------------------- |
|
|
887
|
+
| chargeAuthSuccess | <code>object</code> | Instance of [ChargeEventResponse](#cb_chargeEventResponse) |
|
|
888
|
+
| chargeAuthReject | <code>object</code> | Instance of [ChargeEventResponse](#cb_chargeEventResponse) |
|
|
889
|
+
| chargeAuthChallenge | <code>object</code> | Instance of [ChargeEventResponse](#cb_chargeEventResponse) |
|
|
890
|
+
| chargeAuthDecoupled | <code>object</code> | Instance of [ChargeEventResponse](#cb_chargeEventResponse) |
|
|
891
|
+
| error | <code>object</code> | Instance of [chargeError](#cb_chargeError) |
|
|
892
|
+
|
|
893
|
+
## Response Values
|
|
894
|
+
|
|
895
|
+
<a name="cb_chargeEventResponse" id="cb_chargeEventResponse"></a>
|
|
896
|
+
|
|
897
|
+
### ChargeEventResponse
|
|
898
|
+
|
|
899
|
+
| Param | Type | Description |
|
|
900
|
+
| ------------------------------- | ------------------------------ | -------------------------------------------------------------------------------------------------- |
|
|
901
|
+
| status | <code>string</code> | status for the event transaction |
|
|
902
|
+
| charge_3ds_id | <code>string</code> | Universal unique transaction identifier to identify the transaction |
|
|
903
|
+
| <code>result.description</code> | <code>string</code> [Optional] | field that you must show to the customer, indicating the method the user must use to authenticate. |
|
|
904
|
+
|
|
905
|
+
### ChargeError
|
|
906
|
+
|
|
907
|
+
<a name="cb_chargeError" id="cb_chargeError"></a>
|
|
908
|
+
|
|
909
|
+
| Param | Type | Description |
|
|
910
|
+
| ------------- | ------------------- | ------------------------------------------------------------------- |
|
|
911
|
+
| error | <code>object</code> | error response |
|
|
912
|
+
| charge_3ds_id | <code>string</code> | Universal unique transaction identifier to identify the transaction |
|
|
913
|
+
|
|
882
914
|
|
|
883
915
|
## Vault Display Widget
|
|
884
916
|
You can find description of all methods and parameters [here](https://www.npmjs.com/package/@paydock/client-sdk#vault-display-widget)
|