tonder-web-sdk 1.16.7-beta.DEV-1463.1 → 1.16.7
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 +55 -0
- package/package.json +1 -1
- package/v1/bundle.min.js +1 -1
package/README.md
CHANGED
|
@@ -369,8 +369,63 @@ When calling the `payment` method, use the following data structure:
|
|
|
369
369
|
|
|
370
370
|
- **payment_method**: (for LiteCheckout) String indicating the alternative payment method to be used (e.g., "Spei"). This is only used when not paying with a card.
|
|
371
371
|
|
|
372
|
+
- **apm_config**: (Optional) Configuration object for APM-specific options. Only applicable when using alternative payment methods like Mercado Pago.
|
|
373
|
+
<details>
|
|
374
|
+
<summary>APM Config Fields</summary>
|
|
375
|
+
|
|
376
|
+
| **Field** | **Type** | **Description** |
|
|
377
|
+
|-------------------------------------|--------------------------------------------|---------------------------------------------------------------------------|
|
|
378
|
+
| `binary_mode` | `boolean` | If `true`, payment must be approved or rejected immediately (no pending). |
|
|
379
|
+
| `additional_info` | `string` | Extra info shown during checkout and in payment details. |
|
|
380
|
+
| `back_urls` | `object` | URLs to redirect the user after payment. |
|
|
381
|
+
| └─ `success` | `string` | Redirect URL after successful payment. |
|
|
382
|
+
| └─ `pending` | `string` | Redirect URL after pending payment. |
|
|
383
|
+
| └─ `failure` | `string` | Redirect URL after failed/canceled payment. |
|
|
384
|
+
| `auto_return` | `"approved"` \| `"all"` | Enables auto redirection after payment completion. |
|
|
385
|
+
| `payment_methods` | `object` | Payment method restrictions and preferences. |
|
|
386
|
+
| └─ `excluded_payment_methods[]` | `array` | List of payment methods to exclude. |
|
|
387
|
+
| └─ `excluded_payment_methods[].id` | `string` | ID of payment method to exclude (e.g., "visa"). |
|
|
388
|
+
| └─ `excluded_payment_types[]` | `array` | List of payment types to exclude. |
|
|
389
|
+
| └─ `excluded_payment_types[].id` | `string` | ID of payment type to exclude (e.g., "ticket"). |
|
|
390
|
+
| └─ `default_payment_method_id` | `string` | Default payment method (e.g., "master"). |
|
|
391
|
+
| └─ `installments` | `number` | Max number of installments allowed. |
|
|
392
|
+
| └─ `default_installments` | `number` | Default number of installments suggested. |
|
|
393
|
+
| `expires` | `boolean` | Whether the preference has expiration. |
|
|
394
|
+
| `expiration_date_from` | `string` (ISO 8601) | Start of validity period (e.g. `"2025-01-01T12:00:00-05:00"`). |
|
|
395
|
+
| `expiration_date_to` | `string` (ISO 8601) | End of validity period. |
|
|
396
|
+
| `differential_pricing` | `object` | Configuration for differential pricing. |
|
|
397
|
+
| └─ `id` | `number` | ID of the differential pricing strategy. |
|
|
398
|
+
| `marketplace` | `string` | Marketplace identifier (default: "NONE"). |
|
|
399
|
+
| `marketplace_fee` | `number` | Fee to collect as marketplace commission. |
|
|
400
|
+
| `tracks[]` | `array` | Ad tracking configurations. |
|
|
401
|
+
| └─ `type` | `"google_ad"` \| `"facebook_ad"` | Type of tracker. |
|
|
402
|
+
| └─ `values.conversion_id` | `string` | Google Ads conversion ID. |
|
|
403
|
+
| └─ `values.conversion_label` | `string` | Google Ads label. |
|
|
404
|
+
| └─ `values.pixel_id` | `string` | Facebook Pixel ID. |
|
|
405
|
+
| `statement_descriptor` | `string` | Text on payer’s card statement (max 16 characters). |
|
|
406
|
+
| `shipments` | `object` | Shipping configuration. |
|
|
407
|
+
| └─ `mode` | `"custom"` \| `"me2"` \| `"not_specified"` | Type of shipping mode. |
|
|
408
|
+
| └─ `local_pickup` | `boolean` | Enable pickup at local branch (for `me2`). |
|
|
409
|
+
| └─ `dimensions` | `string` | Package dimensions (e.g. `10x10x10,500`). |
|
|
410
|
+
| └─ `default_shipping_method` | `number` | Default shipping method (for `me2`). |
|
|
411
|
+
| └─ `free_methods[]` | `array` | Shipping methods offered for free (for `me2`). |
|
|
412
|
+
| └─ `free_methods[].id` | `number` | ID of free shipping method. |
|
|
413
|
+
| └─ `cost` | `number` | Shipping cost (only for `custom` mode). |
|
|
414
|
+
| └─ `free_shipping` | `boolean` | If `true`, shipping is free (`custom` only). |
|
|
415
|
+
| └─ `receiver_address` | `object` | Shipping address. |
|
|
416
|
+
| └─ `receiver_address.zip_code` | `string` | ZIP or postal code. |
|
|
417
|
+
| └─ `receiver_address.street_name` | `string` | Street name. |
|
|
418
|
+
| └─ `receiver_address.street_number` | `number` | Street number. |
|
|
419
|
+
| └─ `receiver_address.city_name` | `string` | City name. |
|
|
420
|
+
| └─ `receiver_address.state_name` | `string` | State name. |
|
|
421
|
+
| └─ `receiver_address.country_name` | `string` | Country name. |
|
|
422
|
+
| └─ `receiver_address.floor` | `string` | Floor (optional). |
|
|
423
|
+
| └─ `receiver_address.apartment` | `string` | Apartment or unit (optional). |
|
|
424
|
+
</details>
|
|
425
|
+
|
|
372
426
|
Note: The exact fields required may vary depending on whether you're using InlineCheckout or LiteCheckout, and the specific payment method being used.
|
|
373
427
|
|
|
428
|
+
|
|
374
429
|
```javascript
|
|
375
430
|
const paymentData = {
|
|
376
431
|
customer: {
|