@paydock/client-sdk 1.77.3 → 1.79.2-beta

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.
Files changed (3) hide show
  1. package/README.md +24 -20
  2. package/package.json +1 -1
  3. package/slate.md +24 -20
package/README.md CHANGED
@@ -2663,7 +2663,7 @@ list.load();
2663
2663
  ```javascript--es2015
2664
2664
  // ES2015 | TypeScript
2665
2665
 
2666
- import { HtmlPaymentSourceWidget } from '@paydock/client-sdk/widget';
2666
+ import { HtmlPaymentSourceWidget } from '@paydock/client-sdk/payment-source-widget';
2667
2667
 
2668
2668
  var list = new HtmlPaymentSourceWidget('#list', 'publicKey', 'queryToken');
2669
2669
  list.load();
@@ -2684,7 +2684,7 @@ Then write only need 2 lines of code in js to initialize widget
2684
2684
  </head>
2685
2685
  <body>
2686
2686
  <div id="list"></div>
2687
- <script src="https://app-sandbox.paydock.com/v1/widget.umd.js" ></script>
2687
+ <script src="https://widget.paydock.com/sdk/latest/widget.umd.js" ></script>
2688
2688
  <script>
2689
2689
  var list = new paydock.HtmlPaymentSourceWidget('#list', 'publicKey', 'queryToken');
2690
2690
  list.load();
@@ -2739,7 +2739,7 @@ This example shows how you can use a lot of other methods to settings your form
2739
2739
  <body>
2740
2740
  <div id="list"></div>
2741
2741
  <input type="text" name="ps_id" />
2742
- <script src="https://app-sandbox.paydock.com/v1/widget.umd.js" ></script>
2742
+ <script src="https://widget.paydock.com/sdk/latest/widget.umd.js" ></script>
2743
2743
  <script>
2744
2744
  var list = new paydock.HtmlPaymentSourceWidget('#list', 'publicKey', 'queryToken');
2745
2745
  list.filterByTypes(['card', 'checkout']);
@@ -4586,7 +4586,7 @@ This example shows how you can use a lot of other methods to settings your form
4586
4586
 
4587
4587
  ## Canvas 3ds for Standalone 3ds charges
4588
4588
 
4589
- After you initialized the 3ds charge via `v1/charges/standalone-3ds` API endpoint, you get a token used to initialized the Canvas3ds. All above information regarding setup, loading and initialization still apply.
4589
+ After you initialized the standalone 3ds charge via `v1/charges/standalone-3ds` API endpoint, you get a token used to initialize the Canvas3ds. All above information regarding setup, loading and initialization still apply.
4590
4590
 
4591
4591
  ### Full example
4592
4592
 
@@ -4630,20 +4630,25 @@ After you initialized the 3ds charge via `v1/charges/standalone-3ds` API endpoin
4630
4630
  </html>
4631
4631
  ```
4632
4632
 
4633
- 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.
4634
- 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)
4635
- 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
4636
- 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
4633
+ - 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.
4634
+ - The `chargeAuthReject` event is executed when the authorization was rejected or when a timeout was received by the underlying system:
4635
+ - A `data.status` of `AuthTimedOut` will be received for timeouts.
4636
+ - A `data.status` of `rejected` will be received when the authorization was rejected.
4637
+ - A `data.status` of `invalid_event` will be received for unhandled situations.
4638
+ - 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). Once the end customer performs the challenge, the Canvas3ds will be able to identify the challenge result and will either produce a `chargeAuthSuccess` or `chargeAuthReject` event.
4639
+ - 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.
4640
+ - 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:
4641
+ - When getting this event, you will get on `data.error` the full error object.
4637
4642
 
4638
- ### Event and Values
4643
+ ### Events and Values
4639
4644
 
4640
4645
  | Event Value | Type | Description |
4641
4646
  | ------------------- | ------------------- | -------------------------------------------------------------- |
