@paydock/client-sdk 1.127.1-beta → 1.131.0-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.
- package/README.md +1466 -3901
- package/bundles/index.cjs +2845 -539
- package/bundles/index.cjs.d.ts +408 -196
- package/bundles/index.mjs +2844 -539
- package/bundles/index.mjs.d.ts +408 -196
- package/bundles/types/api/api-internal.d.ts +3 -1
- package/bundles/types/api/api-internal.d.ts.map +1 -1
- package/bundles/types/api/api-payment-source-internal.d.ts +8 -0
- package/bundles/types/api/api-payment-source-internal.d.ts.map +1 -0
- package/bundles/types/checkout/checkout.d.ts +8 -14
- package/bundles/types/checkout/checkout.d.ts.map +1 -1
- package/bundles/types/checkout/helpers/instruction-debugger.d.ts +4 -0
- package/bundles/types/checkout/helpers/instruction-debugger.d.ts.map +1 -0
- package/bundles/types/checkout/helpers/instruction-handler.d.ts +4 -4
- package/bundles/types/checkout/helpers/instruction-handler.d.ts.map +1 -1
- package/bundles/types/checkout/images/card-icons.d.ts +10 -0
- package/bundles/types/checkout/images/card-icons.d.ts.map +1 -0
- package/bundles/types/checkout/index.d.ts +2 -1
- package/bundles/types/checkout/index.d.ts.map +1 -1
- package/bundles/types/checkout/models/checkout.models.d.ts +14 -0
- package/bundles/types/checkout/models/checkout.models.d.ts.map +1 -0
- package/bundles/types/checkout/utils/checkout-styles.util.d.ts +2 -0
- package/bundles/types/checkout/utils/checkout-styles.util.d.ts.map +1 -0
- package/bundles/types/checkout/utils/checkout-version-handler.util.d.ts +3 -0
- package/bundles/types/checkout/utils/checkout-version-handler.util.d.ts.map +1 -0
- package/bundles/types/checkout/v1/helpers/widget-structure-handler.d.ts +10 -0
- package/bundles/types/checkout/v1/helpers/widget-structure-handler.d.ts.map +1 -0
- package/bundles/types/checkout/{instructions/v1 → v1/instructions}/index.d.ts.map +1 -1
- package/bundles/types/checkout/{instructions/v1 → v1/instructions}/instruction.afterpay_checkout_form.show.d.ts +2 -2
- package/bundles/types/checkout/v1/instructions/instruction.afterpay_checkout_form.show.d.ts.map +1 -0
- package/bundles/types/checkout/{instructions/v1 → v1/instructions}/instruction.afterpay_wallet_form.show.d.ts +3 -2
- package/bundles/types/checkout/v1/instructions/instruction.afterpay_wallet_form.show.d.ts.map +1 -0
- package/bundles/types/checkout/{instructions/v1 → v1/instructions}/instruction.apple_pay_form.show.d.ts +3 -2
- package/bundles/types/checkout/v1/instructions/instruction.apple_pay_form.show.d.ts.map +1 -0
- package/bundles/types/checkout/{instructions/v1 → v1/instructions}/instruction.bank_account_form.show.d.ts +2 -2
- package/bundles/types/checkout/v1/instructions/instruction.bank_account_form.show.d.ts.map +1 -0
- package/bundles/types/checkout/{instructions/v1 → v1/instructions}/instruction.canvas_3ds.show.d.ts.map +1 -1
- package/bundles/types/checkout/{instructions/v1 → v1/instructions}/instruction.card_form.show.d.ts +1 -1
- package/bundles/types/checkout/v1/instructions/instruction.card_form.show.d.ts.map +1 -0
- package/bundles/types/checkout/{instructions/v1 → v1/instructions}/instruction.disable_payment_method_event.emit.d.ts +2 -2
- package/bundles/types/checkout/v1/instructions/instruction.disable_payment_method_event.emit.d.ts.map +1 -0
- package/bundles/types/checkout/{instructions/v1 → v1/instructions}/instruction.fraud_service.show.d.ts.map +1 -1
- package/bundles/types/checkout/{instructions/v1 → v1/instructions}/instruction.generic.show_message.d.ts +1 -1
- package/bundles/types/checkout/v1/instructions/instruction.generic.show_message.d.ts.map +1 -0
- package/bundles/types/checkout/{instructions/v1 → v1/instructions}/instruction.google_pay_form.show.d.ts +3 -2
- package/bundles/types/checkout/v1/instructions/instruction.google_pay_form.show.d.ts.map +1 -0
- package/bundles/types/checkout/{instructions/v1 → v1/instructions}/instruction.merchant_event.emit.d.ts +2 -2
- package/bundles/types/checkout/v1/instructions/instruction.merchant_event.emit.d.ts.map +1 -0
- package/bundles/types/checkout/{instructions/v1 → v1/instructions}/instruction.payment_methods.show.d.ts.map +1 -1
- package/bundles/types/checkout/{instructions/v1 → v1/instructions}/instruction.paypal_form.show.d.ts +2 -2
- package/bundles/types/checkout/v1/instructions/instruction.paypal_form.show.d.ts.map +1 -0
- package/bundles/types/checkout/{instructions/v1 → v1/instructions}/instruction.zip_checkout_form.show.d.ts +3 -2
- package/bundles/types/checkout/v1/instructions/instruction.zip_checkout_form.show.d.ts.map +1 -0
- package/bundles/types/checkout/v1/layout-widgets/additionals.d.ts +3 -0
- package/bundles/types/checkout/v1/layout-widgets/additionals.d.ts.map +1 -0
- package/bundles/types/checkout/v1/layout-widgets/default-variables.enum.d.ts.map +1 -0
- package/bundles/types/checkout/{layout-widgets → v1/layout-widgets}/message.d.ts +6 -6
- package/bundles/types/checkout/v1/layout-widgets/message.d.ts.map +1 -0
- package/bundles/types/checkout/v1/layout-widgets/payment-methods-template.d.ts.map +1 -0
- package/bundles/types/checkout/{layout-widgets → v1/layout-widgets}/payment-methods.d.ts +5 -5
- package/bundles/types/checkout/v1/layout-widgets/payment-methods.d.ts.map +1 -0
- package/bundles/types/checkout/v1/layout-widgets/payment-template.d.ts.map +1 -0
- package/bundles/types/checkout/v1/models/checkout.models.d.ts +5 -0
- package/bundles/types/checkout/v1/models/checkout.models.d.ts.map +1 -0
- package/bundles/types/checkout/v3/components/go-back-to-payments-button/go-back-to-payments.d.ts +4 -0
- package/bundles/types/checkout/v3/components/go-back-to-payments-button/go-back-to-payments.d.ts.map +1 -0
- package/bundles/types/checkout/v3/components/list-items-wrapper/list-items-wrapper.d.ts +8 -0
- package/bundles/types/checkout/v3/components/list-items-wrapper/list-items-wrapper.d.ts.map +1 -0
- package/bundles/types/checkout/v3/components/payment-methods-list/payment-methods-list.d.ts +3 -0
- package/bundles/types/checkout/v3/components/payment-methods-list/payment-methods-list.d.ts.map +1 -0
- package/bundles/types/checkout/v3/components/payments-wrapper/payments-wrapper.d.ts +9 -0
- package/bundles/types/checkout/v3/components/payments-wrapper/payments-wrapper.d.ts.map +1 -0
- package/bundles/types/checkout/v3/helpers/widget-structure-handler.d.ts +10 -0
- package/bundles/types/checkout/v3/helpers/widget-structure-handler.d.ts.map +1 -0
- package/bundles/types/checkout/v3/instructions/index.d.ts +4 -0
- package/bundles/types/checkout/v3/instructions/index.d.ts.map +1 -0
- package/bundles/types/checkout/v3/instructions/instruction.afterpay_checkout_form.show.d.ts +20 -0
- package/bundles/types/checkout/v3/instructions/instruction.afterpay_checkout_form.show.d.ts.map +1 -0
- package/bundles/types/checkout/v3/instructions/instruction.afterpay_wallet_form.show.d.ts +17 -0
- package/bundles/types/checkout/v3/instructions/instruction.afterpay_wallet_form.show.d.ts.map +1 -0
- package/bundles/types/checkout/v3/instructions/instruction.apple_pay_form.show.d.ts +17 -0
- package/bundles/types/checkout/v3/instructions/instruction.apple_pay_form.show.d.ts.map +1 -0
- package/bundles/types/checkout/v3/instructions/instruction.bank_account_form.show.d.ts +14 -0
- package/bundles/types/checkout/v3/instructions/instruction.bank_account_form.show.d.ts.map +1 -0
- package/bundles/types/checkout/v3/instructions/instruction.canvas_3ds.show.d.ts +12 -0
- package/bundles/types/checkout/v3/instructions/instruction.canvas_3ds.show.d.ts.map +1 -0
- package/bundles/types/checkout/v3/instructions/instruction.card_form.show.d.ts +24 -0
- package/bundles/types/checkout/v3/instructions/instruction.card_form.show.d.ts.map +1 -0
- package/bundles/types/checkout/v3/instructions/instruction.disable_payment_method_event.emit.d.ts +21 -0
- package/bundles/types/checkout/v3/instructions/instruction.disable_payment_method_event.emit.d.ts.map +1 -0
- package/bundles/types/checkout/v3/instructions/instruction.fraud_service.show.d.ts +21 -0
- package/bundles/types/checkout/v3/instructions/instruction.fraud_service.show.d.ts.map +1 -0
- package/bundles/types/checkout/v3/instructions/instruction.generic.show_message.d.ts +27 -0
- package/bundles/types/checkout/v3/instructions/instruction.generic.show_message.d.ts.map +1 -0
- package/bundles/types/checkout/v3/instructions/instruction.google_pay_form.show.d.ts +17 -0
- package/bundles/types/checkout/v3/instructions/instruction.google_pay_form.show.d.ts.map +1 -0
- package/bundles/types/checkout/v3/instructions/instruction.merchant_event.emit.d.ts +18 -0
- package/bundles/types/checkout/v3/instructions/instruction.merchant_event.emit.d.ts.map +1 -0
- package/bundles/types/checkout/v3/instructions/instruction.payment_methods.show.d.ts +23 -0
- package/bundles/types/checkout/v3/instructions/instruction.payment_methods.show.d.ts.map +1 -0
- package/bundles/types/checkout/v3/instructions/instruction.paypal_form.show.d.ts +19 -0
- package/bundles/types/checkout/v3/instructions/instruction.paypal_form.show.d.ts.map +1 -0
- package/bundles/types/checkout/v3/instructions/instruction.saved_card_form.show.d.ts +22 -0
- package/bundles/types/checkout/v3/instructions/instruction.saved_card_form.show.d.ts.map +1 -0
- package/bundles/types/checkout/v3/instructions/instruction.zip_checkout_form.show.d.ts +19 -0
- package/bundles/types/checkout/v3/instructions/instruction.zip_checkout_form.show.d.ts.map +1 -0
- package/bundles/types/checkout/v3/models/card.model.d.ts +20 -0
- package/bundles/types/checkout/v3/models/card.model.d.ts.map +1 -0
- package/bundles/types/checkout/v3/models/checkout-styles.model.d.ts +9 -0
- package/bundles/types/checkout/v3/models/checkout-styles.model.d.ts.map +1 -0
- package/bundles/types/checkout/v3/models/checkout.models.d.ts +4 -0
- package/bundles/types/checkout/v3/models/checkout.models.d.ts.map +1 -0
- package/bundles/types/checkout/v3/models/payment-methods.model.d.ts +13 -0
- package/bundles/types/checkout/v3/models/payment-methods.model.d.ts.map +1 -0
- package/bundles/types/checkout/v3/styles/additionals.d.ts +3 -0
- package/bundles/types/checkout/v3/styles/additionals.d.ts.map +1 -0
- package/bundles/types/checkout/v3/utils/checkout-customisation-styles.util.d.ts +3 -0
- package/bundles/types/checkout/v3/utils/checkout-customisation-styles.util.d.ts.map +1 -0
- package/bundles/types/components/param.d.ts +7 -0
- package/bundles/types/components/param.d.ts.map +1 -1
- package/bundles/types/configs/env/environment.uba.d.ts +28 -0
- package/bundles/types/configs/env/environment.uba.d.ts.map +1 -0
- package/bundles/types/constants/validators.d.ts +2 -2
- package/bundles/types/constants/validators.d.ts.map +1 -1
- package/bundles/types/fraud-prevention/providers/forter/templates/{forter-snippet-2025-02-06t14:19:34z.template.d.ts → forter-snippet-20250206141934.template.d.ts} +1 -1
- package/bundles/types/fraud-prevention/providers/forter/templates/forter-snippet-20250206141934.template.d.ts.map +1 -0
- package/bundles/types/helper/card-scheme.d.ts +76 -0
- package/bundles/types/helper/card-scheme.d.ts.map +1 -0
- package/bundles/types/index-cba.d.ts +11 -11
- package/bundles/types/index-cba.d.ts.map +1 -1
- package/bundles/types/index.d.ts +12 -11
- package/bundles/types/index.d.ts.map +1 -1
- package/bundles/types/open-wallets/base/base-open-wallet.d.ts +33 -0
- package/bundles/types/open-wallets/base/base-open-wallet.d.ts.map +1 -0
- package/bundles/types/open-wallets/enum/event.enum.d.ts +8 -0
- package/bundles/types/open-wallets/enum/event.enum.d.ts.map +1 -0
- package/bundles/types/open-wallets/index.d.ts +6 -0
- package/bundles/types/open-wallets/index.d.ts.map +1 -0
- package/bundles/types/open-wallets/interfaces/base-service-config.interface.d.ts +30 -0
- package/bundles/types/open-wallets/interfaces/base-service-config.interface.d.ts.map +1 -0
- package/bundles/types/open-wallets/interfaces/base-wallet-meta.interface.d.ts +5 -0
- package/bundles/types/open-wallets/interfaces/base-wallet-meta.interface.d.ts.map +1 -0
- package/bundles/types/open-wallets/interfaces/events.interface.d.ts +34 -0
- package/bundles/types/open-wallets/interfaces/events.interface.d.ts.map +1 -0
- package/bundles/types/open-wallets/interfaces/index.d.ts +8 -0
- package/bundles/types/open-wallets/interfaces/index.d.ts.map +1 -0
- package/bundles/types/open-wallets/interfaces/payment-source.interface.d.ts +5 -0
- package/bundles/types/open-wallets/interfaces/payment-source.interface.d.ts.map +1 -0
- package/bundles/types/open-wallets/services/index.d.ts +9 -0
- package/bundles/types/open-wallets/services/index.d.ts.map +1 -0
- package/bundles/types/open-wallets/types/index.d.ts +5 -0
- package/bundles/types/open-wallets/types/index.d.ts.map +1 -0
- package/bundles/types/open-wallets/types/ott-backend.type.d.ts +26 -0
- package/bundles/types/open-wallets/types/ott-backend.type.d.ts.map +1 -0
- package/bundles/types/open-wallets/types/ott-response.type.d.ts +8 -0
- package/bundles/types/open-wallets/types/ott-response.type.d.ts.map +1 -0
- package/bundles/types/open-wallets/types/wallet-type.type.d.ts +6 -0
- package/bundles/types/open-wallets/types/wallet-type.type.d.ts.map +1 -0
- package/bundles/types/secure-remote-commerce/click-to-pay-secure-remote-commerce.d.ts +2 -1
- package/bundles/types/secure-remote-commerce/click-to-pay-secure-remote-commerce.d.ts.map +1 -1
- package/bundles/types/secure-remote-commerce/providers/mastercard-src/mastercard-src.d.ts +6 -4
- package/bundles/types/secure-remote-commerce/providers/mastercard-src/mastercard-src.d.ts.map +1 -1
- package/bundles/types/shared/services/configuration-validation/configuration-validation.d.ts.map +1 -1
- package/bundles/types/shared-ui/components/button.d.ts +23 -0
- package/bundles/types/shared-ui/components/button.d.ts.map +1 -0
- package/bundles/types/shared-ui/components/item-info-blocks.d.ts +20 -0
- package/bundles/types/shared-ui/components/item-info-blocks.d.ts.map +1 -0
- package/bundles/types/shared-ui/components/list-item.d.ts +13 -0
- package/bundles/types/shared-ui/components/list-item.d.ts.map +1 -0
- package/bundles/types/shared-ui/components/loading-spinner.d.ts +12 -0
- package/bundles/types/shared-ui/components/loading-spinner.d.ts.map +1 -0
- package/bundles/types/shared-ui/components/message-card.d.ts +19 -0
- package/bundles/types/shared-ui/components/message-card.d.ts.map +1 -0
- package/bundles/types/shared-ui/components/svg-container.d.ts +2 -0
- package/bundles/types/shared-ui/components/svg-container.d.ts.map +1 -0
- package/bundles/types/shared-ui/components/widget-wrapper.d.ts +2 -0
- package/bundles/types/shared-ui/components/widget-wrapper.d.ts.map +1 -0
- package/bundles/types/shared-ui/models/widget-root.model.d.ts +12 -0
- package/bundles/types/shared-ui/models/widget-root.model.d.ts.map +1 -0
- package/bundles/types/shared-ui/styles/widget-root-styles.d.ts +3 -0
- package/bundles/types/shared-ui/styles/widget-root-styles.d.ts.map +1 -0
- package/bundles/types/shared-ui/utils/loading-spinner.util.d.ts +8 -0
- package/bundles/types/shared-ui/utils/loading-spinner.util.d.ts.map +1 -0
- package/bundles/types/wallet-buttons/enums.d.ts +2 -1
- package/bundles/types/wallet-buttons/enums.d.ts.map +1 -1
- package/bundles/types/wallet-buttons/index.d.ts +6 -6
- package/bundles/types/wallet-buttons/wallet-buttons.d.ts +14 -8
- package/bundles/types/wallet-buttons/wallet-buttons.d.ts.map +1 -1
- package/bundles/types/wallet-buttons/wallet-services/afterpay.wallet-service.d.ts +2 -2
- package/bundles/types/wallet-buttons/wallet-services/afterpay.wallet-service.d.ts.map +1 -1
- package/bundles/types/wallet-buttons/wallet-services/apple.wallet-service.d.ts +3 -3
- package/bundles/types/wallet-buttons/wallet-services/apple.wallet-service.d.ts.map +1 -1
- package/bundles/types/wallet-buttons/wallet-services/flypay-v2.wallet-service.d.ts +2 -2
- package/bundles/types/wallet-buttons/wallet-services/flypay-v2.wallet-service.d.ts.map +1 -1
- package/bundles/types/wallet-buttons/wallet-services/flypay.wallet-service.d.ts +7 -7
- package/bundles/types/wallet-buttons/wallet-services/flypay.wallet-service.d.ts.map +1 -1
- package/bundles/types/wallet-buttons/wallet-services/google.wallet-service.d.ts.map +1 -1
- package/bundles/types/wallet-buttons/wallet-services/paypal.wallet-service.d.ts +2 -2
- package/bundles/types/wallet-buttons/wallet-services/paypal.wallet-service.d.ts.map +1 -1
- package/bundles/types/wallet-buttons/wallet-services/stripe.wallet-service.d.ts +3 -3
- package/bundles/types/wallet-buttons/wallet-services/stripe.wallet-service.d.ts.map +1 -1
- package/bundles/types/wallet-buttons/wallet-services/wallet-service.d.ts +6 -6
- package/bundles/types/wallet-buttons/wallet-services/wallet-service.d.ts.map +1 -1
- package/bundles/types/wallet-buttons-express/enum/event.enum.d.ts.map +1 -1
- package/bundles/types/wallet-buttons-express/index.d.ts +3 -3
- package/bundles/types/wallet-buttons-express/index.d.ts.map +1 -1
- package/bundles/types/wallet-buttons-express/interfaces/charge-wallet-token-meta.interface.d.ts +1 -0
- package/bundles/types/wallet-buttons-express/interfaces/charge-wallet-token-meta.interface.d.ts.map +1 -1
- package/bundles/types/wallet-buttons-express/interfaces/on-click-event-data.interface.d.ts +2 -2
- package/bundles/types/wallet-buttons-express/interfaces/on-click-event-data.interface.d.ts.map +1 -1
- package/bundles/types/wallet-buttons-express/interfaces/on-close-event-data.interface.d.ts +2 -2
- package/bundles/types/wallet-buttons-express/interfaces/on-close-event-data.interface.d.ts.map +1 -1
- package/bundles/types/wallet-buttons-express/interfaces/on-error-event-data.interface.d.ts +2 -2
- package/bundles/types/wallet-buttons-express/interfaces/on-error-event-data.interface.d.ts.map +1 -1
- package/bundles/types/wallet-buttons-express/interfaces/on-payment-error-event-data.interface.d.ts +2 -2
- package/bundles/types/wallet-buttons-express/interfaces/on-payment-error-event-data.interface.d.ts.map +1 -1
- package/bundles/types/wallet-buttons-express/interfaces/on-payment-in-review-event-data.interface.d.ts +2 -2
- package/bundles/types/wallet-buttons-express/interfaces/on-payment-in-review-event-data.interface.d.ts.map +1 -1
- package/bundles/types/wallet-buttons-express/interfaces/on-payment-successful-event-data.interface.d.ts +2 -2
- package/bundles/types/wallet-buttons-express/interfaces/on-payment-successful-event-data.interface.d.ts.map +1 -1
- package/bundles/types/wallet-buttons-express/interfaces/on-shipping-address-change-event-data.interface.d.ts.map +1 -1
- package/bundles/types/wallet-buttons-express/interfaces/on-shipping-address-change-event-response.interface.d.ts.map +1 -1
- package/bundles/types/wallet-buttons-express/interfaces/on-shipping-option-change-event-data.interface.d.ts.map +1 -1
- package/bundles/types/wallet-buttons-express/interfaces/on-unavailable-event-data.interface.d.ts +2 -2
- package/bundles/types/wallet-buttons-express/interfaces/on-unavailable-event-data.interface.d.ts.map +1 -1
- package/bundles/types/wallet-buttons-express/interfaces/wallet-capture-request.interface.d.ts +20 -0
- package/bundles/types/wallet-buttons-express/interfaces/wallet-capture-request.interface.d.ts.map +1 -1
- package/bundles/types/wallet-buttons-express/services/apple-pay/apple-pay.wallet-button-express.d.ts.map +1 -1
- package/bundles/types/wallet-buttons-express/services/apple-pay/interfaces/apple-pay-wallet-meta.interface.d.ts +5 -5
- package/bundles/types/wallet-buttons-express/services/apple-pay/interfaces/apple-pay-wallet-meta.interface.d.ts.map +1 -1
- package/bundles/types/wallet-buttons-express/services/apple-pay/types/apple-pay-shipping-data.d.ts +3 -0
- package/bundles/types/wallet-buttons-express/services/apple-pay/types/apple-pay-shipping-data.d.ts.map +1 -1
- package/bundles/types/wallet-buttons-express/services/apple-pay/types/apple-pay-shipping-method.type.d.ts.map +1 -1
- package/bundles/types/wallet-buttons-express/services/paypal/interfaces/paypal-wallet-meta.interface.d.ts +1 -1
- package/bundles/types/wallet-buttons-express/services/paypal/interfaces/paypal-wallet-meta.interface.d.ts.map +1 -1
- package/bundles/types/wallet-buttons-express/types/shipping-event-to-response.type.d.ts +4 -4
- package/bundles/types/wallet-buttons-express/types/shipping-event-to-response.type.d.ts.map +1 -1
- package/bundles/types/widget/configuration.d.ts +2 -0
- package/bundles/types/widget/configuration.d.ts.map +1 -1
- package/bundles/types/widget/html-multi-widget.d.ts +7 -5
- package/bundles/types/widget/html-multi-widget.d.ts.map +1 -1
- package/bundles/types/widget/html-widget.d.ts +1 -0
- package/bundles/types/widget/html-widget.d.ts.map +1 -1
- package/bundles/types/widget/multi-widget.d.ts +16 -0
- package/bundles/types/widget/multi-widget.d.ts.map +1 -1
- package/bundles/widget.umd.js +2845 -539
- package/bundles/widget.umd.js.d.ts +408 -196
- package/bundles/widget.umd.js.min.d.ts +408 -196
- package/bundles/widget.umd.min.js +1 -1
- package/docs/api-checkout-button.md +0 -370
- package/docs/api-widget.md +0 -2110
- package/docs/checkout-examples.md +2 -127
- package/docs/license.md +1 -1
- package/docs/wallet-buttons-examples.md +3 -134
- package/docs/wallet-buttons-express-examples.md +528 -0
- package/docs/wallet-buttons.md +11 -10
- package/docs/wallet-cba-buttons-examples.md +1 -1
- package/package.json +3 -2
- package/slate.md +5 -524
- package/bundles/types/checkout/instructions/index.d.ts +0 -3
- package/bundles/types/checkout/instructions/index.d.ts.map +0 -1
- package/bundles/types/checkout/instructions/v1/instruction.afterpay_checkout_form.show.d.ts.map +0 -1
- package/bundles/types/checkout/instructions/v1/instruction.afterpay_wallet_form.show.d.ts.map +0 -1
- package/bundles/types/checkout/instructions/v1/instruction.apple_pay_form.show.d.ts.map +0 -1
- package/bundles/types/checkout/instructions/v1/instruction.bank_account_form.show.d.ts.map +0 -1
- package/bundles/types/checkout/instructions/v1/instruction.card_form.show.d.ts.map +0 -1
- package/bundles/types/checkout/instructions/v1/instruction.disable_payment_method_event.emit.d.ts.map +0 -1
- package/bundles/types/checkout/instructions/v1/instruction.generic.show_message.d.ts.map +0 -1
- package/bundles/types/checkout/instructions/v1/instruction.google_pay_form.show.d.ts.map +0 -1
- package/bundles/types/checkout/instructions/v1/instruction.merchant_event.emit.d.ts.map +0 -1
- package/bundles/types/checkout/instructions/v1/instruction.paypal_form.show.d.ts.map +0 -1
- package/bundles/types/checkout/instructions/v1/instruction.zip_checkout_form.show.d.ts.map +0 -1
- package/bundles/types/checkout/layout-widgets/additionals.d.ts +0 -3
- package/bundles/types/checkout/layout-widgets/additionals.d.ts.map +0 -1
- package/bundles/types/checkout/layout-widgets/default-variables.enum.d.ts.map +0 -1
- package/bundles/types/checkout/layout-widgets/message.d.ts.map +0 -1
- package/bundles/types/checkout/layout-widgets/payment-methods-template.d.ts.map +0 -1
- package/bundles/types/checkout/layout-widgets/payment-methods.d.ts.map +0 -1
- package/bundles/types/checkout/layout-widgets/payment-template.d.ts.map +0 -1
- package/bundles/types/fraud-prevention/providers/forter/templates/forter-snippet-2025-02-06t14:19:34z.template.d.ts.map +0 -1
- package/docs/api-vault-display.md +0 -94
- /package/bundles/types/checkout/{instructions/v1 → v1/instructions}/index.d.ts +0 -0
- /package/bundles/types/checkout/{instructions/v1 → v1/instructions}/instruction.canvas_3ds.show.d.ts +0 -0
- /package/bundles/types/checkout/{instructions/v1 → v1/instructions}/instruction.fraud_service.show.d.ts +0 -0
- /package/bundles/types/checkout/{instructions/v1 → v1/instructions}/instruction.payment_methods.show.d.ts +0 -0
- /package/bundles/types/checkout/{layout-widgets → v1/layout-widgets}/default-variables.enum.d.ts +0 -0
- /package/bundles/types/checkout/{layout-widgets → v1/layout-widgets}/payment-methods-template.d.ts +0 -0
- /package/bundles/types/checkout/{layout-widgets → v1/layout-widgets}/payment-template.d.ts +0 -0
|
@@ -105,6 +105,534 @@ A full description of the meta parameters for [ApplePayWalletButtonExpress](#App
|
|
|
105
105
|
</html>
|
|
106
106
|
```
|
|
107
107
|
|
|
108
|
+
### Apple Pay Wallet Button Express with Shipping
|
|
109
|
+
|
|
110
|
+
A full description of the meta parameters for [ApplePayWalletButtonExpress](#ApplePayWalletButtonExpress) meta parameters can be found [here](#ApplePayWalletMeta). Below you will find a fully working html example.
|
|
111
|
+
|
|
112
|
+
```html
|
|
113
|
+
<html>
|
|
114
|
+
<head>
|
|
115
|
+
<title>Apple Pay Express test page</title>
|
|
116
|
+
<style>
|
|
117
|
+
#inputModal {
|
|
118
|
+
display: none;
|
|
119
|
+
position: fixed;
|
|
120
|
+
left: 0;
|
|
121
|
+
top: 0;
|
|
122
|
+
width: 100%;
|
|
123
|
+
height: 100%;
|
|
124
|
+
background-color: rgba(0,0,0,0.5);
|
|
125
|
+
z-index: 1000;
|
|
126
|
+
}
|
|
127
|
+
#inputBox {
|
|
128
|
+
position: absolute;
|
|
129
|
+
left: 50%;
|
|
130
|
+
top: 50%;
|
|
131
|
+
transform: translate(-50%, -50%);
|
|
132
|
+
padding: 20px;
|
|
133
|
+
background: white;
|
|
134
|
+
border-radius: 5px;
|
|
135
|
+
box-shadow: 2px 2px 10px rgba(0,0,0,0.5);
|
|
136
|
+
}
|
|
137
|
+
</style>
|
|
138
|
+
</head>
|
|
139
|
+
<body>
|
|
140
|
+
<table id='paymentTable'>
|
|
141
|
+
<tr>
|
|
142
|
+
<td>Environment:</td>
|
|
143
|
+
<td>
|
|
144
|
+
<select id="environment" name="environment">
|
|
145
|
+
<option value="sandbox">Sandbox</option>
|
|
146
|
+
<option value="local">Local</option>
|
|
147
|
+
</select>
|
|
148
|
+
</td>
|
|
149
|
+
</tr>
|
|
150
|
+
<tr>
|
|
151
|
+
<td>Access Token / Public Key:</td>
|
|
152
|
+
<td><input type="text" name="access" id="access" /></td>
|
|
153
|
+
</tr>
|
|
154
|
+
<tr>
|
|
155
|
+
<td>Secret Key:</td>
|
|
156
|
+
<td><input type="text" name="secretKey" id="secretKey" /></td>
|
|
157
|
+
</tr>
|
|
158
|
+
<tr>
|
|
159
|
+
<td>Gateway Id:</td>
|
|
160
|
+
<td><input type="text" name="gateway" id="gateway" /></td>
|
|
161
|
+
</tr>
|
|
162
|
+
<tr>
|
|
163
|
+
<td>Wallet Charge - for apple pay we need to add it here because the apple pay popup does not allow us to
|
|
164
|
+
inject it there but it will be used only on click. So is optional, if not provided it simulates an error
|
|
165
|
+
when creating B2B wallet charge on click:</td>
|
|
166
|
+
<td><input type="text" name="token" id="token" /></td>
|
|
167
|
+
</tr>
|
|
168
|
+
<tr>
|
|
169
|
+
<td>Charge id - Used to update the charge with the shipping data/shipping options</td>
|
|
170
|
+
<td><input type="text" name="chargeId" id="chargeId" /></td>
|
|
171
|
+
</tr>
|
|
172
|
+
<tr>
|
|
173
|
+
<td>Meta:</td>
|
|
174
|
+
<td><textarea id="meta" name="meta" rows="4" cols="50"></textarea></td>
|
|
175
|
+
</tr>
|
|
176
|
+
</table>
|
|
177
|
+
<div id="button">
|
|
178
|
+
<input type="submit" name="event" value="Send" class="button" onclick="return loadButtons()" />
|
|
179
|
+
</div>
|
|
180
|
+
<div id="widget"></div>
|
|
181
|
+
</body>
|
|
182
|
+
|
|
183
|
+
<script src="https://widget.paydock.com/sdk/latest/widget.umd.min.js"></script>
|
|
184
|
+
<script type=text/javascript>
|
|
185
|
+
// Environment enum with API URLs
|
|
186
|
+
const ENVIRONMENTS = {
|
|
187
|
+
PRODUCTION: {
|
|
188
|
+
name: 'production',
|
|
189
|
+
apiUrl: 'https://api.paydock.com'
|
|
190
|
+
},
|
|
191
|
+
SANDBOX: {
|
|
192
|
+
name: 'sandbox',
|
|
193
|
+
apiUrl: 'https://api-sandox.paydock.com'
|
|
194
|
+
}
|
|
195
|
+
};
|
|
196
|
+
|
|
197
|
+
// Function to get API URL based on selected environment
|
|
198
|
+
function getApiUrl(environmentName) {
|
|
199
|
+
const env = Object.values(ENVIRONMENTS).find(env => env.name === environmentName);
|
|
200
|
+
return env ? env.apiUrl : ENVIRONMENTS.SANDBOX.apiUrl;
|
|
201
|
+
}
|
|
202
|
+
|
|
203
|
+
// Function to get current base URL from selected environment
|
|
204
|
+
function getBaseUrl() {
|
|
205
|
+
const selectedEnvironment = document.getElementById("environment").value;
|
|
206
|
+
return getApiUrl(selectedEnvironment);
|
|
207
|
+
}
|
|
208
|
+
|
|
209
|
+
async function updateCharge(secretKey, chargeId, updateData) {
|
|
210
|
+
try {
|
|
211
|
+
const baseUrl = getBaseUrl();
|
|
212
|
+
const response = await fetch(`${baseUrl}/v1/charges/wallet/${chargeId}`, {
|
|
213
|
+
method: 'PUT',
|
|
214
|
+
headers: {
|
|
215
|
+
'x-user-secret-key': secretKey,
|
|
216
|
+
'Content-Type': 'application/json',
|
|
217
|
+
},
|
|
218
|
+
body: JSON.stringify(updateData),
|
|
219
|
+
});
|
|
220
|
+
const data = await response.json();
|
|
221
|
+
console.log('Update charge response:', data);
|
|
222
|
+
return data;
|
|
223
|
+
} catch (error) {
|
|
224
|
+
console.error('Error updating charge:', error);
|
|
225
|
+
}
|
|
226
|
+
};
|
|
227
|
+
|
|
228
|
+
const shippingOptions = [
|
|
229
|
+
{
|
|
230
|
+
label: "Test 1",
|
|
231
|
+
detail: "This is a test 1 shipping methods",
|
|
232
|
+
amount: 10,
|
|
233
|
+
id: "randomId1",
|
|
234
|
+
date_components_range: {
|
|
235
|
+
start_date_components: {
|
|
236
|
+
years: 0,
|
|
237
|
+
months: 0,
|
|
238
|
+
days: 5,
|
|
239
|
+
hours: 0,
|
|
240
|
+
},
|
|
241
|
+
end_date_components: {
|
|
242
|
+
years: 0,
|
|
243
|
+
months: 0,
|
|
244
|
+
days: 10,
|
|
245
|
+
hours: 0,
|
|
246
|
+
}
|
|
247
|
+
}
|
|
248
|
+
},
|
|
249
|
+
{
|
|
250
|
+
label: "Test 2",
|
|
251
|
+
detail: "This is a test 2 shipping methods",
|
|
252
|
+
amount: 14,
|
|
253
|
+
id: "randomId2",
|
|
254
|
+
date_components_range: {
|
|
255
|
+
start_date_components: {
|
|
256
|
+
years: 0,
|
|
257
|
+
months: 0,
|
|
258
|
+
days: 6,
|
|
259
|
+
hours: 0,
|
|
260
|
+
},
|
|
261
|
+
end_date_components: {
|
|
262
|
+
years: 0,
|
|
263
|
+
months: 0,
|
|
264
|
+
days: 12,
|
|
265
|
+
hours: 0,
|
|
266
|
+
},
|
|
267
|
+
},
|
|
268
|
+
},
|
|
269
|
+
];
|
|
270
|
+
|
|
271
|
+
function loadButtons() {
|
|
272
|
+
const secretKey = document.getElementById("secretKey").value;
|
|
273
|
+
if (!secretKey) {
|
|
274
|
+
alert("Please enter the secret key.");
|
|
275
|
+
return false;
|
|
276
|
+
}
|
|
277
|
+
|
|
278
|
+
let button = new paydock.ApplePayWalletButtonExpress(
|
|
279
|
+
"#widget",
|
|
280
|
+
document.getElementById("access").value,
|
|
281
|
+
document.getElementById("gateway").value,
|
|
282
|
+
JSON.parse(document.getElementById("meta").value),
|
|
283
|
+
);
|
|
284
|
+
|
|
285
|
+
button.setEnv(document.getElementById("environment").value);
|
|
286
|
+
|
|
287
|
+
let charge_id;
|
|
288
|
+
|
|
289
|
+
button.onClick(async (data) => {
|
|
290
|
+
const { token, chargeId } = await getUserInput();
|
|
291
|
+
charge_id = chargeId;
|
|
292
|
+
return token;
|
|
293
|
+
});
|
|
294
|
+
|
|
295
|
+
const amount = JSON.parse(document.getElementById('meta').value).amount;
|
|
296
|
+
|
|
297
|
+
button.onUnavailable(function() {
|
|
298
|
+
console.log("Button unavailable");
|
|
299
|
+
});
|
|
300
|
+
button.onError(function(error) {
|
|
301
|
+
console.log("On Error Callback", error);
|
|
302
|
+
});
|
|
303
|
+
button.onPaymentSuccessful(function(data) {
|
|
304
|
+
console.log("Payment successful");
|
|
305
|
+
console.log(data);
|
|
306
|
+
});
|
|
307
|
+
button.onPaymentError(function(err) {
|
|
308
|
+
console.log("Payment error");
|
|
309
|
+
console.log(err);
|
|
310
|
+
});
|
|
311
|
+
button.onPaymentInReview(function(data) {
|
|
312
|
+
console.log("The payment is on fraud review");
|
|
313
|
+
console.log(data);
|
|
314
|
+
});
|
|
315
|
+
button.onCheckoutClose(() => {
|
|
316
|
+
console.log("Checkout closed");
|
|
317
|
+
});
|
|
318
|
+
|
|
319
|
+
button.onShippingAddressChange(async function(data) {
|
|
320
|
+
console.log("Shipping address has been updated", data);
|
|
321
|
+
|
|
322
|
+
const defaultOption = shippingOptions[0];
|
|
323
|
+
|
|
324
|
+
const updateData = {
|
|
325
|
+
shipping: {
|
|
326
|
+
...data.data,
|
|
327
|
+
amount: defaultOption.amount,
|
|
328
|
+
method: defaultOption.id,
|
|
329
|
+
options: shippingOptions,
|
|
330
|
+
},
|
|
331
|
+
amount: amount + defaultOption.amount
|
|
332
|
+
};
|
|
333
|
+
|
|
334
|
+
const res = await updateCharge(secretKey, charge_id, updateData);
|
|
335
|
+
return { token: res.resource.data.token };
|
|
336
|
+
});
|
|
337
|
+
|
|
338
|
+
button.onShippingOptionsChange(async function(data) {
|
|
339
|
+
console.log("Shipping options have been updated", JSON.stringify(data, null, 2));
|
|
340
|
+
|
|
341
|
+
const updateData = {
|
|
342
|
+
shipping: {
|
|
343
|
+
method: data.data.shipping_option_id,
|
|
344
|
+
amount: data.data.amount,
|
|
345
|
+
},
|
|
346
|
+
amount: amount + Number(data.data.amount)
|
|
347
|
+
};
|
|
348
|
+
|
|
349
|
+
const res = await updateCharge(secretKey, charge_id, updateData);
|
|
350
|
+
return { token: res.resource.data.token };
|
|
351
|
+
});
|
|
352
|
+
|
|
353
|
+
button.load()
|
|
354
|
+
|
|
355
|
+
document.getElementById("paymentTable").style.display = "none";
|
|
356
|
+
document.getElementById("button").style.display = "none";
|
|
357
|
+
return true;
|
|
358
|
+
}
|
|
359
|
+
|
|
360
|
+
function getUserInput(message) {
|
|
361
|
+
return new Promise((resolve, reject) => {
|
|
362
|
+
console.log("Simulating B2B call to generate token...");
|
|
363
|
+
setTimeout(() => {
|
|
364
|
+
const token = document.getElementById("token").value;
|
|
365
|
+
const chargeId = document.getElementById("chargeId").value;
|
|
366
|
+
if (token && chargeId)
|
|
367
|
+
return resolve({ token, chargeId });
|
|
368
|
+
return reject("No token or Charge Id provided");
|
|
369
|
+
}, 2000);
|
|
370
|
+
});
|
|
371
|
+
}
|
|
372
|
+
|
|
373
|
+
document.addEventListener('DOMContentLoaded', () => {
|
|
374
|
+
// Function to get the value of a query parameter by name
|
|
375
|
+
function getQueryParam(name) {
|
|
376
|
+
const urlParams = new URLSearchParams(window.location.search);
|
|
377
|
+
return urlParams.get(name);
|
|
378
|
+
}
|
|
379
|
+
|
|
380
|
+
// Function to set input values from URL parameters
|
|
381
|
+
function setInputValues() {
|
|
382
|
+
const meta = {
|
|
383
|
+
apple_pay_capabilities: ['credentials_available', 'credentials_status_unknown', 'credentials_unavailable'],
|
|
384
|
+
amount_label: 'TOTAL',
|
|
385
|
+
country: 'AU',
|
|
386
|
+
currency: 'AUD',
|
|
387
|
+
amount: 10,
|
|
388
|
+
shipping_editing_mode: 'available', // available, store_pickup
|
|
389
|
+
required_shipping_contact_fields: [
|
|
390
|
+
'postalAddress',
|
|
391
|
+
'name',
|
|
392
|
+
'phone',
|
|
393
|
+
'email',
|
|
394
|
+
],
|
|
395
|
+
shipping: {
|
|
396
|
+
amount: 5,
|
|
397
|
+
address_line1: "Address Line 1",
|
|
398
|
+
address_city: "Test Locality",
|
|
399
|
+
address_state: "NSW",
|
|
400
|
+
address_country: "Australia",
|
|
401
|
+
address_country_code: "AU",
|
|
402
|
+
address_postcode: "3000",
|
|
403
|
+
contact: {
|
|
404
|
+
phone: "+61400245562",
|
|
405
|
+
email: "qa.notifications+appleid@paydock.com",
|
|
406
|
+
first_name: "QA",
|
|
407
|
+
last_name: "QA",
|
|
408
|
+
},
|
|
409
|
+
options: shippingOptions,
|
|
410
|
+
},
|
|
411
|
+
// merchant_capabilities: ['supports3DS', 'supportsEMV', 'supportsCredit', 'supportsDebit'],
|
|
412
|
+
// supported_networks: ['visa', 'masterCard', 'amex', 'chinaUnionPay', 'discover', 'interac', 'jcb', 'privateLabel'],
|
|
413
|
+
// required_billing_contact_fields: ['email', 'name', 'phone', 'postalAddress', 'phoneticName'],
|
|
414
|
+
// required_shipping_contact_fields: ['email', 'phone' /*, 'name', 'postalAddress', 'phoneticName'*/],
|
|
415
|
+
// supported_countries: [],
|
|
416
|
+
// style: {
|
|
417
|
+
// button_type: 'continue',
|
|
418
|
+
// button_style: 'white',
|
|
419
|
+
// },
|
|
420
|
+
};
|
|
421
|
+
document.getElementById('meta').value = JSON.stringify(meta, null, 2);
|
|
422
|
+
}
|
|
423
|
+
|
|
424
|
+
setInputValues();
|
|
425
|
+
});
|
|
426
|
+
</script>
|
|
427
|
+
</html>
|
|
428
|
+
```
|
|
429
|
+
|
|
430
|
+
When supporting shipping, the method `onShippingAddressChange` and `onShippingOptionsChange` are required to update the shipping address and options.
|
|
431
|
+
|
|
432
|
+
```javascript
|
|
433
|
+
button.onShippingAddressChange(async function(data) {
|
|
434
|
+
console.log("Shipping address has been updated", data);
|
|
435
|
+
|
|
436
|
+
const updateData = {
|
|
437
|
+
shipping: {
|
|
438
|
+
...data.data,
|
|
439
|
+
amount: defaultOption.amount,
|
|
440
|
+
method: defaultOption.id,
|
|
441
|
+
options: shippingOptions,
|
|
442
|
+
},
|
|
443
|
+
amount: amount + defaultOption.amount
|
|
444
|
+
};
|
|
445
|
+
|
|
446
|
+
const res = await updateCharge(secretKey, charge_id, updateData);
|
|
447
|
+
return { token: res.resource.data.token };
|
|
448
|
+
});
|
|
449
|
+
|
|
450
|
+
button.onShippingOptionsChange(async function(data) {
|
|
451
|
+
console.log("Shipping options have been updated", data);
|
|
452
|
+
|
|
453
|
+
const updateData = {
|
|
454
|
+
shipping: {
|
|
455
|
+
method: data.data.shipping_option_id,
|
|
456
|
+
amount: data.data.amount,
|
|
457
|
+
},
|
|
458
|
+
amount: amount + Number(data.data.amount)
|
|
459
|
+
};
|
|
460
|
+
|
|
461
|
+
const res = await updateCharge(secretKey, charge_id, updateData);
|
|
462
|
+
return { token: res.resource.data.token };
|
|
463
|
+
});
|
|
464
|
+
```
|
|
465
|
+
|
|
466
|
+
The `updateCharge` method is a custom method to update the charge with the shipping data/shipping options. It is not part of the Paydock SDK and it should use the Paydock's public API to update the charge from the merchant's server.
|
|
467
|
+
|
|
468
|
+
### Supported Cases
|
|
469
|
+
#### Injected Shipping Address, non-editable by the customer
|
|
470
|
+
|
|
471
|
+
This is the case where the shipping address is injected by the merchant and is not editable by the customer. The customer can only select the shipping option.
|
|
472
|
+
|
|
473
|
+
The required meta parameters for this case are:
|
|
474
|
+
- shipping_editing_mode: 'store_pickup'
|
|
475
|
+
- required_shipping_contact_fields: ['postalAddress'] <-- At least one of the fields is required so the shipping address is shown at Apple Pay.
|
|
476
|
+
|
|
477
|
+
```javascript
|
|
478
|
+
meta: {
|
|
479
|
+
apple_pay_capabilities: ['credentials_available', 'credentials_status_unknown', 'credentials_unavailable'],
|
|
480
|
+
amount_label: 'TOTAL',
|
|
481
|
+
country: 'AU',
|
|
482
|
+
currency: 'AUD',
|
|
483
|
+
amount: 10,
|
|
484
|
+
shipping_editing_mode: 'store_pickup',
|
|
485
|
+
required_shipping_contact_fields: [
|
|
486
|
+
'postalAddress', // At least one of the fields is required so the shipping address is shown at Apple Pay.
|
|
487
|
+
'name',
|
|
488
|
+
'phone',
|
|
489
|
+
'email',
|
|
490
|
+
],
|
|
491
|
+
shipping: {
|
|
492
|
+
amount: 5,
|
|
493
|
+
address_line1: "Address Line 1",
|
|
494
|
+
address_city: "Test Locality",
|
|
495
|
+
address_state: "NSW",
|
|
496
|
+
address_country: "Australia",
|
|
497
|
+
address_country_code: "AU",
|
|
498
|
+
address_postcode: "3000",
|
|
499
|
+
contact: {
|
|
500
|
+
phone: "+61400245562",
|
|
501
|
+
email: "qa.notifications+appleid@paydock.com",
|
|
502
|
+
first_name: "QA",
|
|
503
|
+
last_name: "QA",
|
|
504
|
+
},
|
|
505
|
+
options: [
|
|
506
|
+
{
|
|
507
|
+
label: "Test 1",
|
|
508
|
+
detail: "This is a test 1 shipping methods",
|
|
509
|
+
amount: 10,
|
|
510
|
+
id: "randomId1",
|
|
511
|
+
date_components_range: {
|
|
512
|
+
start_date_components: {
|
|
513
|
+
years: 0,
|
|
514
|
+
months: 0,
|
|
515
|
+
days: 5,
|
|
516
|
+
hours: 0,
|
|
517
|
+
},
|
|
518
|
+
end_date_components: {
|
|
519
|
+
years: 0,
|
|
520
|
+
months: 0,
|
|
521
|
+
days: 10,
|
|
522
|
+
hours: 0,
|
|
523
|
+
}
|
|
524
|
+
}
|
|
525
|
+
}
|
|
526
|
+
],
|
|
527
|
+
},
|
|
528
|
+
}
|
|
529
|
+
```
|
|
530
|
+
|
|
531
|
+
This is the case where the shipping address is injected by the merchant and is editable by the customer. The customer can edit the shipping address and select the shipping option.
|
|
532
|
+
|
|
533
|
+
The required meta parameters for this case are:
|
|
534
|
+
- shipping_editing_mode: 'available'
|
|
535
|
+
- required_shipping_contact_fields: ['postalAddress'] <-- At least one of the fields is required so the shipping address is shown at Apple Pay.
|
|
536
|
+
|
|
537
|
+
```javascript
|
|
538
|
+
meta: {
|
|
539
|
+
apple_pay_capabilities: ['credentials_available', 'credentials_status_unknown', 'credentials_unavailable'],
|
|
540
|
+
amount_label: 'TOTAL',
|
|
541
|
+
country: 'AU',
|
|
542
|
+
currency: 'AUD',
|
|
543
|
+
amount: 10,
|
|
544
|
+
shipping_editing_mode: 'available',
|
|
545
|
+
required_shipping_contact_fields: [
|
|
546
|
+
'postalAddress', // At least one of the fields is required so the shipping address is shown at Apple Pay.
|
|
547
|
+
'name',
|
|
548
|
+
'phone',
|
|
549
|
+
'email',
|
|
550
|
+
],
|
|
551
|
+
shipping: {
|
|
552
|
+
amount: 5,
|
|
553
|
+
address_line1: "Address Line 1",
|
|
554
|
+
address_city: "Test Locality",
|
|
555
|
+
address_state: "NSW",
|
|
556
|
+
address_country: "Australia",
|
|
557
|
+
address_country_code: "AU",
|
|
558
|
+
address_postcode: "3000",
|
|
559
|
+
contact: {
|
|
560
|
+
phone: "+61400245562",
|
|
561
|
+
email: "qa.notifications+appleid@paydock.com",
|
|
562
|
+
first_name: "QA",
|
|
563
|
+
last_name: "QA",
|
|
564
|
+
},
|
|
565
|
+
options: [
|
|
566
|
+
{
|
|
567
|
+
label: "Test 1",
|
|
568
|
+
detail: "This is a test 1 shipping methods",
|
|
569
|
+
amount: 10,
|
|
570
|
+
id: "randomId1",
|
|
571
|
+
date_components_range: {
|
|
572
|
+
start_date_components: {
|
|
573
|
+
years: 0,
|
|
574
|
+
months: 0,
|
|
575
|
+
days: 5,
|
|
576
|
+
hours: 0,
|
|
577
|
+
},
|
|
578
|
+
end_date_components: {
|
|
579
|
+
years: 0,
|
|
580
|
+
months: 0,
|
|
581
|
+
days: 10,
|
|
582
|
+
hours: 0,
|
|
583
|
+
}
|
|
584
|
+
}
|
|
585
|
+
}
|
|
586
|
+
],
|
|
587
|
+
},
|
|
588
|
+
}
|
|
589
|
+
```
|
|
590
|
+
|
|
591
|
+
#### Shipping address editable by the customer
|
|
592
|
+
|
|
593
|
+
This is the case where the shipping address is not injected by the merchant and is editable by the customer. The customer can edit the shipping address and select the shipping option.
|
|
594
|
+
|
|
595
|
+
The required meta parameters for this case are:
|
|
596
|
+
- shipping_editing_mode: 'available'
|
|
597
|
+
- required_shipping_contact_fields: ['postalAddress'] <-- At least one of the fields is required so the shipping address is shown at Apple Pay.
|
|
598
|
+
|
|
599
|
+
```javascript
|
|
600
|
+
meta: {
|
|
601
|
+
apple_pay_capabilities: ['credentials_available', 'credentials_status_unknown', 'credentials_unavailable'],
|
|
602
|
+
amount_label: 'TOTAL',
|
|
603
|
+
country: 'AU',
|
|
604
|
+
currency: 'AUD',
|
|
605
|
+
amount: 10,
|
|
606
|
+
shipping_editing_mode: 'available',
|
|
607
|
+
required_shipping_contact_fields: [
|
|
608
|
+
'postalAddress', // At least one of the fields is required so the shipping address is shown at Apple Pay.
|
|
609
|
+
'name',
|
|
610
|
+
'phone',
|
|
611
|
+
'email',
|
|
612
|
+
],
|
|
613
|
+
}
|
|
614
|
+
```
|
|
615
|
+
|
|
616
|
+
When the the customer selects an address, the `onShippingAddressChange` method is called with the shipping address data. If the merchant wants to update the charge with the shipping address, it should update the charge using Paydock's public API Update Charge method with the shipping address data.
|
|
617
|
+
|
|
618
|
+
It can include the shipping options in the update data, that will be used to show the shipping options in the Apple Pay popup.
|
|
619
|
+
|
|
620
|
+
```javascript
|
|
621
|
+
button.onShippingAddressChange(async function(data) {
|
|
622
|
+
console.log("Shipping address has been updated", data);
|
|
623
|
+
|
|
624
|
+
const updateData = {
|
|
625
|
+
shipping: {
|
|
626
|
+
...data.data,
|
|
627
|
+
amount: defaultOption.amount,
|
|
628
|
+
method: defaultOption.id,
|
|
629
|
+
options: shippingOptions,
|
|
630
|
+
},
|
|
631
|
+
amount: amount + defaultOption.amount
|
|
632
|
+
};
|
|
633
|
+
});
|
|
634
|
+
```
|
|
635
|
+
|
|
108
636
|
### Paypal Wallet Button Express
|
|
109
637
|
A full description of the meta parameters for [PaypalWalletButtonExpress](#PaypalWalletButtonExpress) meta parameters can be found [here](#PaypalWalletMeta). Below you will find a fully working html example.
|
|
110
638
|
|
package/docs/wallet-buttons.md
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
<dl>
|
|
4
4
|
<dt><a href="#WalletButtons">WalletButtons</a></dt>
|
|
5
|
-
<dd><p>Class WalletButtons to work with different E-Wallets within html (currently supports Apple Pay, Google Pay, Google Pay™ and Apple Pay via Stripe, Flypay
|
|
5
|
+
<dd><p>Class WalletButtons to work with different E-Wallets within html (currently supports Apple Pay, Google Pay, Google Pay™ and Apple Pay via Stripe, Flypay V2, Paypal, Afterpay)</p>
|
|
6
6
|
</dd>
|
|
7
7
|
</dl>
|
|
8
8
|
|
|
@@ -154,8 +154,8 @@ Interface of data used by the wallet checkout and payment proccess.
|
|
|
154
154
|
|
|
155
155
|
| Param | Type | Description |
|
|
156
156
|
| --- | --- | --- |
|
|
157
|
-
| [amount_label] | <code>string</code> | Label shown next to the total amount to be paid. Required for [Stripe, ApplePay, GooglePay]. N/A for [
|
|
158
|
-
| [country] | <code>string</code> | Country of the user. 2 letter ISO code format. Required for [Stripe, ApplePay, GooglePay, Afterpay]. N/A for [
|
|
157
|
+
| [amount_label] | <code>string</code> | Label shown next to the total amount to be paid. Required for [Stripe, ApplePay, GooglePay]. N/A for [Flypay V2, PayPal, Afterpay]. |
|
|
158
|
+
| [country] | <code>string</code> | Country of the user. 2 letter ISO code format. Required for [Stripe, ApplePay, GooglePay, Afterpay]. N/A for [Flypay V2, PayPal]. |
|
|
159
159
|
| [pay_later] | <code>boolean</code> | Used to enable Pay Later feature in PayPal Smart Checkout WalletButton integration when available. Optional for [PayPal]. N/A for other wallets. |
|
|
160
160
|
| [hide_message] | <code>boolean</code> | Used to hide Pay Later message in PayPal Smart Checkout WalletButton integration. Optional for [PayPal]. N/A for other wallets. |
|
|
161
161
|
| [standalone] | <code>boolean</code> | Used to enable Standalone Buttons feature in PayPal Smart Checkout WalletButton integration. Used together with `pay_later`. Optional for [PayPal]. N/A for other wallets. |
|
|
@@ -165,17 +165,17 @@ Interface of data used by the wallet checkout and payment proccess.
|
|
|
165
165
|
| [request_payer_phone] | <code>boolean</code> | Used mainly for fraud purposes - recommended set to true. Optional for [Stripe]. N/A for other wallets. |
|
|
166
166
|
| [access_token] | <code>string</code> | Used for Flypay V2 express flow. Optional for [Flypay V2]. N/A for other wallets. |
|
|
167
167
|
| [refresh_token] | <code>string</code> | Used for Flypay V2 express flow. Optional for [Flypay V2]. N/A for other wallets. |
|
|
168
|
-
| [request_shipping] | <code>boolean</code> | Used to request or not shipping address in the Wallet checkout, being able to handle amount changes via the `update` event. Optional for [
|
|
168
|
+
| [request_shipping] | <code>boolean</code> | Used to request or not shipping address in the Wallet checkout, being able to handle amount changes via the `update` event. Optional for [PayPal, ApplePay, GooglePay]. N/A for [Flypay V2, Stripe, Afterpay]. |
|
|
169
169
|
| [shipping_options] | [<code>Array.<IApplePayShippingOption></code>](#IApplePayShippingOption) \| [<code>Array.<IPayPalShippingOption></code>](#IPayPalShippingOption) | Used to provide available shipping options.(To use shipping_options the request_shipping flag should be true). Optional for [ApplePay]. N/A for the other wallets. |
|
|
170
170
|
| [merchant_name] | <code>string</code> | Merchant Name used for GooglePay integration via MPGS. Required for [GooglePay]. N/A for other wallets. |
|
|
171
171
|
| [raw_data_initialization] | <code>object</code> | Used to provide values to initialize wallet with raw data. Optional for [ApplePay]. N/A for the other wallets. |
|
|
172
|
-
| [style] | <code>object</code> | For **Paypal**: used to style the buttons, check possible values in the [style guide](https://developer.paypal.com/docs/business/checkout/reference/style-guide). When `standalone` and `pay_later`, extra options can be provided in `style.messages` with the [messages style options](https://developer.paypal.com/docs/checkout/pay-later/us/integrate/reference/#stylelayout). Also used at **ApplePay**, **GooglePay** and **Afterpay** to select button type. Optional for [PayPal, ApplePay, GooglePay, Afterpay]. N/A for [Stripe,
|
|
172
|
+
| [style] | <code>object</code> | For **Paypal**: used to style the buttons, check possible values in the [style guide](https://developer.paypal.com/docs/business/checkout/reference/style-guide). When `standalone` and `pay_later`, extra options can be provided in `style.messages` with the [messages style options](https://developer.paypal.com/docs/checkout/pay-later/us/integrate/reference/#stylelayout). Also used at **ApplePay**, **GooglePay** and **Afterpay** to select button type. Optional for [PayPal, ApplePay, GooglePay, Afterpay]. N/A for [Stripe, Flypay V2]. |
|
|
173
173
|
| [style.button_type] | <code>object</code> | Used to select ApplePay button type (e.g: 'buy','donate', etc), check possible values [here](https://developer.apple.com/documentation/apple_pay_on_the_web/displaying_apple_pay_buttons_using_css). Also select button type for GooglePay (check GooglePayStyles) and Afterpay (check AfterpayStyles). Optional for [ApplePay, GooglePay, Afterpay]. N/A for other wallets. |
|
|
174
174
|
| [style.button_style] | <code>object</code> | Used to select ApplePay button style (e.g: 'black', 'white', etc), check possible values [here](https://developer.apple.com/documentation/apple_pay_on_the_web/applepaybuttonstyle). Optional for [ApplePay]. N/A for other wallets. |
|
|
175
175
|
| [style.height] | <code>object</code> | Used to select Afterpay button height. Optional for [Afterpay]. N/A for other wallets. |
|
|
176
176
|
| [wallets] | <code>array</code> | By default if this is not sent or empty, we will try to show either Apple Pay or Google Pay buttons. This can be limited sending the following array in this field: ['apple','google]. Optional for [Stripe, ApplePay, GooglePay]. N/A for other wallets. |
|
|
177
|
-
| [client_id] | <code>string</code> | Client ID to be used in the provider system. Required for [Flypay V2]. N/A for [
|
|
178
|
-
| [apple_pay_capabilities] | <code>Array.<('credentials\_available'\|'credentials\_status\_unknown'\|'credentials\_unavailable')></code> | Device capabilities needed for wallet button to be available. For further information about refer to [the documentation](https://developer.apple.com/documentation/apple_pay_on_the_web/applepaysession/4440085-applepaycapabilities). If the recognized value is credentials_status_unknown, the payment most possibly cannot be finished on the web, and the buyer must complete it on a compatible device, like Iphone, via QR scan. Optional parameter for [ApplePay]. N/A for [
|
|
177
|
+
| [client_id] | <code>string</code> | Client ID to be used in the provider system. Required for [Flypay V2]. N/A for [GooglePay, ApplePay, PayPal, Afterpay]. |
|
|
178
|
+
| [apple_pay_capabilities] | <code>Array.<('credentials\_available'\|'credentials\_status\_unknown'\|'credentials\_unavailable')></code> | Device capabilities needed for wallet button to be available. For further information about refer to [the documentation](https://developer.apple.com/documentation/apple_pay_on_the_web/applepaysession/4440085-applepaycapabilities). If the recognized value is credentials_status_unknown, the payment most possibly cannot be finished on the web, and the buyer must complete it on a compatible device, like Iphone, via QR scan. Optional parameter for [ApplePay]. N/A for [GooglePay, Flypay V2, PayPal, Afterpay]. |
|
|
179
179
|
|
|
180
180
|
<a name="IApplePayShippingOption" id="IApplePayShippingOption" href="#IApplePayShippingOption"> </a>
|
|
181
181
|
|
|
@@ -224,7 +224,7 @@ Interface of Shipping Options for PayPal
|
|
|
224
224
|
<a name="WalletButtons" id="WalletButtons" href="#WalletButtons"> </a>
|
|
225
225
|
|
|
226
226
|
## WalletButtons
|
|
227
|
-
Class WalletButtons to work with different E-Wallets within html (currently supports Apple Pay, Google Pay, Google Pay™ and Apple Pay via Stripe, Flypay
|
|
227
|
+
Class WalletButtons to work with different E-Wallets within html (currently supports Apple Pay, Google Pay, Google Pay™ and Apple Pay via Stripe, Flypay V2, Paypal, Afterpay)
|
|
228
228
|
|
|
229
229
|
**Kind**: global class
|
|
230
230
|
|
|
@@ -284,7 +284,7 @@ var button = new WalletButtons(
|
|
|
284
284
|
|
|
285
285
|
### walletButtons.update()
|
|
286
286
|
Triggers the update process of the wallet, if available.
|
|
287
|
-
Currently supported by
|
|
287
|
+
Currently supported by Paypal and ApplePay/GooglePay via MPGS Wallets.
|
|
288
288
|
|
|
289
289
|
**Kind**: instance method of [<code>WalletButtons</code>](#WalletButtons)
|
|
290
290
|
**Example**
|
|
@@ -408,7 +408,7 @@ button.on('paymentSuccessful', function (data) {
|
|
|
408
408
|
});
|
|
409
409
|
// or
|
|
410
410
|
button.on('unavailable').then(function () {
|
|
411
|
-
console.log('No button is available);
|
|
411
|
+
console.log('No button is available');
|
|
412
412
|
});
|
|
413
413
|
```
|
|
414
414
|
<a name="WalletButtons+onUnavailable" id="WalletButtons+onUnavailable" href="#WalletButtons+onUnavailable"> </a>
|
|
@@ -622,4 +622,5 @@ List of available event's name in the wallet button lifecycle
|
|
|
622
622
|
| PAYMENT_SUCCESSFUL | <code>string</code> | <code>"paymentSuccessful"</code> |
|
|
623
623
|
| PAYMENT_ERROR | <code>string</code> | <code>"paymentError"</code> |
|
|
624
624
|
| ON_CLICK | <code>string</code> | <code>"onClick"</code> |
|
|
625
|
+
| LOADED | <code>string</code> | <code>"onWalletLoaded"</code> |
|
|
625
626
|
|
|
@@ -184,7 +184,7 @@ of the corresponding event names.
|
|
|
184
184
|
|
|
185
185
|
```javascript
|
|
186
186
|
button.on(EVENT.UNAVAILABLE, () => console.log("No wallet buttons available"));
|
|
187
|
-
button.on(EVENT.UPDATE, (data) => console.log("Updating amount via a backend to backend call to POST charges/:id");
|
|
187
|
+
button.on(EVENT.UPDATE, (data) => console.log("Updating amount via a backend to backend call to POST charges/:id"));
|
|
188
188
|
button.on(EVENT.PAYMENT_SUCCESSFUL, (data) => console.log("The payment was successful"));
|
|
189
189
|
button.on(EVENT.PAYMENT_ERROR, (data) => console.log("The payment was not successful"));
|
|
190
190
|
```
|
package/package.json
CHANGED
|
@@ -104,7 +104,7 @@
|
|
|
104
104
|
}
|
|
105
105
|
},
|
|
106
106
|
"name": "@paydock/client-sdk",
|
|
107
|
-
"version": "1.
|
|
107
|
+
"version": "1.131.0-beta",
|
|
108
108
|
"scripts": {
|
|
109
109
|
"build:doc": "node docs/html/marked.js",
|
|
110
110
|
"build:js": "rollup --config rollup.config.ts --configPlugin @rollup/plugin-typescript",
|
|
@@ -119,6 +119,7 @@
|
|
|
119
119
|
"compute:sha:bundles": "npm run compute:checksums:bundles | sha256sum",
|
|
120
120
|
"doc:cba": "run-s clean:lib tsc:cba markdown:cba",
|
|
121
121
|
"doc:paydock": "run-s clean:lib tsc:paydock markdown:paydock",
|
|
122
|
+
"doc:uba": "run-s clean:lib tsc:paydock markdown:paydock",
|
|
122
123
|
"markdown:cba": "grunt cba_docs",
|
|
123
124
|
"markdown:paydock": "grunt docs",
|
|
124
125
|
"publish:local": "./publish-to-local-registry.sh",
|
|
@@ -152,7 +153,7 @@
|
|
|
152
153
|
"@babel/preset-env": "7.24.5",
|
|
153
154
|
"@babel/runtime": "7.24.5",
|
|
154
155
|
"@babel/runtime-corejs2": "7.24.5",
|
|
155
|
-
"@biomejs/biome": "
|
|
156
|
+
"@biomejs/biome": "2.2.0",
|
|
156
157
|
"@commitlint/cli": "19.5.0",
|
|
157
158
|
"@commitlint/config-conventional": "19.5.0",
|
|
158
159
|
"@golevelup/ts-vitest": "0.5.2",
|