@depay/widgets 6.9.0 → 6.9.1

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 (2) hide show
  1. package/README.md +7 -9
  2. package/package.json +1 -1
package/README.md CHANGED
@@ -236,21 +236,19 @@ A failed payment tracking will also call the [error callback](#error) with `{cod
236
236
 
237
237
  ##### Additional Polling
238
238
 
239
- In order to ensure a 100% payment tracking coverage, you cant entirely rely on websockets initiated with `track`.
240
-
241
- Hence, if you require better payment tracking coverage, you will also need to implement polling.
239
+ In order to ensure a 100% coverage that users are released and forwarded within your payment flow, you will need to implement polling in addition to tracking.
242
240
 
243
241
  The `track.poll` configuration either takes an `enpoint` or a `method` (similiar to track itself).
244
242
 
245
- It will use the endpoint or the method to request a payment status every 5 seconds.
243
+ It will use the endpoint or the method to request a release every 5 seconds.
246
244
 
247
- You need to make sure to respond to this request with `404` in case the payment has not been finished yet (as reported from the tracking callback)
248
- or `200` if the payment has been finished (as reported from the tracking callback).
245
+ You need to make sure to respond to this request with a status `404` in case the user is not to be released just yet (payment and processing on your side are not complete yet)
246
+ or `200` if the payment has been completed and the processing on your side is done and the user can be released and forwarded withing your payment flow.
249
247
 
250
- In case you want to redirect the user to the next step in your system, the polling needs to respond with `{ forward_to: 'https://example.com/next_step_url' }`.
248
+ In case you want to redirect the user to the next step in your system the poll endpoint needs to respond with a body containing json like: `{ forward_to: 'https://example.com/next_step_url' }`.
251
249
 
252
- It is not enough to rely on setting `forward_to` initially with the tracking request (if you also implement polling),
253
- as the entire reason polling exist is because websockets might fail to report the initially configured `forward_to` to your clients.
250
+ It is not enough to rely on setting `forward_to` initially with the tracking request, you will also need to respond with `forward_to` when implementing polling
251
+ as the entire reason for polling is to cover cases where websockets fail and the initial `forward_to` can not be communicated to the client.
254
252
 
255
253
  #### connected
256
254
 
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@depay/widgets",
3
3
  "moduleName": "DePayWidgets",
4
- "version": "6.9.0",
4
+ "version": "6.9.1",
5
5
  "description": "Web3 Payments with any token. DePay simplifies and improves Web3 Payments with the power of DeFi. Accept any token with on-the-fly conversion.",
6
6
  "main": "./dist/umd/index.js",
7
7
  "module": "./dist/esm/index.js",