4642
- | chargeAuthSuccess | <code>object</code> | Instance of [ChargeEventResponse](#cb_chargeEventResponse) |
4643
- | chargeAuthReject | <code>object</code> | Instance of [ChargeEventResponse](#cb_chargeEventResponse) |
4644
- | chargeAuthChallenge | <code>object</code> | Instance of [ChargeEventResponse](#cb_chargeEventResponse) |
4645
- | chargeAuthDecoupled | <code>object</code> | Instance of [ChargeEventResponse](#cb_chargeEventResponse) |
4646
- | error | <code>object</code> | Instance of [chargeError](#cb_chargeError) |
4647
+ | <code>chargeAuthSuccess</code> | <code>object</code> | Instance of [ChargeEventResponse](#cb_chargeEventResponse) |
4648
+ | <code>chargeAuthReject</code> | <code>object</code> | Instance of [ChargeEventResponse](#cb_chargeEventResponse) |
4649
+ | <code>chargeAuthChallenge</code> | <code>object</code> | Instance of [ChargeEventResponse](#cb_chargeEventResponse) |
4650
+ | <code>chargeAuthDecoupled</code> | <code>object</code> | Instance of [ChargeEventResponse](#cb_chargeEventResponse) |
4651
+ | <code>error</code> | <code>object</code> | Instance of [chargeError](#cb_chargeError) |
4647
4652
 
4648
4653
  ## Response Values
4649
4654
 
@@ -4653,9 +4658,9 @@ The error event is sent if an unexpected issue with the client library occurs. I
4653
4658
 
4654
4659
  | Param | Type | Description |
4655
4660
  | ------------------------------- | ------------------------------ | -------------------------------------------------------------------------------------------------- |
4656
- | status | <code>string</code> | status for the event transaction |
4657
- | charge_3ds_id | <code>string</code> | Universal unique transaction identifier to identify the transaction |
4658
- | <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. |
4661
+ | <code>status</code> | <code>string</code> | status for the event transaction |
4662
+ | <code>charge_3ds_id</code> | <code>string</code> | Universal unique transaction identifier to identify the transaction |
4663
+ | <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 during the decoupled challenge flow. |
4659
4664
 
4660
4665
  ### ChargeError
4661
4666
 
@@ -4663,9 +4668,8 @@ The error event is sent if an unexpected issue with the client library occurs. I
4663
4668
 
4664
4669
  | Param | Type | Description |
4665
4670
  | ------------- | ------------------- | ------------------------------------------------------------------- |
4666
- | error | <code>object</code> | error response |
4667
- | charge_3ds_id | <code>string</code> | Universal unique transaction identifier to identify the transaction |
4668
-
4671
+ | <code>error</code> | <code>object</code> | error response |
4672
+ | <code>charge_3ds_id</code> | <code>string</code> | Universal unique transaction identifier to identify the transaction |
4669
4673
 
4670
4674
  ## Vault Display Widget
4671
4675
  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
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@paydock/client-sdk",
3
3
  "description": "Paydock client sdk",
4
- "version": "1.77.3",
4
+ "version": "1.79.2-beta",
5
5
  "homepage": "https://paydock.com",
6
6
  "author": {},
7
7
  "bugs": {
package/slate.md CHANGED
@@ -265,7 +265,7 @@ list.load();
265
265
  ```javascript--es2015
266
266
  // ES2015 | TypeScript
267
267
 
268
- import { HtmlPaymentSourceWidget } from '@paydock/client-sdk/widget';
268
+ import { HtmlPaymentSourceWidget } from '@paydock/client-sdk/payment-source-widget';
269
269
 
270
270
  var list = new HtmlPaymentSourceWidget('#list', 'publicKey', 'queryToken');
271
271
  list.load();
@@ -286,7 +286,7 @@ Then write only need 2 lines of code in js to initialize widget
286
286
  </head>
287
287
  <body>
288
288
  <div id="list"></div>
289
- <script src="https://app-sandbox.paydock.com/v1/widget.umd.js" ></script>
289
+ <script src="https://widget.paydock.com/sdk/latest/widget.umd.js" ></script>
290
290
  <script>
291
291
  var list = new paydock.HtmlPaymentSourceWidget('#list', 'publicKey', 'queryToken');
292
292
  list.load();
@@ -341,7 +341,7 @@ This example shows how you can use a lot of other methods to settings your form
341
341
  <body>
342
342
  <div id="list"></div>
343
343
  <input type="text" name="ps_id" />
344
- <script src="https://app-sandbox.paydock.com/v1/widget.umd.js" ></script>
344
+ <script src="https://widget.paydock.com/sdk/latest/widget.umd.js" ></script>
345
345
  <script>
346
346
  var list = new paydock.HtmlPaymentSourceWidget('#list', 'publicKey', 'queryToken');
347
347
  list.filterByTypes(['card', 'checkout']);
@@ -833,7 +833,7 @@ This example shows how you can use a lot of other methods to settings your form
833
833
 
834
834
  ## Canvas 3ds for Standalone 3ds charges
835
835
 
836
- After you initialized the 3ds charge via `v1/charges/standalone-3ds` API endpoint, you get a token used to initialized the Canvas3ds. All above information regarding setup, loading and initialization still apply.
836
+ After you initialized the standalone 3ds charge via `v1/charges/standalone-3ds` API endpoint, you get a token used to initialize the Canvas3ds. All above information regarding setup, loading and initialization still apply.
837
837
 
838
838
  ### Full example
839
839
 
@@ -877,20 +877,25 @@ After you initialized the 3ds charge via `v1/charges/standalone-3ds` API endpoin
877
877
  </html>
878
878
  ```
879
879
 
880
- 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.
881
- 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)
882
- 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
883
- 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
880
+ - 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.
881
+ - The `chargeAuthReject` event is executed when the authorization was rejected or when a timeout was received by the underlying system:
882
+ - A `data.status` of `AuthTimedOut` will be received for timeouts.
883
+ - A `data.status` of `rejected` will be received when the authorization was rejected.
884
+ - A `data.status` of `invalid_event` will be received for unhandled situations.
885
+ - 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). Once the end customer performs the challenge, the Canvas3ds will be able to identify the challenge result and will either produce a `chargeAuthSuccess` or `chargeAuthReject` event.
886
+ - 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.
887
+ - 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:
888
+ - When getting this event, you will get on `data.error` the full error object.
884
889
 
885
- ### Event and Values
890
+ ### Events and Values
886
891
 
887
892
  | Event Value | Type | Description |
888
893
  | ------------------- | ------------------- | -------------------------------------------------------------- |
889
- | chargeAuthSuccess | <code>object</code> | Instance of [ChargeEventResponse](#cb_chargeEventResponse) |
890
- | chargeAuthReject | <code>object</code> | Instance of [ChargeEventResponse](#cb_chargeEventResponse) |
891
- | chargeAuthChallenge | <code>object</code> | Instance of [ChargeEventResponse](#cb_chargeEventResponse) |
892
- | chargeAuthDecoupled | <code>object</code> | Instance of [ChargeEventResponse](#cb_chargeEventResponse) |
893
- | error | <code>object</code> | Instance of [chargeError](#cb_chargeError) |
894
+ | <code>chargeAuthSuccess</code> | <code>object</code> | Instance of [ChargeEventResponse](#cb_chargeEventResponse) |
895
+ | <code>chargeAuthReject</code> | <code>object</code> | Instance of [ChargeEventResponse](#cb_chargeEventResponse) |
896
+ | <code>chargeAuthChallenge</code> | <code>object</code> | Instance of [ChargeEventResponse](#cb_chargeEventResponse) |
897
+ | <code>chargeAuthDecoupled</code> | <code>object</code> | Instance of [ChargeEventResponse](#cb_chargeEventResponse) |
898
+ | <code>error</code> | <code>object</code> | Instance of [chargeError](#cb_chargeError) |
894
899
 
895
900
  ## Response Values
896
901
 
@@ -900,9 +905,9 @@ The error event is sent if an unexpected issue with the client library occurs. I
900
905
 
901
906
  | Param | Type | Description |
902
907
  | ------------------------------- | ------------------------------ | -------------------------------------------------------------------------------------------------- |
903
- | status | <code>string</code> | status for the event transaction |
904
- | charge_3ds_id | <code>string</code> | Universal unique transaction identifier to identify the transaction |
905
- | <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. |
908
+ | <code>status</code> | <code>string</code> | status for the event transaction |
909
+ | <code>charge_3ds_id</code> | <code>string</code> | Universal unique transaction identifier to identify the transaction |
910
+ | <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 during the decoupled challenge flow. |
906
911
 
907
912
  ### ChargeError
908
913
 
@@ -910,9 +915,8 @@ The error event is sent if an unexpected issue with the client library occurs. I
910
915
 
911
916
  | Param | Type | Description |
912
917
  | ------------- | ------------------- | ------------------------------------------------------------------- |
913
- | error | <code>object</code> | error response |
914
- | charge_3ds_id | <code>string</code> | Universal unique transaction identifier to identify the transaction |
915
-
918
+ | <code>error</code> | <code>object</code> | error response |
919
+ | <code>charge_3ds_id</code> | <code>string</code> | Universal unique transaction identifier to identify the transaction |
916
920
 
917
921
  ## Vault Display Widget
918
922
  You can find description of all methods and parameters [here](https://www.npmjs.com/package/@paydock/client-sdk#vault-display-widget)