From 2512099d6572611bb7ce9858374f3faa2ac8edd0 Mon Sep 17 00:00:00 2001 From: Atul P Date: Mon, 30 Mar 2026 15:43:15 +0530 Subject: [PATCH 1/2] docs: format explore-hyperswitch documentation - Add/update YAML frontmatter descriptions for 250 files - Fix typos and normalize formatting - Apply Juspay Hyperswitch brand name rules - Verify content integrity (all 250 files passed) --- .../account-management/README.md | 1 + .../analytics-and-operations/README.md | 6 +- .../exporting-payments-data.md | 16 ++-- .../beta-embeddable-components/README.md | 1 + .../integration-guide.md | 10 ++- .../integration-reference.md | 10 ++- .../data-migration/README.md | 3 + .../export-data-from-hyperswitch.md | 5 +- .../import-data-to-hyperswitch.md | 10 ++- .../account-management/disputes.md | 14 +-- .../account-management/manage-your-team.md | 2 +- .../multi-tenancy-with-hyperswitch.md | 8 +- .../multiple-accounts-and-profiles/README.md | 12 ++- .../account-setup.md | 8 +- .../hyperswitch-account-structure.md | 4 + .../platform-org-and-merchant-setup.md | 2 +- .../account-management/surcharge/README.md | 6 +- .../surcharge/surcharge-setup-guide.md | 4 +- explore-hyperswitch/authorizations/README.md | 1 + .../authorizations/extended-authorization.md | 4 +- .../incremental-authorization.md | 3 +- .../zero-amount-authorization-1.md | 6 +- explore-hyperswitch/connectors/README.md | 4 +- .../README.md | 13 ++- .../test-a-payment-with-connector.md | 1 + .../connectors/available-connectors/README.md | 2 +- .../connectors/available-connectors/aci.md | 6 +- .../connectors/available-connectors/adyen.md | 6 +- .../available-connectors/airwallex.md | 6 +- .../available-connectors/authorizedotnet.md | 8 +- .../available-connectors/bambora.md | 6 +- .../available-connectors/billwerk.md | 6 +- .../available-connectors/bluesnap.md | 6 +- .../connectors/available-connectors/boa.md | 6 +- .../available-connectors/braintree.md | 6 +- .../available-connectors/checkout.md | 4 +- .../available-connectors/coinbase.md | 6 +- .../cybersource/README.md | 6 +- .../cybersource/apple-pay.md | 9 +- .../cybersource/google-pay.md | 13 ++- .../connectors/available-connectors/dlocal.md | 6 +- .../connectors/available-connectors/fiserv.md | 6 +- .../available-connectors/globalpayments.md | 6 +- .../available-connectors/gocardless.md | 6 +- .../connectors/available-connectors/klarna.md | 6 +- .../connectors/available-connectors/mollie.md | 7 +- .../available-connectors/multisafepay.md | 6 +- .../available-connectors/netcetera.md | 4 +- .../connectors/available-connectors/nuvei.md | 7 +- .../available-connectors/opennode.md | 7 +- .../connectors/available-connectors/paypal.md | 7 +- .../connectors/available-connectors/payu-1.md | 6 +- .../available-connectors/prophetpay.md | 7 +- .../connectors/available-connectors/rapyd.md | 6 +- .../connectors/available-connectors/shift4.md | 6 +- .../connectors/available-connectors/stripe.md | 8 +- .../available-connectors/trustpay.md | 6 +- .../connectors/available-connectors/volt.md | 6 +- .../available-connectors/worldline.md | 6 +- .../available-connectors/worldpay.md | 6 +- .../connectors/available-connectors/zen.md | 4 +- .../payment-processor-capabilities.md | 8 +- .../connectors/payouts/README.md | 4 +- .../payouts/get-started-with-payouts.md | 4 + .../connectors/payouts/payout-link.md | 6 +- ...ess-payouts-using-saved-payment-methods.md | 6 +- ...-payout-transactions-using-smart-router.md | 1 + .../payouts/smart-retries-in-payout.md | 1 + .../connectors/split-payments/README.md | 8 +- .../split-payments/adyen-split-payments.md | 6 +- .../split-payments/stripe-split-payments.md | 4 +- .../split-payments/xendit-split-payments.md | 3 +- .../subscriptions-with-modular-payments.md | 40 ++++++++- .../e-commerce-platform-plugins/README.md | 7 +- ...alculation-for-express-checkout-wallets.md | 6 +- .../saleor-app/README.md | 4 + .../saleor-app/setup.md | 24 ++--- .../woocommerce-plugin/README.md | 4 +- .../woocommerce-plugin/compatibility.md | 4 +- .../woocommerce-plugin/faqs.md | 4 +- .../woocommerce-plugin/roadmap.md | 4 +- .../woocommerce-plugin/setup.md | 6 +- .../merchant-controls/README.md | 6 +- .../merchant-controls/integration-guide.md | 2 +- .../payment-features/3d-secure-3ds/README.md | 5 +- .../3d-secure-3ds/netcetera.md | 20 ++++- .../payment-experience/README.md | 4 +- .../payment-method/README.md | 6 +- .../payment-method/web/README.md | 1 + .../vault-sdk-js-with-rest-api-integration.md | 5 +- ...ult-sdk-react-with-rest-api-integration.md | 13 +-- .../payment-experience/payment/README.md | 5 +- .../payment-experience/payment/app-clips.md | 9 +- .../README.md | 4 + .../hyperwidget-integration-guide.md | 6 +- .../payment-experience/payment/features.md | 16 +++- .../payment/mobile/README.md | 1 + .../payment/mobile/android/customization.md | 5 ++ .../payment/mobile/android/headless.md | 4 +- .../kotlin-with-rest-api-integration.md | 16 +++- .../payment/mobile/android/lite-sdk.md | 11 ++- .../payment/mobile/android/widgets/README.md | 4 +- .../mobile/android/widgets/card-element.md | 1 + .../android/widgets/express-checkout.md | 1 + .../mobile/android/widgets/google-pay.md | 1 + .../payment/mobile/android/widgets/paypal.md | 1 + .../payment/mobile/cross-platform/README.md | 8 +- .../cross-platform/flutter/customization.md | 12 ++- .../flutter/flutter-with-node-backend.md | 13 +++ .../mobile/cross-platform/flutter/headless.md | 5 +- .../react-native/customization.md | 2 + .../react-native/expo-integration.md | 3 + .../cross-platform/react-native/headless.md | 7 +- .../react-native-with-node-backend-1.md | 5 +- .../react-native-with-rest-api-integration.md | 4 + .../mobile/cross-platform/troubleshooting.md | 4 + .../payment/mobile/ios/customization.md | 2 + .../payment/mobile/ios/headless.md | 4 +- .../payment/mobile/ios/lite-sdk.md | 7 +- .../ios/swift-with-rest-api-integration.md | 73 ++++++++++----- .../over-the-air-ota-updates/android.md | 3 + .../payment/over-the-air-ota-updates/ios.md | 3 + .../over-the-air-ota-updates/server-setup.md | 2 +- .../payment/payment-links/README.md | 5 ++ .../payment/payment-links/configurations.md | 5 ++ .../payment-links/create-payment-links.md | 3 + .../payment-links/secure-payment-links.md | 7 +- .../payment-links/setup-custom-domain.md | 4 +- .../theme-configurations-guide.md | 2 + .../payment/server-setup.md | 8 +- .../payment-experience/payment/web/README.md | 5 +- .../payment/web/customization.md | 89 ++++++++++--------- .../payment/web/headless.md | 4 +- .../web/html-with-rest-api-integration.md | 12 ++- .../web/react-with-rest-api-integration.md | 24 ++++- .../vanilla-js-and-rest-api-integration.md | 14 +++ .../wallets/samsung-pay.md | 5 +- .../payment-orchestration/README.md | 5 +- .../click-to-pay/README.md | 10 ++- .../visa-click-to-pay-v1-to-v2-migration.md | 4 +- .../quickstart/README.md | 21 +++-- .../co-badged-cards-with-hyperswitch.md | 6 +- .../quickstart/extended-authorization.md | 4 +- .../quickstart/hyperswitch-split-payments.md | 13 +-- .../quickstart/level-2-and-level-3-data.md | 20 +++-- .../quickstart/manual-capture.md | 4 +- .../quickstart/migrate-from-stripe/README.md | 19 +++- .../quickstart/migrate-from-stripe/android.md | 6 +- .../quickstart/migrate-from-stripe/ios.md | 6 +- .../migrate-from-stripe/react-native.md | 10 ++- .../quickstart/migrate-from-stripe/web.md | 10 ++- .../quickstart/overcapture.md | 3 +- .../banks/bank-debits.md | 2 + .../banks/bank-redirects.md | 4 +- .../banks/bank-transfers.md | 2 + .../banks/open-banking.md | 2 +- .../quickstart/payment-methods-setup/cards.md | 4 + .../payment-methods-setup/crypto.md | 2 +- .../payment-methods-setup/pay-later.md | 4 +- .../payment-methods-setup/test-credentials.md | 4 +- .../quickstart/payment-recipes/README.md | 3 + .../payment-recipes/use-paypal-with-stripe.md | 5 +- .../quickstart/payment-workflows.md | 6 +- .../tokenization-and-saved-cards/README.md | 15 +++- .../network-tokenisation.md | 12 +-- .../quickstart/webhooks.md | 8 +- .../payment-orchestration/smart-router.md | 4 +- .../payment-orchestration/subscriptions.md | 8 +- .../reconciliation-product/core-concepts.md | 4 + .../example-e-commerce.md | 8 +- .../exception-handling/README.md | 6 +- ...tion-strategies-for-expected-exceptions.md | 7 +- ...on-strategies-for-mismatched-exceptions.md | 6 +- .../how-reconciliation-works.md | 2 + .../merchant-and-profile-mapping-in-recon.md | 12 +-- .../reconciliation-product/services.md | 1 + .../why-we-evolved-v1-vs-v2.md | 1 + .../payments-modules/reconciliation/README.md | 2 +- .../getting-started-with-recon.md | 6 +- .../security-and-compliance/README.md | 6 +- .../gdpr-compliance.md | 6 +- .../identity-and-access-management.md | 4 +- .../security-and-compliance/pci-compliance.md | 8 +- .../security-and-compliance/security.md | 13 +-- explore-hyperswitch/wallets/README.md | 2 +- .../wallets/apple-pay/README.md | 38 ++++---- ...-processed-using-hyperswitch-decryption.md | 22 ++--- ...ons-processed-using-merchant-decryption.md | 2 - ...sactions-processed-using-psp-decryption.md | 9 +- .../wallets/apple-pay/ios-application.md | 30 ++++--- .../wallets/apple-pay/web-domain.md | 6 +- ...ch-decryption-without-apple-merchant-id.md | 8 +- ...-processed-using-hyperswitch-decryption.md | 4 +- ...sactions-processed-using-psp-decryption.md | 2 +- explore-hyperswitch/wallets/paypal.md | 2 +- explore-hyperswitch/wallets/samsung-pay.md | 9 +- .../3ds-intelligence-engine/README.md | 3 + .../get-started-with-3ds-decision-manager.md | 7 +- .../workflows/3ds-decision-manager/README.md | 1 + .../authenticate-with-3d-secure-via-psp.md | 1 + .../external-authentication-for-3ds-1.md | 9 +- .../external-authentication-for-3ds.md | 4 +- .../import-3d-secure-results.md | 2 +- ...-3ds-authentication-for-mobile-payments.md | 6 +- .../activating-frm-in-hyperswitch.md | 5 +- .../fraud-blocklist.md | 10 +-- .../workflows/intelligent-routing/README.md | 3 +- .../auth-rate-based-routing.md | 5 +- .../default-fallback-routing.md | 2 +- .../intelligent-routing/rule-based-routing.md | 2 +- .../self-deployment-guide.md | 1 + .../workflows/smart-retries/README.md | 2 - .../manual-user-triggered-retries.md | 2 +- .../processor-error-code-mapping.md | 2 - explore-hyperswitch/workflows/vault/README.md | 6 +- ...nal-vaults-to-hyperswitch-orchestration.md | 6 +- .../external-vault-sdk-+-storage/README.md | 13 +-- ...processing-payments-with-external-vault.md | 1 - .../vault/hyperswitch-sdk-+-external-vault.md | 5 +- ...witch-vault-pass-through-proxy-payments.md | 2 +- .../vault/payment-methods-management-sdk.md | 14 +-- ...as-orchestration-with-third-party-vault.md | 16 ++-- ...-with-external-or-third-party-pci-vault.md | 4 +- .../server-to-server-vault-tokenization.md | 2 + .../vault/vault-sdk-integration-1.md | 6 +- .../workflows/vault/vault-sdk-integration.md | 14 +-- 226 files changed, 1104 insertions(+), 528 deletions(-) diff --git a/explore-hyperswitch/account-management/README.md b/explore-hyperswitch/account-management/README.md index 779871b2..f2e99689 100644 --- a/explore-hyperswitch/account-management/README.md +++ b/explore-hyperswitch/account-management/README.md @@ -1,4 +1,5 @@ --- +description: Manage accounts teams analytics disputes reconciliation and multi-tenancy settings icon: joystick --- diff --git a/explore-hyperswitch/account-management/analytics-and-operations/README.md b/explore-hyperswitch/account-management/analytics-and-operations/README.md index a9daf49b..9d3ceb70 100644 --- a/explore-hyperswitch/account-management/analytics-and-operations/README.md +++ b/explore-hyperswitch/account-management/analytics-and-operations/README.md @@ -1,5 +1,5 @@ --- -description: Single dashboard for all your payment operations needs! +description: Monitor payment analytics and manage payment operations through a unified dashboard interface icon: chart-pie-simple-circle-dollar --- @@ -49,7 +49,7 @@ _Payment success rate does not include payments which are authorized by but not #### **Processed amount** -Sum of amount of all payments with status = succeeded. +Sum of amount of all payments with `status = succeeded`. _Please note that there could be payments which could be authorized but not captured. Such payments are not included in the processed amount, because non-captured payments will be be settled to your merchant account by your payment processor._ @@ -123,7 +123,7 @@ Below are some of the day-to-day use cases of payments operations across teams w Inadequate attention to payment operations might negatively impact your Net Promoter Score and impact the growth of your business. -## How could Hyperswitch simplify Payment Operations? +## How could Juspay Hyperswitch simplify Payment Operations? Hyperswitch Control Center is a single interface that all your teams will be required to use for all Payment Operations use cases. This provides more power to your team for managing payments seamlessly. diff --git a/explore-hyperswitch/account-management/analytics-and-operations/exporting-payments-data.md b/explore-hyperswitch/account-management/analytics-and-operations/exporting-payments-data.md index d84c26dc..91ae61c8 100644 --- a/explore-hyperswitch/account-management/analytics-and-operations/exporting-payments-data.md +++ b/explore-hyperswitch/account-management/analytics-and-operations/exporting-payments-data.md @@ -1,5 +1,5 @@ --- -description: Export your payments data to Redshift from Hyperswitch +description: Export payments data to Amazon Redshift for analytics and business intelligence reporting icon: tachograph-digital --- @@ -96,13 +96,13 @@ IGNOREHEADER 1 timeformat 'YYYY-MM-DD HH:MI:SS' csv; -MERGE INTO payments USING payments_stage ON payments.payment_id = payments_stage.payment_id +MERGE INTO payments USING payments_stage ON payments.`payment_id = payments_stage`.payment_id WHEN MATCHED THEN UPDATE SET -payment_id = payments_stage.payment_id, +`payment_id = payments_stage`.payment_id, attempt_id = payments_stage.attempt_id, -status = payments_stage.status, -amount = payments_stage.amount, -currency = payments_stage.currency, +`status = payments_stage`.status, +`amount = payments_stage`.amount, +`currency = payments_stage`.currency, amount_to_capture = payments_stage.amount_to_capture, customer_id = payments_stage.customer_id, created_at = payments_stage.created_at, @@ -110,8 +110,8 @@ order_details = payments_stage.order_details, connector = payments_stage.connector, error_message = payments_stage.error_message, connector_transaction_id = payments_stage.connector_transaction_id, -capture_method = payments_stage.capture_method, -authentication_type = payments_stage.authentication_type, +`capture_method = payments_stage`.capture_method, +`authentication_type = payments_stage`.authentication_type, mandate_id = payments_stage.mandate_id, payment_method = payments_stage.payment_method, payment_method_type = payments_stage.payment_method_type, diff --git a/explore-hyperswitch/account-management/beta-embeddable-components/README.md b/explore-hyperswitch/account-management/beta-embeddable-components/README.md index e4261763..3a31918d 100644 --- a/explore-hyperswitch/account-management/beta-embeddable-components/README.md +++ b/explore-hyperswitch/account-management/beta-embeddable-components/README.md @@ -1,4 +1,5 @@ --- +description: Embed white-labeled payment configuration components directly into your application icon: laptop-code --- diff --git a/explore-hyperswitch/account-management/beta-embeddable-components/integration-guide.md b/explore-hyperswitch/account-management/beta-embeddable-components/integration-guide.md index a5b548cf..1c44e519 100644 --- a/explore-hyperswitch/account-management/beta-embeddable-components/integration-guide.md +++ b/explore-hyperswitch/account-management/beta-embeddable-components/integration-guide.md @@ -1,4 +1,5 @@ --- +description: Integrate embeddable connector configuration components into your React application hidden: true --- @@ -7,7 +8,6 @@ hidden: true

This guide has now been replaced with integration-reference.md

- This SDK allows you to embed the Hyperswitch connector configuration directly into your React application. It uses a provider pattern to manage authentication sessions via JWTs, ensuring your API keys never leak to the client. Repository URL: [https://github.com/juspay/hyperswitch-control-center-embedded](https://github.com/juspay/hyperswitch-control-center-embedded) @@ -63,6 +63,7 @@ Required Headers for Hyperswitch Call: * X-profile-id: The specific profile ID you want the embedded component to access. {% code title="server.js" %} + ```javascript const express = require('express'); const cors = require('cors'); @@ -109,6 +110,7 @@ app.listen(port, () => { console.log(`Server listening at http://localhost:${port}`); }); ``` + {% endcode %} ### Step 3: Frontend Integration (React) @@ -140,6 +142,7 @@ Key Concept: The fetchToken function is "lazy." It is called: 2. Automatically whenever the SDK detects the session has expired (auto-refresh). {% code title="app.js" %} + ```javascript function App() { const [errorMessage, setErrorMessage] = useState(null); @@ -217,11 +220,12 @@ function App() { export default App; ``` + {% endcode %} ### API Reference -#### loadHyperswitch(options) +#### loadJuspay Hyperswitch(options) Initializes the SDK logic. @@ -230,7 +234,7 @@ Initializes the SDK logic. * Should return the JWT string on success. * Should return `undefined` on failure. -#### \ +#### \ Context provider that holds the authentication state. diff --git a/explore-hyperswitch/account-management/beta-embeddable-components/integration-reference.md b/explore-hyperswitch/account-management/beta-embeddable-components/integration-reference.md index 52db16ca..b2bbf263 100644 --- a/explore-hyperswitch/account-management/beta-embeddable-components/integration-reference.md +++ b/explore-hyperswitch/account-management/beta-embeddable-components/integration-reference.md @@ -1,3 +1,7 @@ +--- +description: Reference guide for embedding Juspay Hyperswitch connector configuration in React and HTML apps +--- + # Integration Reference This SDK allows you to embed the Hyperswitch connector configuration directly into your React application. It uses a provider pattern to manage authentication sessions via JWTs, ensuring your API keys never leak to the client. @@ -37,6 +41,7 @@ Required Headers for Hyperswitch Call: * X-profile-id: The specific profile ID you want the embedded component to access. {% code title="server.js" %} + ```javascript const express = require('express'); const cors = require('cors'); @@ -86,6 +91,7 @@ app.listen(port, () => { }); ``` + {% endcode %} ### Step 2: Choose Your Integration Method @@ -259,7 +265,7 @@ export default App; ### API Reference -#### 1. loadHyperswitch(options) +#### 1. loadJuspay Hyperswitch(options) Initializes the SDK logic. @@ -270,7 +276,7 @@ options.fetchToken () => Promise\ * Should return the JWT string on success. * Should return undefined on failure. -#### 2. HyperswitchProvider +#### 2. Juspay HyperswitchProvider Context provider that holds the authentication state. diff --git a/explore-hyperswitch/account-management/data-migration/README.md b/explore-hyperswitch/account-management/data-migration/README.md index d718f6e4..7980e3b6 100644 --- a/explore-hyperswitch/account-management/data-migration/README.md +++ b/explore-hyperswitch/account-management/data-migration/README.md @@ -1,4 +1,5 @@ --- +description: Migrate payment data securely between Juspay Hyperswitch and other payment processors icon: utility-pole-double --- @@ -11,6 +12,8 @@ Migration of data is a crucial step in ensuring business continuity without any
Import data to Hyperswitchimport-data-to-hyperswitch.md
Export data from Hyperswitchexport-data-from-hyperswitch.md
{% hint style="info" %} + Kindly reach out to [hyperswitch@juspay.in](mailto:hyperswitch@juspay.in) to initiate your data migration request. + {% endhint %} diff --git a/explore-hyperswitch/account-management/data-migration/export-data-from-hyperswitch.md b/explore-hyperswitch/account-management/data-migration/export-data-from-hyperswitch.md index 5b05388f..fa28ed62 100644 --- a/explore-hyperswitch/account-management/data-migration/export-data-from-hyperswitch.md +++ b/explore-hyperswitch/account-management/data-migration/export-data-from-hyperswitch.md @@ -1,13 +1,16 @@ --- +description: Export your payment data securely to another PCI-compliant payment processor icon: left-from-bracket --- -# Export data from Hyperswitch +# Export data from Juspay Hyperswitch We believe customers fully own their data. If you decide to export data from Hyperswitch, we will work with your new payment service provider to safely export your data. {% hint style="info" %} + To meet PCI compliance requirements, Hyperswitch can export data only to a PCI-DSS compliant payment processor. Kindly request your new payment processor’s PCI Attestation of Compliance (AoC) certificate, and share it to [hyperswitch@juspay.in](mailto:hyperswitch@juspay.in) while requesting your data export. + {% endhint %} ### Performing the export process: diff --git a/explore-hyperswitch/account-management/data-migration/import-data-to-hyperswitch.md b/explore-hyperswitch/account-management/data-migration/import-data-to-hyperswitch.md index e77c1e47..3c7beec7 100644 --- a/explore-hyperswitch/account-management/data-migration/import-data-to-hyperswitch.md +++ b/explore-hyperswitch/account-management/data-migration/import-data-to-hyperswitch.md @@ -1,8 +1,9 @@ --- +description: Import payment data from your current processor to Juspay Hyperswitch securely icon: right-from-bracket --- -# Import data to Hyperswitch +# Import data to Juspay Hyperswitch We help you with smooth migration from your current payment processor, ensuring uninterrupted business operations. @@ -25,7 +26,7 @@ The CSV file for import should be formatted in accordance with the following req * Delimit rows by a single newline character `\n (not \r\n)`. * Delimit columns by `,` * Leave empty fields entirely empty (no character in between delimiters). You must not denote a missing field with NULL, N/A, or any other value. -* Fields can’t contain comma, newline characters `(\r or \n or ,)` within a field. +* Fields can’t contain comma, newline characters `(\r or \n or,)` within a field. * Example of what to avoid: `1st Ave\nApt 1` * All rows must have the same number of columns. * Field names and values are case-sensitive. @@ -47,7 +48,7 @@ The CSV file for import should be formatted in accordance with the following req ### Optional fields: -Note: Billing details are mandatorily required if AVS (Address verification Service) check is enabled. +> **Note:** Billing details are mandatorily required if AVS (Address verification Service) check is enabled. | **Field** | **Description** | | ----------------------------- | ------------------------------------------------------------- | @@ -69,5 +70,8 @@ Note: Billing details are mandatorily required if AVS (Address verification Serv | billing\_address\_country | Country of the billing address | {% hint style="info" %} + To import other payment methods like SEPA, ACH, Paypal, Klarna, kindly reach out to [hyperswitch@juspay.in](mailto:hyperswitch@juspay.in) + {% endhint %} + diff --git a/explore-hyperswitch/account-management/disputes.md b/explore-hyperswitch/account-management/disputes.md index a46ddbf8..fce02a06 100644 --- a/explore-hyperswitch/account-management/disputes.md +++ b/explore-hyperswitch/account-management/disputes.md @@ -1,7 +1,5 @@ --- -description: >- - Use Hyperswitch's unified Disputes module to track and manage disputes across - multiple processors +description: Track and manage payment disputes and chargebacks across multiple processors icon: circle-exclamation --- @@ -12,7 +10,9 @@ icon: circle-exclamation A dispute occurs when a customer contacts their payment method issuer (card issuer/bank/wallet) to question or challenge a particular transaction so that the payment can be reversed. {% hint style="info" %} + When a card payment is reversed, and the processor debits the merchant's account, it's termed a 'chargeback.' Hyperswitch uses the term 'Disputes' interchangeably to refer to 'Chargebacks' in the context of card payments. + {% endhint %} The merchants receive notifications from their payment processor when a dispute is raised by their customers against a payment made at their site. @@ -23,7 +23,7 @@ Each processor has their own standards or processes around how they notify about Hyperswitch unifies all the dispute notifications from all your different processors and makes it easier for you to track, accept and as well as challenge them by uploading evidences across different processors from one place. -## Disputes Lifecycle on Hyperswitch +## Disputes Lifecycle on Juspay Hyperswitch Hyperswitch's unified disputes module uses the following stages and statuses to track your disputes: @@ -43,15 +43,15 @@ In most cases, the processors directly debit your account while reversing the pa For transactions that go through 'Pre-Dispute' stage, they will end up moving to 'Dispute' stage if the merchant's evidence was deemed not satisfactory. -
dispute_statedescription
OpenedOccurs when a dispute is opened and your processor has debited your account
ChallengedOccurs when a merchant uploads an evidence to support their case
ExpiredOccurs when a merchant doesn't respond in time interval before which an issuer expects a response after the dispute was opened
CancelledOccurs when a customer withdraws their challenge
AcceptedOccurs when a merchant accepts a dispute as valid
WonOccurs when the merchant's challenge was accepted successfully. Known as 'chargeback reversal' in cases of card payments
LostOccurs when a merchant's challenge was deemed not satisfctory
+
dispute_statedescription
OpenedOccurs when a dispute is opened and your processor has debited your account
ChallengedOccurs when a merchant uploads an evidence to support their case
ExpiredOccurs when a merchant doesn't respond in time interval before which an issuer expects a response after the dispute was opened
CancelledOccurs when a customer withdraws their challenge
AcceptedOccurs when a merchant accepts a dispute as valid
WonOccurs when the merchant's challenge was accepted successfully. Known as 'chargeback reversal' in cases of card payments
LostOccurs when a merchant's challenge was deemed not satisfactory
### Pre-Arbitration stage Even after a successful dispute challenge, a payment method issuer might deem the evidence 'not satisfactory' and raise another review appeal. Such payments transition to 'Pre-Arbitration' stage. -
dispute_statedescription
OpenedOccurs when the issuer opens a review appeal after deeming the evidence unsatisfactory
WonOccurs when the merchant is successful in the pre-arbitration appeal prcoess
LostOccurs when the merchant loses during the pre-arbitration appeal. Also, known as 'second_chargeback'
+
dispute_statedescription
OpenedOccurs when the issuer opens a review appeal after deeming the evidence unsatisfactory
WonOccurs when the merchant is successful in the pre-arbitration appeal process
LostOccurs when the merchant loses during the pre-arbitration appeal. Also, known as 'second_chargeback'
-## Managing Disputes on Hyperswitch through Dashboard +## Managing Disputes on Juspay Hyperswitch through Dashboard ### 1. Viewing Disputes on Hyperswitch dashboard diff --git a/explore-hyperswitch/account-management/manage-your-team.md b/explore-hyperswitch/account-management/manage-your-team.md index 2d17b638..57d61c83 100644 --- a/explore-hyperswitch/account-management/manage-your-team.md +++ b/explore-hyperswitch/account-management/manage-your-team.md @@ -1,5 +1,5 @@ --- -description: Assign roles and permission to users +description: Invite users and assign roles with specific permissions for your payment operations team icon: screen-users --- diff --git a/explore-hyperswitch/account-management/multi-tenancy-with-hyperswitch.md b/explore-hyperswitch/account-management/multi-tenancy-with-hyperswitch.md index bc309c77..4d222297 100644 --- a/explore-hyperswitch/account-management/multi-tenancy-with-hyperswitch.md +++ b/explore-hyperswitch/account-management/multi-tenancy-with-hyperswitch.md @@ -1,4 +1,5 @@ --- +description: Configure multi-tenant architecture to serve multiple merchants from a single instance icon: cubes-stacked --- @@ -12,7 +13,7 @@ Each tenant operates in a logically isolated environment but shares the underlyi
-## Benefits of Multi-tenancy with Hyperswitch +## Benefits of Multi-tenancy with Juspay Hyperswitch 1. **Configuration Options**: Hyperswitch provides configurable settings that allow tenants to customise the look and feel of the application, such as - * Branding (logo, colors, themes) @@ -28,7 +29,7 @@ Each tenant operates in a logically isolated environment but shares the underlyi 5. **Documentation and Support**: Tenants can have their own version of developer docs white-listed on their hosts. Comprehensive documentation, tutorials, and support resources are provided to help tenants understand how to onboard and integrate merchants. This includes documentation for APIs, SDKs, best practices, and troubleshooting guides. 6. **Tenant <> Merchant Communication** - Based on tenant's requirements, Hyperswitch can trigger SMS and Email notification on behalf of the tenant to the customers and merchants by integrating with their service provider. -## Hierarchy of Entities in Hyperswitch +## Hierarchy of Entities in Juspay Hyperswitch A tenant’s scope will include multiple organizations and their associated entities, such as merchant accounts, business profiles, and other hierarchical elements lower in the structure. Each tenant would have tenant admins who can create organizations under the scope of that tenant. @@ -47,5 +48,8 @@ Each tenant onboarded on Hyperswitch will have white-labeled links for the follo Once these white-labeled endpoints are available, tenants will be onboarded on Dashboard. Link to set credentials will be sent via email. Post logging in to Dashboard, tenants can onboard merchants. {% content-ref url="../payment-orchestration/" %} + [payment-orchestration](../payment-orchestration/) + {% endcontent-ref %} + diff --git a/explore-hyperswitch/account-management/multiple-accounts-and-profiles/README.md b/explore-hyperswitch/account-management/multiple-accounts-and-profiles/README.md index a0ae2693..77c5e6a7 100644 --- a/explore-hyperswitch/account-management/multiple-accounts-and-profiles/README.md +++ b/explore-hyperswitch/account-management/multiple-accounts-and-profiles/README.md @@ -1,14 +1,14 @@ --- -description: >- - Create multiple merchant accounts, profiles and users for seamless integration - with your business. +description: Create multiple merchant accounts and profiles for organizing your payment operations icon: file-user --- # Managing Accounts and Profiles {% hint style="warning" %} + If there are more than one `business_profiles` for a merchant account, then passing `profile_id` when creating a payment is mandatory. + {% endhint %} **Hyperswitch architecture supports:** @@ -42,7 +42,9 @@ A merchant account is associated with an `api_key` and `publishable_key` which i #### Profile {% hint style="info" %} + Every merchant account has at least one profile. For easier integration,`profile_id` is not mandatory if there is only one business profile. + {% endhint %} A profile can also be considered to be a business profile for practical purposes, it serves as a logical separation of businesses for seamless integration and onboarding. Every business profile is uniquely identified by a `profile_id`. All the payment settings can be configured at the profile level and will apply to all the payments make via the business profile. If there is more then one business profile, then `profile_id` has to be passed when creating the payments. Business profile allows to configure @@ -68,7 +70,6 @@ A processor created under one business profile cannot be used in another busine * #### Multiple merchant accounts - for **merchants who need different API keys for each of their businesses** - Consider a merchant A who has three different businesses - A\_Shoes, A\_Clothing, A\_Bags. They can create three merchant accounts (Shoes, Clothing, Bags) on Hyperswitch and get separate set of API keys for each of them.

A merchant with multiple merchant accounts and a single business profile in each merchant account

@@ -118,5 +119,8 @@ When a payment is created under a business profile, it would use the routing alg ### For the Platform Org and Merchant architecture, refer to the page below. {% content-ref url="platform-org-and-merchant-setup.md" %} + [platform-org-and-merchant-setup.md](platform-org-and-merchant-setup.md) + {% endcontent-ref %} + diff --git a/explore-hyperswitch/account-management/multiple-accounts-and-profiles/account-setup.md b/explore-hyperswitch/account-management/multiple-accounts-and-profiles/account-setup.md index b83d7f8b..fb9f1f74 100644 --- a/explore-hyperswitch/account-management/multiple-accounts-and-profiles/account-setup.md +++ b/explore-hyperswitch/account-management/multiple-accounts-and-profiles/account-setup.md @@ -1,5 +1,5 @@ --- -description: Set up your Hyperswitch account on the control center +description: Set up your Hyperswitch control center account with API keys and payment processors --- # ⚙️ Control Centre Account setup @@ -22,7 +22,9 @@ On the left nav bar, click on your email on the bottom to access the profile sec ## Pre-Requisites {% hint style="info" %} + Ensure you have easy access to essential information such as API keys and secrets necessary for connecting to your chosen processor. Additionally, have a well-defined plan in place for configuring routing settings, if applicable. + {% endhint %} ## Create an API key @@ -36,9 +38,11 @@ Click on create API key from the page. A pop-up appears where you have to enter An API key will be created and you will get the option to download and copy the API key. {% hint style="info" %} + Ensure that you download or copy the API key as it will be available only once through the dashboard for security reasons. In case you miss this, please create another API key. You can use the Hyperswitch Dashboard to reveal, revoke, and create secret API keys. If you’re setting up Hyperswitch through a third-party platform (3PP), reveal your API keys in live mode to begin processing payments + {% endhint %} ## Add a payment processor @@ -99,7 +103,9 @@ The following key fields can be customized to align the dashboard with the merch These UI customizations are scalable and can be extended upon merchant request. {% content-ref url="../../merchant-controls/integration-guide.md" %} + [integration-guide.md](../../merchant-controls/integration-guide.md) + {% endcontent-ref %} You can also refer to the [Smart Router](../../payment-orchestration/smart-router.md) section to learn more about how you can route your payments and then later you can [Test a Payment](../../../hyperswitch-open-source/account-setup/test-a-payment.md). diff --git a/explore-hyperswitch/account-management/multiple-accounts-and-profiles/hyperswitch-account-structure.md b/explore-hyperswitch/account-management/multiple-accounts-and-profiles/hyperswitch-account-structure.md index a30df0c0..0df3bb73 100644 --- a/explore-hyperswitch/account-management/multiple-accounts-and-profiles/hyperswitch-account-structure.md +++ b/explore-hyperswitch/account-management/multiple-accounts-and-profiles/hyperswitch-account-structure.md @@ -1,4 +1,5 @@ --- +description: Configure organization merchant and profile hierarchy for your payment infrastructure icon: people-roof --- @@ -43,5 +44,8 @@ Once a user signs up on the Hyperswitch Control Centre, they need to create an o
{% content-ref url="./" %} + [.](./) + {% endcontent-ref %} + diff --git a/explore-hyperswitch/account-management/multiple-accounts-and-profiles/platform-org-and-merchant-setup.md b/explore-hyperswitch/account-management/multiple-accounts-and-profiles/platform-org-and-merchant-setup.md index 9d978844..0f438841 100644 --- a/explore-hyperswitch/account-management/multiple-accounts-and-profiles/platform-org-and-merchant-setup.md +++ b/explore-hyperswitch/account-management/multiple-accounts-and-profiles/platform-org-and-merchant-setup.md @@ -1,5 +1,5 @@ --- -description: Platform Organization Setup & Workflow +description: Set up platform organization to programmatically onboard and manage multiple merchants icon: garage-car --- diff --git a/explore-hyperswitch/account-management/surcharge/README.md b/explore-hyperswitch/account-management/surcharge/README.md index 5d858597..8b2ab210 100644 --- a/explore-hyperswitch/account-management/surcharge/README.md +++ b/explore-hyperswitch/account-management/surcharge/README.md @@ -1,5 +1,5 @@ --- -description: Configure advanced rules with various payment parameters +description: Configure surcharge rules based on payment amount currency and method icon: clipboard-list-check --- @@ -14,7 +14,6 @@ A surcharge, sometimes called a checkout fee or service fee, is an additional fe ## How does it work? -
Hyperswitch supports surcharge for most payment processors and you can configure surcharge through two ways: @@ -36,5 +35,8 @@ Surcharge can be applied to a payment using `surcharge_details` field in [paymen To test the Surcharge Manager, after activating the rule, we can make a Test Payment using the [Hyperswitch Dashboard ](https://app.hyperswitch.io/sdk) {% content-ref url="../../../hyperswitch-open-source/account-setup/test-a-payment.md" %} + [test-a-payment.md](../../../hyperswitch-open-source/account-setup/test-a-payment.md) + {% endcontent-ref %} + diff --git a/explore-hyperswitch/account-management/surcharge/surcharge-setup-guide.md b/explore-hyperswitch/account-management/surcharge/surcharge-setup-guide.md index ec3a3281..1b07bcb2 100644 --- a/explore-hyperswitch/account-management/surcharge/surcharge-setup-guide.md +++ b/explore-hyperswitch/account-management/surcharge/surcharge-setup-guide.md @@ -1,11 +1,13 @@ --- -description: Surcharge Manager Setup +description: Set up surcharge rules using the Hyperswitch Control Center --- # Surcharge Setup guide {% hint style="info" %} + This section covers the steps to setup surcharge manager using the Hyperswitch Control Center + {% endhint %} ## Steps to setup a rule on Surcharge Manager? diff --git a/explore-hyperswitch/authorizations/README.md b/explore-hyperswitch/authorizations/README.md index 8db3f040..47221022 100644 --- a/explore-hyperswitch/authorizations/README.md +++ b/explore-hyperswitch/authorizations/README.md @@ -1,4 +1,5 @@ --- +description: Explore advanced authorization types including zero amount estimate and incremental icon: building-magnifying-glass --- diff --git a/explore-hyperswitch/authorizations/extended-authorization.md b/explore-hyperswitch/authorizations/extended-authorization.md index 8d12e2d0..7752437a 100644 --- a/explore-hyperswitch/authorizations/extended-authorization.md +++ b/explore-hyperswitch/authorizations/extended-authorization.md @@ -1,4 +1,5 @@ --- +description: Extend authorization hold periods beyond standard windows for flexible capture timing icon: square-tenge --- @@ -101,9 +102,10 @@ Currently, manual extended authorization is supported for: Calling this endpoint will initiate an extended authorization request. The actual behavior, including how much the capture or honor period is extended, depends on the specific connector and the issuing bank. {% hint style="info" %} + Be aware: With some connectors like Adyen, a failed extended authorization attempt may also cause the initial authorization to fail. -{% endhint %} +{% endhint %} > **⚠️ Note:** diff --git a/explore-hyperswitch/authorizations/incremental-authorization.md b/explore-hyperswitch/authorizations/incremental-authorization.md index accaa8f6..504871ac 100644 --- a/explore-hyperswitch/authorizations/incremental-authorization.md +++ b/explore-hyperswitch/authorizations/incremental-authorization.md @@ -1,4 +1,5 @@ --- +description: Increase authorized amounts after initial authorization for variable cost scenarios icon: arrow-up-right-dots --- @@ -25,7 +26,7 @@ Incremental authorization can help businesses to fulfill the following use-cases 1. Ensure that your business operates in a region without Strong Customer Authentication (SCA) requirements, as incremental authorizations are only possible in such environments. 2. This feature is limited to card payments and specific networks, with rules that vary depending on the payment connector used. -### How to use Incremental Authorization through Hyperswitch? +### How to use Incremental Authorization through Juspay Hyperswitch? **Step 1:** To use Incremental authorization you can set the value of the [request\_incremental\_authorization](https://api-reference.hyperswitch.io/api-reference/payments/payments--create) field to true in the payments/create API call. diff --git a/explore-hyperswitch/authorizations/zero-amount-authorization-1.md b/explore-hyperswitch/authorizations/zero-amount-authorization-1.md index ed53264e..7978dcf6 100644 --- a/explore-hyperswitch/authorizations/zero-amount-authorization-1.md +++ b/explore-hyperswitch/authorizations/zero-amount-authorization-1.md @@ -1,12 +1,14 @@ --- -description: Best way to validate customer payment data and charge the customer later +description: Validate customer payment methods and charge customers later using stored credentials icon: circle-0 --- # Zero Amount Authorization {% hint style="info" %} + In this section, we will understand zero-auth flow, it's usage, and webhook consumption + {% endhint %} The zero amount authorization flow in Hyperswitch allows the merchant to validate customer payment data and charge the customer later. On customer registration, the merchant can initiate a zero-auth flow transaction with Hyperswitch to authenticate the customer payment method (card, bank account etc.) and receive authorization from the customer to use the payment method to charge them at a later point. A payment\_method\_id would be created and issued to the merchant. And in the future they can charge against this payment\_method\_id. @@ -38,7 +40,7 @@ curl --location 'http://sandbox.hyperswitch.io/payments' \ ``` -2. Confirm the payment after collecting payment information from the user **\[You can skip this step if you are using the Hyperswitch Unified Checkout]** +2. Confirm the payment after collecting payment information from the user **[You can skip this step if you are using the Hyperswitch Unified Checkout]**
curl --location 'http://http://sandbox.hyperswitch.io/payments/{{payment_id}}/confirm' \
 --header 'Content-Type: application/json' \
diff --git a/explore-hyperswitch/connectors/README.md b/explore-hyperswitch/connectors/README.md
index e1534fbe..3e6517ae 100644
--- a/explore-hyperswitch/connectors/README.md
+++ b/explore-hyperswitch/connectors/README.md
@@ -1,7 +1,5 @@
 ---
-description: >-
-  Integrate with more than 200+ Connectors enabling 150+ payment methods with
-  zero development effort.
+description: Integrate with 200 plus connectors enabling 150 plus payment methods
 icon: plug
 ---
 
diff --git a/explore-hyperswitch/connectors/activate-connector-on-hyperswitch/README.md b/explore-hyperswitch/connectors/activate-connector-on-hyperswitch/README.md
index e8ff9515..2574ce02 100644
--- a/explore-hyperswitch/connectors/activate-connector-on-hyperswitch/README.md
+++ b/explore-hyperswitch/connectors/activate-connector-on-hyperswitch/README.md
@@ -1,9 +1,9 @@
 ---
-description: Configure your preferred connector on Hyperswitch
+description: Activate and configure payment connectors on the Hyperswitch Control Center
 icon: chart-network
 ---
 
-# Activate Connector on Hyperswitch
+# Activate Connector on Juspay Hyperswitch
 
 ### Steps to activate connector on the Hyperswitch Control Center
 
@@ -31,20 +31,24 @@ icon: chart-network
     * Choose the payment methods for the demo checkout.
 
     
-5. **Configure webhooks \[Optional]** +5. **Configure webhooks [Optional]** * If the selected connector supports webhooks, copy the URL from control center and configure it in the connector dashboard.
{% content-ref url="test-a-payment-with-connector.md" %} + [test-a-payment-with-connector.md](test-a-payment-with-connector.md) + {% endcontent-ref %} ### Edit connector credentials on the Hyperswitch Control Center {% hint style="warning" %} + To update connector credentials on Hyperswitch you will need to re-enter all the fields required for credentials. + {% endhint %} To update the credentials on the Hyperswitch Control Centre, You can follow the following steps - @@ -64,5 +68,8 @@ To update the credentials on the Hyperswitch Control Centre, You can follow the
{% content-ref url="test-a-payment-with-connector.md" %} + [test-a-payment-with-connector.md](test-a-payment-with-connector.md) + {% endcontent-ref %} + diff --git a/explore-hyperswitch/connectors/activate-connector-on-hyperswitch/test-a-payment-with-connector.md b/explore-hyperswitch/connectors/activate-connector-on-hyperswitch/test-a-payment-with-connector.md index 25e9e835..61024c03 100644 --- a/explore-hyperswitch/connectors/activate-connector-on-hyperswitch/test-a-payment-with-connector.md +++ b/explore-hyperswitch/connectors/activate-connector-on-hyperswitch/test-a-payment-with-connector.md @@ -1,4 +1,5 @@ --- +description: Test your connector configuration using the Hyperswitch dashboard icon: vial-circle-check --- diff --git a/explore-hyperswitch/connectors/available-connectors/README.md b/explore-hyperswitch/connectors/available-connectors/README.md index e18d3f14..283ba740 100644 --- a/explore-hyperswitch/connectors/available-connectors/README.md +++ b/explore-hyperswitch/connectors/available-connectors/README.md @@ -1,5 +1,5 @@ --- -description: List of all connectors currently supported by Hyperswitch +description: Browse all payment processors and connectors supported by Juspay Hyperswitch hidden: true icon: badge-check --- diff --git a/explore-hyperswitch/connectors/available-connectors/aci.md b/explore-hyperswitch/connectors/available-connectors/aci.md index 47e2d1a3..811c07b6 100644 --- a/explore-hyperswitch/connectors/available-connectors/aci.md +++ b/explore-hyperswitch/connectors/available-connectors/aci.md @@ -1,19 +1,21 @@ --- -description: Accept payments through Aci via Hyperswitch +description: Accept payments through Aci via Juspay Hyperswitch hidden: true --- # ACI {% hint style="info" %} + This section gives you an overview of how to make payments via ACI through Hyperswitch + {% endhint %} ![](https://hyperswitch.io/icons/homePageIcons/logos/ACILogo.svg) ACI Worldwide enables corporations to process and manage digital payments, power omni-commerce payments, present and process bill payments, and manage fraud and risk. To know about more about payment methods supported by ACI via hyperswitch visit [here](https://hyperswitch.io/pm-list). -### Activating ACI via Hyperswitch +### Activating ACI via Juspay Hyperswitch #### Prerequisites diff --git a/explore-hyperswitch/connectors/available-connectors/adyen.md b/explore-hyperswitch/connectors/available-connectors/adyen.md index cbe48e58..77de0658 100644 --- a/explore-hyperswitch/connectors/available-connectors/adyen.md +++ b/explore-hyperswitch/connectors/available-connectors/adyen.md @@ -1,11 +1,13 @@ --- -description: Accept payments through Adyen via Hyperswitch +description: Accept payments through Adyen via Juspay Hyperswitch --- # Adyen {% hint style="info" %} + This section gives you an overview of how to make payments via Adyen through Hyperswitch + {% endhint %} \ @@ -13,7 +15,7 @@ This section gives you an overview of how to make payments via Adyen through Hyp Adyen is a global payments company allowing businesses to accept payments on a global scale. It offers a variety of local and international payment methods. To know about more about payment methods supported by adyen via hyperswitch visit [here](https://hyperswitch.io/pm-list). -### Activating Adyen via Hyperswitch +### Activating Adyen via Juspay Hyperswitch #### I. Prerequisites diff --git a/explore-hyperswitch/connectors/available-connectors/airwallex.md b/explore-hyperswitch/connectors/available-connectors/airwallex.md index 4c2b346b..d38f8e6f 100644 --- a/explore-hyperswitch/connectors/available-connectors/airwallex.md +++ b/explore-hyperswitch/connectors/available-connectors/airwallex.md @@ -1,19 +1,17 @@ --- -description: Accept payments through Airwallex via Hyperswitch +description: Accept payments through Airwallex via Juspay Hyperswitch configuration and setup hidden: true --- # Airwallex - ![logo\_discord](https://hyperswitch.io/icons/homePageIcons/logos/airwallexLogo.svg) - Airwallex is a financial technology company that provides businesses with global payment solutions, including cross-border payments, foreign exchange, and risk management, with easy integration.To know about more about payment methods supported by Airwallex via hyperswitch visit [here](https://hyperswitch.io/pm-list). -### Activating Airwallex via Hyperswitch +### Activating Airwallex via Juspay Hyperswitch #### Prerequisites diff --git a/explore-hyperswitch/connectors/available-connectors/authorizedotnet.md b/explore-hyperswitch/connectors/available-connectors/authorizedotnet.md index 57c49464..46fc5857 100644 --- a/explore-hyperswitch/connectors/available-connectors/authorizedotnet.md +++ b/explore-hyperswitch/connectors/available-connectors/authorizedotnet.md @@ -1,23 +1,25 @@ --- -description: Accept payments through Authorizedotnet via Hyperswitch +description: Accept payments through Authorize.net via Juspay Hyperswitch configuration and setup hidden: true --- # Authorizedotnet {% hint style="info" %} + This section gives you an overview of how to make payments via Authorizedotnet through Hyperswitch + {% endhint %} Authorizedotnet, a Visa solution, is a US-based payment gateway service provider, allowing merchants to accept credit card and electronic check payments through their website and online. To know about more about payment methods supported by Authorizedotnet via hyperswitch visit [here](https://hyperswitch.io/pm-list). -### Activating Authorizedotnet via Hyperswitch +### Activating Authorizedotnet via Juspay Hyperswitch ### Prerequisites 1. You need to be registered with Authorizedotnet in order to proceed. In case you aren't, you can quickly setup your Authorizedotnet account [here](https://www.authorize.net/) 2. You should have registered and completed settings on [Hyperswitch Control center](https://hyperswitch.io/contact-sales). -3. The Authorizedotnet **API Login ID** and **Transaction Key**. can be found in your Authorizedotnet dashboard under the Account section (Security settings) . +3. The Authorizedotnet **API Login ID** and **Transaction Key**. can be found in your Authorizedotnet dashboard under the Account section (Security settings). 4. Choose the payment methods you want to utilize with Authorize.net by navigating to Account -> Digital Payment Solutions in the Authorize.net dashboard. [Steps](https://docs.hyperswitch.io/hyperswitch-cloud/connectors/activate-connector-on-hyperswitch) to activate Authorizedotnet on Hyperswitch control center. diff --git a/explore-hyperswitch/connectors/available-connectors/bambora.md b/explore-hyperswitch/connectors/available-connectors/bambora.md index 7d7ad8d8..2440cfbc 100644 --- a/explore-hyperswitch/connectors/available-connectors/bambora.md +++ b/explore-hyperswitch/connectors/available-connectors/bambora.md @@ -1,19 +1,21 @@ --- -description: Accept payments through Bambora via Hyperswitch +description: Accept payments through Bambora via Juspay Hyperswitch configuration and setup hidden: true --- # Bambora {% hint style="info" %} + This section gives you an overview of how to make payments via Bambora through Hyperswitch + {% endhint %} ![logo\_bambora](https://hyperswitch.io/icons/homePageIcons/logos/bamboraLogo.svg) Bambora, a Worldline solution, design and operate leading digital payment and transactional solutions that enable sustainable economic growth and reinforce trust and security. To know about more about payment methods supported by Bambora via hyperswitch click [here](https://hyperswitch.io/pm-list). -### Activating Bambora via Hyperswitch +### Activating Bambora via Juspay Hyperswitch #### I. Prerequisites diff --git a/explore-hyperswitch/connectors/available-connectors/billwerk.md b/explore-hyperswitch/connectors/available-connectors/billwerk.md index e2768efc..1b8e1636 100644 --- a/explore-hyperswitch/connectors/available-connectors/billwerk.md +++ b/explore-hyperswitch/connectors/available-connectors/billwerk.md @@ -1,12 +1,14 @@ --- -description: Accept payments through Billwerk via Hyperswitch +description: Accept payments through Billwerk via Juspay Hyperswitch configuration and setup hidden: true --- # Billwerk {% hint style="info" %} + This section gives you an overview of how to make payments via Billwerk through Hyperswitch + {% endhint %}
@@ -15,7 +17,7 @@ This section gives you an overview of how to make payments via Billwerk through Billwerk+ Pay is an acquirer independent payment gateway that helps you get the best acquirer rates, select a wide variety of payment methods. To know about more about payment methods supported by Billwerk+ Pay via hyperswitch visit [here](https://hyperswitch.io/pm-list). -### Activating Billwerk+ Pay via Hyperswitch +### Activating Billwerk+ Pay via Juspay Hyperswitch #### Prerequisites diff --git a/explore-hyperswitch/connectors/available-connectors/bluesnap.md b/explore-hyperswitch/connectors/available-connectors/bluesnap.md index aa7f6531..2669ecec 100644 --- a/explore-hyperswitch/connectors/available-connectors/bluesnap.md +++ b/explore-hyperswitch/connectors/available-connectors/bluesnap.md @@ -1,19 +1,21 @@ --- -description: Accept payments through Bluesnap via Hyperswitch +description: Accept payments through Bluesnap via Juspay Hyperswitch configuration and setup hidden: true --- # Bluesnap {% hint style="info" %} + This section gives you an overview of how to make payments via Bluesnap through Hyperswitch + {% endhint %} ![BlueSnap Logos](https://cdn2.hubspot.net/hubfs/454819/blog-files/Logo_color.png) BlueSnap is a payment platform that allows businesses to easily accept online and mobile payments across the world. BlueSnap payment gateway integration can accept payments for e-commerce transactions, subscription billing models, and other online payment businesses need. To know about more about payment methods supported by Bluesanp via hyperswitch visit [here](https://hyperswitch.io/pm-list). -### Activating Bluesnap via Hyperswitch +### Activating Bluesnap via Juspay Hyperswitch #### Prerequisites diff --git a/explore-hyperswitch/connectors/available-connectors/boa.md b/explore-hyperswitch/connectors/available-connectors/boa.md index 4c77634a..1f38c918 100644 --- a/explore-hyperswitch/connectors/available-connectors/boa.md +++ b/explore-hyperswitch/connectors/available-connectors/boa.md @@ -1,19 +1,21 @@ --- -description: Accept payments through Bank of America via Hyperswitch +description: Accept payments through Bank of America via Juspay Hyperswitch configuration and setup hidden: true --- # Bank of America {% hint style="info" %} + This section gives you an overview of how to make payments via BOA through Hyperswitch + {% endhint %} ![logo\_bambora](../../../../../.gitbook/assets/Bank_of_America-Logo.wine.png) The Bank of America Corporation is an American multinational investment bank and financial services holding company headquartered at the Bank of America Corporate Center in Charlotte, North Carolina, with investment banking and auxiliary headquarters in Manhattan. To know more about payment methods supported by BOA via Hyperswitch click [here](https://hyperswitch.io/pm-list). -### Activating BOA via Hyperswitch +### Activating BOA via Juspay Hyperswitch #### I. Prerequisites diff --git a/explore-hyperswitch/connectors/available-connectors/braintree.md b/explore-hyperswitch/connectors/available-connectors/braintree.md index 9f53c578..4ba80bcb 100644 --- a/explore-hyperswitch/connectors/available-connectors/braintree.md +++ b/explore-hyperswitch/connectors/available-connectors/braintree.md @@ -1,19 +1,21 @@ --- -description: Accept payments through Braintree via Hyperswitch +description: Accept payments through Braintree via Juspay Hyperswitch configuration and setup hidden: true --- # Braintree {% hint style="info" %} + This section gives you an overview of how to make payments via Bluesnap through Hyperswitch + {% endhint %} ## About Braintree is a payment processor that allows online businesses to accept payments via app or website. It also provides merchant accounts and payment gateways. PayPal owns Braintree, and a PayPal Business account is required. To know about more about payment methods supported by Braintree via hyperswitch visit [here](https://hyperswitch.io/pm-list). -## Activating via Hyperswitch +## Activating via Juspay Hyperswitch ### Prerequisites diff --git a/explore-hyperswitch/connectors/available-connectors/checkout.md b/explore-hyperswitch/connectors/available-connectors/checkout.md index 5f390ad8..527fa622 100644 --- a/explore-hyperswitch/connectors/available-connectors/checkout.md +++ b/explore-hyperswitch/connectors/available-connectors/checkout.md @@ -1,12 +1,14 @@ --- -description: Accept payments through Checkout via Hyperswitch +description: Accept payments through Checkout.com via Juspay Hyperswitch configuration and setup hidden: true --- # Checkout {% hint style="info" %} + This section gives you an overview of how to make payments via Checkout through Hyperswitch + {% endhint %} ![Checkout Logo](https://hyperswitch.io/icons/homePageIcons/logos/checkoutLogo.svg) diff --git a/explore-hyperswitch/connectors/available-connectors/coinbase.md b/explore-hyperswitch/connectors/available-connectors/coinbase.md index dedb9551..3e8d2998 100644 --- a/explore-hyperswitch/connectors/available-connectors/coinbase.md +++ b/explore-hyperswitch/connectors/available-connectors/coinbase.md @@ -1,12 +1,14 @@ --- -description: Accept payments through Coinbase via Hyperswitch +description: Accept cryptocurrency payments through Coinbase via Juspay Hyperswitch hidden: true --- # Coinbase {% hint style="info" %} + This section gives you an overview of how to make payments via Coinbase through Hyperswitch + {% endhint %} ![logo\_discord](https://hyperswitch.io/icons/homePageIcons/logos/coinbaseLogo.svg) @@ -15,7 +17,7 @@ This section gives you an overview of how to make payments via Coinbase through Coinbase Commerce is the easiest way to start accepting crypto payments. It provides reduced operational costs, multi-asset support and access to Coinbase’s millions of retail users. To know about more about payment methods supported by Coinbase via hyperswitch visit [here](https://hyperswitch.io/pm-list). -### Activating Coinbase via Hyperswitch +### Activating Coinbase via Juspay Hyperswitch #### Prerequisites diff --git a/explore-hyperswitch/connectors/available-connectors/cybersource/README.md b/explore-hyperswitch/connectors/available-connectors/cybersource/README.md index 81f07b1c..ec505936 100644 --- a/explore-hyperswitch/connectors/available-connectors/cybersource/README.md +++ b/explore-hyperswitch/connectors/available-connectors/cybersource/README.md @@ -1,18 +1,20 @@ --- -description: Accept payments through Cybersource via Hyperswitch +description: Accept payments through Cybersource via Juspay Hyperswitch configuration and setup --- # Cybersource {% hint style="info" %} + This section gives you an overview of how to make payments via Cybersource through Hyperswitch + {% endhint %} ![Cybersource Logo](https://hyperswitch.io/icons/homePageIcons/logos/CybersourceLogo.svg) Cybersource offers global payment solutions to help businesses accept payments across channels and geographies using a digital-first approach. To know about more about payment methods supported by Cybersource via hyperswitch visit [here](https://hyperswitch.io/pm-list). -### Activating Cybersource via Hyperswitch +### Activating Cybersource via Juspay Hyperswitch #### Prerequisites diff --git a/explore-hyperswitch/connectors/available-connectors/cybersource/apple-pay.md b/explore-hyperswitch/connectors/available-connectors/cybersource/apple-pay.md index 8c81a917..e0101a6a 100644 --- a/explore-hyperswitch/connectors/available-connectors/cybersource/apple-pay.md +++ b/explore-hyperswitch/connectors/available-connectors/cybersource/apple-pay.md @@ -1,11 +1,13 @@ --- -description: Integrate ApplePay via Cybersource in Hyperswitch +description: Integrate ApplePay via Cybersource in Juspay Hyperswitch --- # Apple Pay {% hint style="info" %} + This page consists of steps for how **ApplePay** can be enabled in Hyperswitch via Cybersource + {% endhint %} > This guide assumes that you have alreaedy configured Cybersource as a connector in your Hyperswitch Control Center. If not please follow the steps mentioned [here](./) @@ -40,7 +42,9 @@ This page consists of steps for how **ApplePay** can be enabled in Hyperswitch v * Country {% hint style="warning" %} + We recommend to pass this fields while creating the Payment Intent with Hyperswitch, Else Hyperswitch SDK will collect this information from the customer while making the payment which might not be the best experience for the customer. + {% endhint %} ### Steps to prepare ApplePay certificates for Cybersource Integration @@ -66,5 +70,8 @@ We recommend to pass this fields while creating the Payment Intent with Hyperswi * Now you can configure the genreated certificates into Hyperswitch Control Center for Cybersource by following these [steps](https://docs.hyperswitch.io/hyperswitch-cloud/payment-methods-setup/wallets/apple-pay/ios-application#configuring-apple-pay-on-hyperswitch). {% hint style="info" %} + To enable ApplePay in your iOS Application, please refer to the steps mentioned [here](https://docs.hyperswitch.io/hyperswitch-cloud/payment-methods-setup/wallets/apple-pay/ios-application#integrate-with-xcode) + {% endhint %} + diff --git a/explore-hyperswitch/connectors/available-connectors/cybersource/google-pay.md b/explore-hyperswitch/connectors/available-connectors/cybersource/google-pay.md index df8ac313..61a74bd5 100644 --- a/explore-hyperswitch/connectors/available-connectors/cybersource/google-pay.md +++ b/explore-hyperswitch/connectors/available-connectors/cybersource/google-pay.md @@ -1,11 +1,13 @@ --- -description: Integrate GooglePay (AndroidPay) via Cybersource in Hyperswitch +description: Integrate GooglePay (AndroidPay) via Cybersource in Juspay Hyperswitch --- # Google Pay {% hint style="info" %} + This page consists of steps for how **GooglePay** can be enabled in Hyperswitch via Cybersource + {% endhint %} > This guide assumes that you have alreaedy configured Cybersource as a connector in your Hyperswitch Control Center. If not please follow the steps mentioned [here](./) @@ -27,10 +29,12 @@ This page consists of steps for how **GooglePay** can be enabled in Hyperswitch * Enter the below mentioned GooglePay details in the overlay form and click `Proceed` 1. **Google Pay Merchant Key**: This is your Cybersource Merchant ID 2. **Google Pay Merchant Name**: This is your display name that the customer will see on his GooglePay App while making the payment. - 3. **Google Pay Merchant ID:** \[For Production Only] Enter your GooglePay Merchant ID provided by Google when you signup and get approvals for using GooglePay on production. + 3. **Google Pay Merchant ID:** [For Production Only] Enter your GooglePay Merchant ID provided by Google when you signup and get approvals for using GooglePay on production. {% hint style="success" %} -**\[SANDBOX ENV]:** For sandbox test environment, you can put any **dummy value** in **Google Pay Merchant ID** it won't affect the payments experience. + +**[SANDBOX ENV]:** For sandbox test environment, you can put any **dummy value** in **Google Pay Merchant ID** it won't affect the payments experience. + {% endhint %}
@@ -51,9 +55,10 @@ This page consists of steps for how **GooglePay** can be enabled in Hyperswitch * Country {% hint style="warning" %} + We recommend to pass this fields while creating the Payment Intent with Hyperswitch, Else Hyperswitch SDK will collect this information from the customer while making the payment which might not be the best experience for the customer. -{% endhint %} +{% endhint %} [^1]: diff --git a/explore-hyperswitch/connectors/available-connectors/dlocal.md b/explore-hyperswitch/connectors/available-connectors/dlocal.md index ad4db344..7bf336b6 100644 --- a/explore-hyperswitch/connectors/available-connectors/dlocal.md +++ b/explore-hyperswitch/connectors/available-connectors/dlocal.md @@ -1,12 +1,14 @@ --- -description: Accept payments through d-local via Hyperswitch +description: Accept payments through dLocal via Juspay Hyperswitch configuration and setup hidden: true --- # dLocal {% hint style="info" %} + This section gives you an overview of how to make payments via d-local through Hyperswitch + {% endhint %} ![logo\_dlocal](https://hyperswitch.io/icons/homePageIcons/logos/dlocalLogo.svg) @@ -15,7 +17,7 @@ This section gives you an overview of how to make payments via d-local through H dLocal Limited is a Uruguayan financial technology company. dLocal powers local payments connecting merchants with billions of emerging market consumers through one single API. To know about more about payment methods supported by d-local via hyperswitch visit [here](https://hyperswitch.io/pm-list). -### Activating dLocal via Hyperswitch +### Activating dLocal via Juspay Hyperswitch #### Prerequisites diff --git a/explore-hyperswitch/connectors/available-connectors/fiserv.md b/explore-hyperswitch/connectors/available-connectors/fiserv.md index e5d8fff9..6dc59a69 100644 --- a/explore-hyperswitch/connectors/available-connectors/fiserv.md +++ b/explore-hyperswitch/connectors/available-connectors/fiserv.md @@ -1,12 +1,14 @@ --- -description: Accept payments through Fiserv via Hyperswitch +description: Accept payments through Fiserv via Juspay Hyperswitch configuration and setup hidden: true --- # Fiserv {% hint style="info" %} + This section gives you an overview of how to make payments via Fiserv through Hyperswitch + {% endhint %} ![logo\_discord](https://hyperswitch.io/icons/homePageIcons/logos/fiservLogo.svg) @@ -15,7 +17,7 @@ This section gives you an overview of how to make payments via Fiserv through Hy Fiserv is a global fintech and payments company with solutions for banking, global commerce, merchant acquiring, billing and payments, and point-of-sale. To know about more about payment methods supported by Fiserv via hyperswitch visit [here](https://hyperswitch.io/pm-list). -### Activating Fiserv via Hyperswitch +### Activating Fiserv via Juspay Hyperswitch #### Prerequisites diff --git a/explore-hyperswitch/connectors/available-connectors/globalpayments.md b/explore-hyperswitch/connectors/available-connectors/globalpayments.md index 88e97bff..46ce9fc7 100644 --- a/explore-hyperswitch/connectors/available-connectors/globalpayments.md +++ b/explore-hyperswitch/connectors/available-connectors/globalpayments.md @@ -1,12 +1,14 @@ --- -description: Accept payments through GlobalPayments via Hyperswitch +description: Accept payments through GlobalPayments via Juspay Hyperswitch configuration and setup hidden: true --- # GlobalPayments {% hint style="info" %} + This section gives you an overview of how to make payments via GlobalPayments through Hyperswitch + {% endhint %} ![logo\_globalPayment](https://hyperswitch.io/icons/homePageIcons/logos/GlobalPaymentsLogo.svg) @@ -15,7 +17,7 @@ This section gives you an overview of how to make payments via GlobalPayments th Global Payments allows businesses to accept over 140 payment types across several channels with industry-specific solutions. Merchants can use it to set up subscriptions and recurring automatic payments, along with multiple customizable options for checkout. To know about more about payment methods supported by Globalpayments via hyperswitch visit [here](https://hyperswitch.io/pm-list). -### Activating GlobalPayments via Hyperswitch +### Activating GlobalPayments via Juspay Hyperswitch #### Prerequisites diff --git a/explore-hyperswitch/connectors/available-connectors/gocardless.md b/explore-hyperswitch/connectors/available-connectors/gocardless.md index 82031c54..2156e701 100644 --- a/explore-hyperswitch/connectors/available-connectors/gocardless.md +++ b/explore-hyperswitch/connectors/available-connectors/gocardless.md @@ -1,12 +1,14 @@ --- -description: Accept payments through GoCardless via Hyperswitch +description: Accept bank payments through GoCardless via Juspay Hyperswitch configuration hidden: true --- # GoCardless {% hint style="info" %} + This section gives you an overview of how to make payments via GoCardless through Hyperswitch + {% endhint %} ![logo\_globalPayment](../../../../../.gitbook/assets/gocardless-logo.png) @@ -15,7 +17,7 @@ This section gives you an overview of how to make payments via GoCardless throug GoCardless is a fintech company that specialises in bank payments including recurring payments, Direct Debit processing and Open Banking. GoCardless is headquartered in London. To know more about payment methods supported by GoCardless via hyperswitch click [here](https://hyperswitch.io/pm-list). -### Activating GoCardless via Hyperswitch +### Activating GoCardless via Juspay Hyperswitch #### Prerequisites diff --git a/explore-hyperswitch/connectors/available-connectors/klarna.md b/explore-hyperswitch/connectors/available-connectors/klarna.md index febdea3f..05d2d0f2 100644 --- a/explore-hyperswitch/connectors/available-connectors/klarna.md +++ b/explore-hyperswitch/connectors/available-connectors/klarna.md @@ -1,19 +1,21 @@ --- -description: Accept payments through Klarna via Hyperswitch +description: Accept buy now pay later payments through Klarna via Juspay Hyperswitch hidden: true --- # Klarna {% hint style="info" %} + This section gives you an overview of how to make payments via Klarna through Hyperswitch + {% endhint %} ![logo\_discord](https://hyperswitch.io/icons/homePageIcons/logos/klarnaLogo.svg) It allows businesses to provide direct payments, pay later options, and installment plans in a one-click purchase experience. To know about more about payment methods supported by Klarna via hyperswitch visit [here](https://hyperswitch.io/pm-list). -### Activating Klarna via Hyperswitch +### Activating Klarna via Juspay Hyperswitch #### Prerequisites diff --git a/explore-hyperswitch/connectors/available-connectors/mollie.md b/explore-hyperswitch/connectors/available-connectors/mollie.md index c29c10e8..d403c71e 100644 --- a/explore-hyperswitch/connectors/available-connectors/mollie.md +++ b/explore-hyperswitch/connectors/available-connectors/mollie.md @@ -1,21 +1,22 @@ --- -description: Accept payments through Mollie via Hyperswitch +description: Accept payments through Mollie via Juspay Hyperswitch configuration and setup hidden: true --- # Mollie {% hint style="info" %} + This section gives you an overview of how to make payments via Mollie through Hyperswitch + {% endhint %} ![logo\_discord](https://hyperswitch.io/icons/homePageIcons/logos/mollieLogo.svg) - Mollie is a payments platform that offers effortless payments, seamless checkout, multiple payment methods, powerful integrations, fast and flexible financing, robust security, an advanced dashboard and app. To know about more about payment methods supported by Mollie via hyperswitch visit [here](https://hyperswitch.io/pm-list). -### Activating Mollie via Hyperswitch +### Activating Mollie via Juspay Hyperswitch #### Prerequisites diff --git a/explore-hyperswitch/connectors/available-connectors/multisafepay.md b/explore-hyperswitch/connectors/available-connectors/multisafepay.md index a127a768..fac94f02 100644 --- a/explore-hyperswitch/connectors/available-connectors/multisafepay.md +++ b/explore-hyperswitch/connectors/available-connectors/multisafepay.md @@ -1,19 +1,21 @@ --- -description: Accept payments through MultiSafepay via Hyperswitch +description: Accept payments through MultiSafepay via Juspay Hyperswitch configuration hidden: true --- # MultiSafepay {% hint style="info" %} + This section gives you an overview of how to make payments via Multisafepay through Hyperswitch + {% endhint %} ![logo\_discord](https://hyperswitch.io/icons/homePageIcons/logos/multisafepayLogo.svg) Multisafepay is a Dutch fintech company that provides a range of payment solutions and services, including online payment processing, digital wallets, and fraud prevention tools, to businesses throughout Europe. To know about more about payment methods supported by MultiSafePay via hyperswitch visit [here](https://hyperswitch.io/pm-list). -### Activating Multisafepay via Hyperswitch +### Activating Multisafepay via Juspay Hyperswitch #### Prerequisites diff --git a/explore-hyperswitch/connectors/available-connectors/netcetera.md b/explore-hyperswitch/connectors/available-connectors/netcetera.md index cf8bd7ef..32c7e0e9 100644 --- a/explore-hyperswitch/connectors/available-connectors/netcetera.md +++ b/explore-hyperswitch/connectors/available-connectors/netcetera.md @@ -1,5 +1,5 @@ --- -description: Payments authentication through Netcetera via Hyperswitch +description: Authenticate payments using Netcetera 3DS via Juspay Hyperswitch --- # Netcetera @@ -7,7 +7,9 @@ description: Payments authentication through Netcetera via Hyperswitch
{% hint style="info" %} + This section gives you an overview of how to authenticate payments via Netcetera through Hyperswitch + {% endhint %} Netcetera offers EMV® 3DS 2.X transactions processing. It provides an ecosystem, incorporated into the merchant app to process in-app payments based on EMV® 3DS 2.X Standard. diff --git a/explore-hyperswitch/connectors/available-connectors/nuvei.md b/explore-hyperswitch/connectors/available-connectors/nuvei.md index 1a407767..eb57cf59 100644 --- a/explore-hyperswitch/connectors/available-connectors/nuvei.md +++ b/explore-hyperswitch/connectors/available-connectors/nuvei.md @@ -1,21 +1,22 @@ --- -description: Accept payments through Nuvei via Hyperswitch +description: Accept payments through Nuvei via Juspay Hyperswitch configuration and setup hidden: true --- # Nuvei {% hint style="info" %} + This section gives you an overview of how to make payments via Nuvei through Hyperswitch + {% endhint %} ![logo\_discord](https://hyperswitch.io/icons/homePageIcons/logos/nuveiLogo.svg) - Nuvei is a payment technology company that provides payment processing and acquiring services to merchants worldwide, with a focus on e-commerce and high-growth industries. To know about more about payment methods supported by Nuvei via hyperswitch visit [here](https://hyperswitch.io/pm-list). -### Activating Nuvei via Hyperswitch +### Activating Nuvei via Juspay Hyperswitch #### I. Prerequisites diff --git a/explore-hyperswitch/connectors/available-connectors/opennode.md b/explore-hyperswitch/connectors/available-connectors/opennode.md index dfeb45fe..8d8aed00 100644 --- a/explore-hyperswitch/connectors/available-connectors/opennode.md +++ b/explore-hyperswitch/connectors/available-connectors/opennode.md @@ -1,21 +1,22 @@ --- -description: Accept payments through OpenNode via Hyperswitch +description: Accept Bitcoin payments through OpenNode via Juspay Hyperswitch hidden: true --- # OpenNode {% hint style="info" %} + This section gives you an overview of how to make payments via OpenNode through Hyperswitch + {% endhint %} logo_discord - OpenNode makes it easy to accept bitcoin payments or send bitcoin payouts while gaining access to a global user base. They provide every business with access to instant, secure, low-cost bitcoin payments. To know about more about payment methods supported by OpenNode via hyperswitch visit [here](https://hyperswitch.io/pm-list). -### Activating OpenNode via Hyperswitch +### Activating OpenNode via Juspay Hyperswitch #### Prerequisites diff --git a/explore-hyperswitch/connectors/available-connectors/paypal.md b/explore-hyperswitch/connectors/available-connectors/paypal.md index 2be34e72..37b9817c 100644 --- a/explore-hyperswitch/connectors/available-connectors/paypal.md +++ b/explore-hyperswitch/connectors/available-connectors/paypal.md @@ -1,21 +1,22 @@ --- -description: Accept payments through Paypal via Hyperswitch +description: Accept payments through PayPal via Juspay Hyperswitch configuration and setup hidden: true --- # Paypal {% hint style="info" %} + This section gives you an overview of how to make payments via Paypal through Hyperswitch -{% endhint %} +{% endhint %} ![logo\_discord](https://hyperswitch.io/icons/homePageIcons/logos/paypalLogo.svg) Paypal provides a secure, open payment gateway. Merchants can choose that PayPal host the checkout pages and manage security for sales and authorizations. Merchants who want total control over the checkout experience can host their own checkout pages other online payment businesses need. To know about more about payment methods supported by Paypal via hyperswitch visit [here](https://hyperswitch.io/pm-list). -### Activating Paypal via Hyperswitch +### Activating Paypal via Juspay Hyperswitch #### Prerequisites diff --git a/explore-hyperswitch/connectors/available-connectors/payu-1.md b/explore-hyperswitch/connectors/available-connectors/payu-1.md index f0825d17..078630e5 100644 --- a/explore-hyperswitch/connectors/available-connectors/payu-1.md +++ b/explore-hyperswitch/connectors/available-connectors/payu-1.md @@ -1,12 +1,14 @@ --- -description: Accept payments through PayU via Hyperswitch +description: Accept payments through PayU via Juspay Hyperswitch configuration and setup hidden: true --- # PayU {% hint style="info" %} + This section gives you an overview of how to make payments via PayU through Hyperswitch + {% endhint %} ![logo\_discord](https://hyperswitch.io/icons/homePageIcons/logos/payuLogo.svg) @@ -15,7 +17,7 @@ This section gives you an overview of how to make payments via PayU through Hype PayU is a payment service provider that allows online businesses to accept and process payments through different integrated payment methods. To know about more about payment methods supported by PayU via hyperswitch visit [here](https://hyperswitch.io/pm-list). -### Activating PayU via Hyperswitch +### Activating PayU via Juspay Hyperswitch #### Prerequisites diff --git a/explore-hyperswitch/connectors/available-connectors/prophetpay.md b/explore-hyperswitch/connectors/available-connectors/prophetpay.md index 9af6b161..e47441dc 100644 --- a/explore-hyperswitch/connectors/available-connectors/prophetpay.md +++ b/explore-hyperswitch/connectors/available-connectors/prophetpay.md @@ -1,14 +1,15 @@ --- -description: Accept payments through Prophetpay via Hyperswitch +description: Accept payments through Prophetpay via Juspay Hyperswitch configuration hidden: true --- # Prophetpay - {% hint style="info" %} + This section gives you an overview of how to make payments via Prophetpay through Hyperswitch + {% endhint %} ![logo\_discord](../../../../../.gitbook/assets/logo_cps_new.jpg) @@ -17,7 +18,7 @@ This section gives you an overview of how to make payments via Prophetpay throug Prophetpay is a payment service provider that allows online businesses to accept and process payments through different integrated payment methods. To know more about payment methods supported by Prophetpay via hyperswitch click [here](https://hyperswitch.io/pm-list). -### Activating Prophetpay via Hyperswitch +### Activating Prophetpay via Juspay Hyperswitch #### Prerequisites diff --git a/explore-hyperswitch/connectors/available-connectors/rapyd.md b/explore-hyperswitch/connectors/available-connectors/rapyd.md index f5b1cc94..b5ed1c52 100644 --- a/explore-hyperswitch/connectors/available-connectors/rapyd.md +++ b/explore-hyperswitch/connectors/available-connectors/rapyd.md @@ -1,19 +1,21 @@ --- -description: Accept payments through Rapyd via Hyperswitch +description: Accept payments through Rapyd via Juspay Hyperswitch configuration and setup hidden: true --- # Rapyd {% hint style="info" %} + This section gives you an overview of how to make payments via Rapyd through Hyperswitch + {% endhint %} ![logo\_discord](https://hyperswitch.io/icons/homePageIcons/logos/rapydLogo.svg) Rapyd allows businesses to accept and send payments to any business or consumer entity present anywhere in a faster, cheaper and easier manner. To know about more about payment methods supported by Rapyd via hyperswitch visit [here](https://hyperswitch.io/pm-list). -### Activating Rapyd via Hyperswitch +### Activating Rapyd via Juspay Hyperswitch #### Prerequisites diff --git a/explore-hyperswitch/connectors/available-connectors/shift4.md b/explore-hyperswitch/connectors/available-connectors/shift4.md index 69da39b0..9684a87d 100644 --- a/explore-hyperswitch/connectors/available-connectors/shift4.md +++ b/explore-hyperswitch/connectors/available-connectors/shift4.md @@ -1,17 +1,19 @@ --- -description: Accept payments through Shift4 via Hyperswitch +description: Accept payments through Shift4 via Juspay Hyperswitch configuration and setup hidden: true --- # Shift4 {% hint style="info" %} + This section gives you an overview of how to make payments via Shift4 through Hyperswitch + {% endhint %} Shift4 is a payment processing company that provides secure payment processing solutions. It empowers merchants with a complete payment solution featuring a secure, reliable, and fast payment network available, backed by great technology and support. To know about more about payment methods supported by Shift4 via hyperswitch visit [here](https://hyperswitch.io/pm-list). -### Activating Shift4 via Hyperswitch +### Activating Shift4 via Juspay Hyperswitch #### Prerequisites diff --git a/explore-hyperswitch/connectors/available-connectors/stripe.md b/explore-hyperswitch/connectors/available-connectors/stripe.md index dbcc943f..66e262ee 100644 --- a/explore-hyperswitch/connectors/available-connectors/stripe.md +++ b/explore-hyperswitch/connectors/available-connectors/stripe.md @@ -1,25 +1,27 @@ --- -description: Accept payments through Stripe via Hyperswitch +description: Accept payments through Stripe via Juspay Hyperswitch configuration and setup --- # Stripe {% hint style="info" %} + This section gives you an overview of how to make payments via Stripe through Hyperswitch + {% endhint %} ![Stripe Logo](https://hyperswitch.io/icons/homePageIcons/logos/stripeLogo.svg) Stripe is a suite of APIs powering online payment processing and commerce solutions for internet businesses of all sizes. It allows businesses to accept payments and scale faster. To know about more about payment methods supported by stripe via hyperswitch visit [here](https://hyperswitch.io/pm-list). -### Activating Stripe via Hyperswitch +### Activating Stripe via Juspay Hyperswitch #### Prerequisites 1. You need to be registered with Stripe in order to proceed. In case you aren't, you can quickly setup your Stripe account [here](https://dashboard.stripe.com/register) 2. You should have a registered Hyperswitch account. You can access your account from the [Hyperswitch control center](https://app.hyperswitch.io/). 3. Enable handling raw card data for your Stripe account by sending a request to the stripe support (Visit [here](https://docs.hyperswitch.io/security-and-compliance/pci-compliance#docs-internal-guid-959e0903-7fff-fc13-1542-001b2640a715-1) for more details). This will enable Hyperswitch to securely handle your customer's payment details in a PCI compliant manner. -4. Enter your Country, Business Label and Stripe API Key. The Stripe API key can be found in your Stripe dashboard under \[Developers -> API keys]\(https://dashboard.stripe.com/test/apikeys) as \*\*Secret Key\*\*\ +4. Enter your Country, Business Label and Stripe API Key. The Stripe API key can be found in your Stripe dashboard under [Developers -> API keys]\(https://dashboard.stripe.com/test/apikeys) as \*\*Secret Key\*\*\ Note: Ensure to use the Secret Key -> Starts with \`sk\` 5. Select all the payment methods you wish to use Stripe for. Ensure that this is the same as the ones configured on your Stripe dashboard under Settings -> Payments -> Payment methods 6. Webhooks: Navigate to the webhooks section of your Stripe dashboard (Developers -> Webhooks) and create a new webhook by clicking on \`Add an endpoint\`. diff --git a/explore-hyperswitch/connectors/available-connectors/trustpay.md b/explore-hyperswitch/connectors/available-connectors/trustpay.md index d29af9c2..4c1c015e 100644 --- a/explore-hyperswitch/connectors/available-connectors/trustpay.md +++ b/explore-hyperswitch/connectors/available-connectors/trustpay.md @@ -1,19 +1,21 @@ --- -description: Accept payments through TrustPay via Hyperswitch +description: Accept payments through TrustPay via Juspay Hyperswitch configuration and setup hidden: true --- # TrustPay {% hint style="info" %} + This section gives you an overview of how to make payments via Trustpay through Hyperswitch + {% endhint %} ![logo\_discord](https://hyperswitch.io/icons/homePageIcons/logos/trustpayLogo.svg) TrustPay belongs to the first financial institutions within the region to provide secure e-commerce payments across the EEA area. They provide innovative payment services for online businesses with cross-border reach offering a variety of payment solutions.To know about more about payment methods supported by TrustPay via hyperswitch visit [here](https://hyperswitch.io/pm-list). -### Activating TrustPay via Hyperswitch +### Activating TrustPay via Juspay Hyperswitch #### Prerequisites diff --git a/explore-hyperswitch/connectors/available-connectors/volt.md b/explore-hyperswitch/connectors/available-connectors/volt.md index 613c733c..ed8d25ba 100644 --- a/explore-hyperswitch/connectors/available-connectors/volt.md +++ b/explore-hyperswitch/connectors/available-connectors/volt.md @@ -1,19 +1,21 @@ --- -description: Accept payments through Volt via Hyperswitch +description: Accept open banking payments through Volt via Juspay Hyperswitch configuration hidden: true --- # Volt {% hint style="info" %} + This section gives you an overview of how to make payments via Volt through Hyperswitch + {% endhint %} logo_discord Volt-io is a payment platform that intends to build a global infrastructure and create a single gateway for global payments and transactions. This is an unprecedented attempt to transform the market and remove payment barriers in e-commerce. To know more about payment methods supported by Volt via Hyperswitch click [here](https://www.volt.io/demo/). -### Activating Volt via Hyperswitch +### Activating Volt via Juspay Hyperswitch #### Prerequisites diff --git a/explore-hyperswitch/connectors/available-connectors/worldline.md b/explore-hyperswitch/connectors/available-connectors/worldline.md index 5ffd26cf..912c69ef 100644 --- a/explore-hyperswitch/connectors/available-connectors/worldline.md +++ b/explore-hyperswitch/connectors/available-connectors/worldline.md @@ -1,19 +1,21 @@ --- -description: Accept payments through Worldline via Hyperswitch +description: Accept payments through Worldline via Juspay Hyperswitch configuration and setup hidden: true --- # Worldline {% hint style="info" %} + This section gives you an overview of how to make payments via Worldline through Hyperswitch + {% endhint %} ![logo\_worldline](https://hyperswitch.io/icons/homePageIcons/logos/worldlineLogo.svg) Worldline is a payment service provider that offers in-store payment services, online payment solutions for seamless transactions, Omnichannel capabilities and global online payments to increase conversion and approval rates. To know about more about payment methods supported by Worldline via hyperswitch visit [here](https://hyperswitch.io/pm-list). -### Activating Worldline via Hyperswitch +### Activating Worldline via Juspay Hyperswitch #### Prerequisites diff --git a/explore-hyperswitch/connectors/available-connectors/worldpay.md b/explore-hyperswitch/connectors/available-connectors/worldpay.md index c2df4ca2..4748154f 100644 --- a/explore-hyperswitch/connectors/available-connectors/worldpay.md +++ b/explore-hyperswitch/connectors/available-connectors/worldpay.md @@ -1,19 +1,21 @@ --- -description: Accept payments through Worldpay via Hyperswitch +description: Accept payments through Worldpay via Juspay Hyperswitch configuration and setup hidden: true --- # Worldpay {% hint style="info" %} + This section gives you an overview of how to make payments via Worldpay through Hyperswitch + {% endhint %} ![logo\_discord](https://hyperswitch.io/icons/homePageIcons/logos/worldpayLogo.svg) FIS Worldpay is a payment processor that offers businesses a range of payment solutions, including online, in-store, and mobile payments, with fraud protection and easy integration. To know about more about payment methods supported by Worldpay via hyperswitch visit [here](https://hyperswitch.io/pm-list). -### Activating Worldpay via Hyperswitch +### Activating Worldpay via Juspay Hyperswitch #### Prerequisites diff --git a/explore-hyperswitch/connectors/available-connectors/zen.md b/explore-hyperswitch/connectors/available-connectors/zen.md index d9fe0704..bfccf455 100644 --- a/explore-hyperswitch/connectors/available-connectors/zen.md +++ b/explore-hyperswitch/connectors/available-connectors/zen.md @@ -1,12 +1,14 @@ --- -description: Accept payments through Zen via Hyperswitch +description: Accept payments through Zen via Juspay Hyperswitch configuration and setup hidden: true --- # Zen {% hint style="info" %} + This section gives you an overview of how to make payments via Zen through Hyperswitch + {% endhint %} ![logo\_zen](https://hyperswitch.io/img/site/zenLogo.svg) diff --git a/explore-hyperswitch/connectors/payment-processor-capabilities.md b/explore-hyperswitch/connectors/payment-processor-capabilities.md index 245f5bd1..7a9dc74f 100644 --- a/explore-hyperswitch/connectors/payment-processor-capabilities.md +++ b/explore-hyperswitch/connectors/payment-processor-capabilities.md @@ -1,7 +1,5 @@ --- -description: >- - A technical reference for the parameters and lifecycle flows supported across - card and wallet integrations. +description: Reference guide for payment parameters and lifecycle flows across card and wallet integrations icon: money-bill-1-wave --- @@ -42,7 +40,7 @@ The Payments API supports an extensive set of card parameters to ensure regional #### Digital Wallet Integration -Hyperswitch provides comprehensive parameters that streamline transaction management across leading digital wallets like Google Pay and Apple Pay. +Juspay Hyperswitch provides comprehensive parameters that streamline transaction management across leading digital wallets like Google Pay and Apple Pay.
@@ -51,7 +49,7 @@ Hyperswitch provides comprehensive parameters that streamline transaction manage #### Post-Transaction: Refunds, Disputes, and Errors -Hyperswitch offers a unified interface to track, respond to, and reconcile outcomes across multiple PSPs from a single orchestration layer. +Juspay Hyperswitch offers a unified interface to track, respond to, and reconcile outcomes across multiple PSPs from a single orchestration layer.
diff --git a/explore-hyperswitch/connectors/payouts/README.md b/explore-hyperswitch/connectors/payouts/README.md index 7e4a53d2..a6c458af 100644 --- a/explore-hyperswitch/connectors/payouts/README.md +++ b/explore-hyperswitch/connectors/payouts/README.md @@ -1,5 +1,5 @@ --- -description: Swift and streamlined payout automation +description: Automate payouts to vendors and partners across multiple processors icon: file-invoice-dollar --- @@ -46,9 +46,11 @@ Hyperswitch abstracts the complexity of regional payment rails. The table below | **Cybersource** | Global | Major Networks | — | — | {% hint style="info" %} + Methods marked with `*` are supported but not enabled by default. Methods marked with `**` are in beta. + {% endhint %} ### FAQ diff --git a/explore-hyperswitch/connectors/payouts/get-started-with-payouts.md b/explore-hyperswitch/connectors/payouts/get-started-with-payouts.md index 2de0b5fd..ae89bae9 100644 --- a/explore-hyperswitch/connectors/payouts/get-started-with-payouts.md +++ b/explore-hyperswitch/connectors/payouts/get-started-with-payouts.md @@ -1,4 +1,5 @@ --- +description: Configure payout processors and start processing payouts via API icon: flag-checkered --- @@ -69,5 +70,8 @@ Execute Payout: Navigate to the Process Payouts section of the collection to sen
{% content-ref url="process-payouts-using-saved-payment-methods.md" %} + [process-payouts-using-saved-payment-methods.md](process-payouts-using-saved-payment-methods.md) + {% endcontent-ref %} + diff --git a/explore-hyperswitch/connectors/payouts/payout-link.md b/explore-hyperswitch/connectors/payouts/payout-link.md index 1fdcdafd..3202419b 100644 --- a/explore-hyperswitch/connectors/payouts/payout-link.md +++ b/explore-hyperswitch/connectors/payouts/payout-link.md @@ -1,5 +1,5 @@ --- -description: Low-code solution to accept payouts +description: Send money to beneficiaries using customizable low-code payout links icon: link --- @@ -17,7 +17,7 @@ Introducing Payout Links - Make sending out money to beneficiaries, simple and e * Online gaming - Distribute prize money to players. * NGOs & Political Organisations - Reimburse field agents and volunteers. -## How to configure Payout links through Hyperswitch API? +## How to configure Payout links through Juspay Hyperswitch API? ### Prerequisites @@ -35,7 +35,7 @@ There are a couple of ways for using payout links. * Creating default links * Customizing UI of individual links * Serving links from a custom domain -* **\[TEST MODE]** Opening non-iframed links +* **[TEST MODE]** Opening non-iframed links #### 1. Update [business profile](https://api-reference.hyperswitch.io/api-reference/business-profile/business-profile--update) with a default payout\_link\_config by passing the below object in the request body diff --git a/explore-hyperswitch/connectors/payouts/process-payouts-using-saved-payment-methods.md b/explore-hyperswitch/connectors/payouts/process-payouts-using-saved-payment-methods.md index aa47ef0d..bf5c0ea4 100644 --- a/explore-hyperswitch/connectors/payouts/process-payouts-using-saved-payment-methods.md +++ b/explore-hyperswitch/connectors/payouts/process-payouts-using-saved-payment-methods.md @@ -1,10 +1,11 @@ --- +description: Process payouts using saved payment methods via PCI-compliant vault icon: repeat --- # Payouts with Saved Payment Methods -Hyperswitch allows you to store payment method details in a secure, PCI-compliant card vault for subsequent payout processing. By utilizing stored credentials, you can programmatically list a customer’s saved methods and retrieve a `payment_token` to initiate payouts without re-collecting sensitive information. +Juspay Hyperswitch allows you to store payment method details in a secure, PCI-compliant card vault for subsequent payout processing. By utilizing stored credentials, you can programmatically list a customer’s saved methods and retrieve a `payment_token` to initiate payouts without re-collecting sensitive information. #### Tokenizing Payment Methods @@ -66,5 +67,8 @@ Recurring/Subsequent Payouts: Follow the sequence to list existing customer paym
{% content-ref url="route-your-payout-transactions-using-smart-router.md" %} + [route-your-payout-transactions-using-smart-router.md](route-your-payout-transactions-using-smart-router.md) + {% endcontent-ref %} + diff --git a/explore-hyperswitch/connectors/payouts/route-your-payout-transactions-using-smart-router.md b/explore-hyperswitch/connectors/payouts/route-your-payout-transactions-using-smart-router.md index d6b62f32..324b9925 100644 --- a/explore-hyperswitch/connectors/payouts/route-your-payout-transactions-using-smart-router.md +++ b/explore-hyperswitch/connectors/payouts/route-your-payout-transactions-using-smart-router.md @@ -1,4 +1,5 @@ --- +description: Route payouts across multiple processors using volume and rule-based logic icon: swap --- diff --git a/explore-hyperswitch/connectors/payouts/smart-retries-in-payout.md b/explore-hyperswitch/connectors/payouts/smart-retries-in-payout.md index b3dd614b..aaff6c8b 100644 --- a/explore-hyperswitch/connectors/payouts/smart-retries-in-payout.md +++ b/explore-hyperswitch/connectors/payouts/smart-retries-in-payout.md @@ -1,4 +1,5 @@ --- +description: Automatically retry failed payouts to improve success rates icon: magnifying-glass-arrows-rotate --- diff --git a/explore-hyperswitch/connectors/split-payments/README.md b/explore-hyperswitch/connectors/split-payments/README.md index 1f5fcf01..00778503 100644 --- a/explore-hyperswitch/connectors/split-payments/README.md +++ b/explore-hyperswitch/connectors/split-payments/README.md @@ -1,7 +1,5 @@ --- -description: >- - Unify your marketplace settlement logic across multiple processors through a - single configuration. +description: Configure split settlements across Stripe Adyen and Xendit processors icon: split --- @@ -13,9 +11,9 @@ Split settlement refers to the process of dividing a single transaction into mul This is essential for marketplaces, platforms, and businesses handling multi-party transactions, enabling seamless revenue sharing, commission deductions, and vendor settlements while maintaining accuracy and compliance. -#### Hyperswitch Implementation +#### Juspay Hyperswitch Implementation -Hyperswitch provides payment functionality with connector-specific implementations supporting three major payment processors: Stripe, Adyen, and Xendit. +Juspay Hyperswitch provides payment functionality with connector-specific implementations supporting three major payment processors: Stripe, Adyen, and Xendit. Each connector has distinct validation rules, data structures, and split models tailored to their specific requirements. This abstraction allows you to manage multi-party flows through a single orchestration layer. diff --git a/explore-hyperswitch/connectors/split-payments/adyen-split-payments.md b/explore-hyperswitch/connectors/split-payments/adyen-split-payments.md index 8e56b109..bc7a3e90 100644 --- a/explore-hyperswitch/connectors/split-payments/adyen-split-payments.md +++ b/explore-hyperswitch/connectors/split-payments/adyen-split-payments.md @@ -1,5 +1,5 @@ --- -description: Get started with Adyen Split Settlements via Hyperswitch +description: Configure Adyen split settlements for marketplace fund distribution icon: space-awesome --- @@ -11,7 +11,7 @@ Adyen's Split Settlements functionality allows businesses to divide a single tra Hyperswitch facilitates splitting payments during both authorization and refund processing, ensuring smooth fund distribution at all transaction stages. -## Split Adyen payments via Hyperswitch +## Split Adyen payments via Juspay Hyperswitch In the [payment create](https://api-reference.hyperswitch.io/v1/payments/payments--create) request, include the Adyen split rule as provided below. @@ -96,7 +96,7 @@ Hyperswitch enforces several validation rules: }, ``` -## Split Adyen refunds via Hyperswitch +## Split Adyen refunds via Juspay Hyperswitch In the [refund create request](https://api-reference.hyperswitch.io/v1/refunds/refunds--create#refunds-create), include the following according to your split rule diff --git a/explore-hyperswitch/connectors/split-payments/stripe-split-payments.md b/explore-hyperswitch/connectors/split-payments/stripe-split-payments.md index 6c2fd83d..fc12364c 100644 --- a/explore-hyperswitch/connectors/split-payments/stripe-split-payments.md +++ b/explore-hyperswitch/connectors/split-payments/stripe-split-payments.md @@ -1,5 +1,5 @@ --- -description: Get started with Stripe Split Settlements via Hyperswitch +description: Configure Stripe split settlements for platform revenue sharing icon: stripe --- @@ -48,7 +48,7 @@ JSON } ``` -### Split Refunds via Hyperswitch +### Split Refunds via Juspay Hyperswitch For [Refunds](https://api-reference.hyperswitch.io/v1/refunds/refunds--create#refunds-create), include the appropriate split refund configuration based on the original `charge_type`. diff --git a/explore-hyperswitch/connectors/split-payments/xendit-split-payments.md b/explore-hyperswitch/connectors/split-payments/xendit-split-payments.md index cf23c288..ffe353b3 100644 --- a/explore-hyperswitch/connectors/split-payments/xendit-split-payments.md +++ b/explore-hyperswitch/connectors/split-payments/xendit-split-payments.md @@ -1,4 +1,5 @@ --- +description: Configure Xendit split settlements for marketplace transactions icon: hexagon-xmark --- @@ -13,7 +14,7 @@ If your platform charges a fee or commission when facilitating payments for your * Platform to Partner * Accepting Payments for Sub-Accounts -## Split Xendit payments via Hyperswitch +## Split Xendit payments via Juspay Hyperswitch Split settlements between multiple sub-merchants, partners, or platforms by including the Xendit split rules in the [payment creation API request](https://api-reference.hyperswitch.io/api-reference/payments/payments--create). diff --git a/explore-hyperswitch/connectors/subscriptions-with-modular-payments.md b/explore-hyperswitch/connectors/subscriptions-with-modular-payments.md index 707f6c75..b7e38c70 100644 --- a/explore-hyperswitch/connectors/subscriptions-with-modular-payments.md +++ b/explore-hyperswitch/connectors/subscriptions-with-modular-payments.md @@ -1,5 +1,5 @@ --- -description: Augment your subscriptions with payments orchestration capabilities +description: Augment subscriptions with payment orchestration and multi-PSP routing icon: repeat --- @@ -21,7 +21,7 @@ Businesses that run on subscription model powered by providers viz. Chargebee, R 2. Create and maintain plans on the subscription provider's dashboard 3. During the checkout process use Hyperswitch for Payments 4. Hyperswitch completes the payment, securely tokenises and stores the card -5. Subscription is created at Hyperswitch and at the subscription provider's end +5. Subscription is created at Juspay Hyperswitch and at the subscription provider's end 6. First invoice is marked as paid and the subscription is activated 7. Subsequent billing cycles are handled independently by Hyperswitch through MIT payments 8. Failed MIT payments can be smartly retries by Hyperswitch ([read more](../payments-modules/revenue-recovery.md)) or by the solution provider of your choice. @@ -38,15 +38,18 @@ Businesses that run on subscription model powered by providers viz. Chargebee, R ### Integration Guide -#### 1. For non-PCI compliant merchants who wants to use Hyperswitch Payments SDK +#### 1. For non-PCI compliant merchants who wants to use Juspay Hyperswitch Payments SDK {% stepper %} + {% step %} + Configure your Subscription Provider with Hyperswitch and set it as billing connector for the desired profile _Note: Dashboard support for this configuration will be available soon_ {% code overflow="wrap" fullWidth="false" %} + ``` curl --location 'http:///account//connectors' \ --header 'Content-Type: application/json' \ @@ -79,14 +82,19 @@ curl --location 'http:///account//business_profile/" }' ``` + {% endcode %} + {% endstep %} {% step %} + Configure Hyperswitch Webhook endpoint for invoice events on the subscription provider's dashboard + {% endstep %} {% step %} + Fetch the plan details (to be setup prior on subscription provider) ``` @@ -115,13 +123,17 @@ Response: ] ``` + {% endstep %} {% step %} + Display the retrieved Plan and Price Details to the user to make their selection + {% endstep %} {% step %} + Once the user selects a particular Plan, create a customer on Hyperswitch ([API Reference](https://api-reference.hyperswitch.io/v1/customers/customers--create)) and create a subscription with the following API ``` @@ -141,33 +153,47 @@ curl --location '/subscriptions/create' \ } }' ``` + {% endstep %} {% step %} + Initiate the Hyperswitch unified checkout SDK using the `client_secret` returned in the `/subscriptions/create` API response + {% endstep %} {% step %} + Once the customer selects a payment method and enters the details and confirms the subscription, hit the `/subscriptions/:id/confirm` using a similar [implementation as this](../payment-experience/payment/web/react-with-rest-api-integration.md) + {% endstep %} {% step %} + Sync with the subscription status for disbursement of services and future billing cycles + {% endstep %} + {% endstepper %} #### 2. For PCI Compliant merchants handling the entire checkout experience {% stepper %} + {% step %} + Follow the same steps as above to create a billing connector, fetch plan details and display the retrieved Plan and Price Details to the user to make their selection + {% endstep %} {% step %} + Once the user selects a particular Plan, create a customer on Hyperswitch ([API Reference](https://api-reference.hyperswitch.io/v1/customers/customers--create)), initiate checkout and collect payment method details + {% endstep %} {% step %} + After the user enter card/PM details and confirms the payment, hit the Hyperswitch Subscriptions API ``` @@ -250,12 +276,15 @@ Response: } } ``` + {% endstep %} {% step %} + Sync with the status of the Subscription API to disburse services to subscribed users {% code overflow="wrap" %} + ``` curl --location 'http://localhost:8080/subscriptions/' \ --header 'Content-Type: application/json' \ @@ -275,12 +304,17 @@ RESPONSE: "customer_id": "" } ``` + {% endcode %} + {% endstep %} {% step %} + Monitor incoming webhooks for renewal during subsequent cycles + {% endstep %} + {% endstepper %} ### FAQs diff --git a/explore-hyperswitch/e-commerce-platform-plugins/README.md b/explore-hyperswitch/e-commerce-platform-plugins/README.md index 76b34288..f902835d 100644 --- a/explore-hyperswitch/e-commerce-platform-plugins/README.md +++ b/explore-hyperswitch/e-commerce-platform-plugins/README.md @@ -1,11 +1,11 @@ --- -description: Hyperswitch plugins for the e-commerce platform you use +description: Extend e-commerce platforms with Juspay Hyperswitch payment optimization plugins hidden: true noIndex: true icon: plug-circle-bolt --- -# E-commerce Platform Plugins by Hyperswitch +# E-commerce Platform Plugins by Juspay Hyperswitch Hyperswitch plugins enable businesses to extend and enhance the functionality of leading E-commerce platforms, offering seamless integration and advanced capabilities for payment optimization, user experience, and analytics. @@ -18,5 +18,8 @@ From enabling express checkout and multi-currency payments to ensuring complianc Seamlessly integrate these plugins to elevate your platform’s performance and optimize your payment operations. {% hint style="info" %} + Need a plugin for another platform? Reach out to us at **hyperswitch@juspay.in** + {% endhint %} + diff --git a/explore-hyperswitch/e-commerce-platform-plugins/automatic-tax-calculation-for-express-checkout-wallets.md b/explore-hyperswitch/e-commerce-platform-plugins/automatic-tax-calculation-for-express-checkout-wallets.md index 23426071..09cac5da 100644 --- a/explore-hyperswitch/e-commerce-platform-plugins/automatic-tax-calculation-for-express-checkout-wallets.md +++ b/explore-hyperswitch/e-commerce-platform-plugins/automatic-tax-calculation-for-express-checkout-wallets.md @@ -1,7 +1,5 @@ --- -description: >- - Setup Taxjar on Hyperswitch to automatically calculate tax in case of Express - checkout wallets +description: Configure Taxjar for automatic tax calculation on express checkout wallets icon: filter-circle-dollar --- @@ -9,7 +7,7 @@ icon: filter-circle-dollar Hyperswitch supports configuring [Taxjar](https://www.taxjar.com/) in your dashboard as a tax connector so that tax amount can be calculated automatically whenever your customers change their shipping address on Express Checkout wallets like Apple pay and Paypal -## How to configure Taxjar on Hyperswitch? +## How to configure Taxjar on Juspay Hyperswitch? You can enable taxjar from the hyperswitch dashboard: diff --git a/explore-hyperswitch/e-commerce-platform-plugins/saleor-app/README.md b/explore-hyperswitch/e-commerce-platform-plugins/saleor-app/README.md index f443e6a5..9a0bbd42 100644 --- a/explore-hyperswitch/e-commerce-platform-plugins/saleor-app/README.md +++ b/explore-hyperswitch/e-commerce-platform-plugins/saleor-app/README.md @@ -1,4 +1,5 @@ --- +description: Integrate Juspay Hyperswitch and Hypercheckout with Saleor ecommerce platform hidden: true icon: plug-circle-bolt --- @@ -18,5 +19,8 @@ HyperCheckout combines the power of native checkout experiences, robust payment Access the entire payment ecosystem with a Single API. Hyperswitch connects you to multiple payment processors to embrace diversity. It improves payment success rates and reduces payment costs, ops & dev efforts. {% content-ref url="setup.md" %} + [setup.md](setup.md) + {% endcontent-ref %} + diff --git a/explore-hyperswitch/e-commerce-platform-plugins/saleor-app/setup.md b/explore-hyperswitch/e-commerce-platform-plugins/saleor-app/setup.md index b985a3bb..1ea6b3a2 100644 --- a/explore-hyperswitch/e-commerce-platform-plugins/saleor-app/setup.md +++ b/explore-hyperswitch/e-commerce-platform-plugins/saleor-app/setup.md @@ -1,5 +1,5 @@ --- -description: Juspay Saleor Payment App Setup +description: Set up Juspay payment app for Saleor platform integration --- # Setup @@ -7,7 +7,9 @@ description: Juspay Saleor Payment App Setup Connects Juspay's Hyperswitch and Hypercheckout with Saleor, enabling merchants to process payments securely and efficiently within their Saleor storefront for both Indian and international customers. {% hint style="info" %} + This section covers the steps to setup Juspay payment app through saleor + {% endhint %} ### Prerequisites @@ -194,17 +196,17 @@ mutation JuspayTransactionInitialize($data: JSON!) { You can pass additional fields while initiating the transaction through the $data JSON object. The additional fields you can pass include: -1. `customerId`: \[Optional String] The identifier for the customer +1. `customerId`: [Optional String] The identifier for the customer 2. `authenticationType`: This is used for non Indian payments. Pass this parameter to force 3DS or non 3DS auth for this payment. Some connectors will still force 3DS auth even in case of passing 'no\_three\_ds' here and vice versa. Default value is 'no\_three\_ds' if not set Available options: `three_ds`, `no_three_ds` -3. `billingEmail`: \[Optional String] customer's billing email -4. `shippingEmail` : \[Optional String] customer's shipping email -5. `statementDescriptorName`: \[Optional String] This is used for non Indian payments. For non-card charges, you can use this value as the complete description that appears on your customers’ statements. Must contain at least one letter, maximum 22 characters -6. `statementDescriptorSuffix`: \[Optional String] This is used for non Indian payments. Provides information about a card payment that customers see on their statements. Concatenated with the prefix (shortened descriptor) or statement descriptor that’s set on the account to form the complete statement descriptor. Maximum 22 characters for the concatenated descriptor. -7. `description`: \[Optional String] A description for the payment -8. `returnUrl`: \[Optional String] The URL to which you want the user to be redirected after the completion of the payment operation (Mandatory Field for Payment Links), -9. `manualRetryAllowed`: \[Optional Boolean] This is used for non Indian payments. If true the payment can be retried with same or different payment method which means the confirm call can be made again. -10. `gatewayReferenceId`: \[Optional String] This is used for Indian payments. The id refers to the payment gateway reference id which you configured in hypercheckout dashboard. It becomes mandatory when multiple instances of the same gateway are configured. Sending this id will route the transaction via selected gateway.Refer [here](https://docs.juspay.in/resources/docs/common-resources/gateway-reference-id) for details. -11. `allowedPaymentMethods`: \[Optional JSON] This helps you to select which payment options you want to show on your payment page. +3. `billingEmail`: [Optional String] customer's billing email +4. `shippingEmail` : [Optional String] customer's shipping email +5. `statementDescriptorName`: [Optional String] This is used for non Indian payments. For non-card charges, you can use this value as the complete description that appears on your customers’ statements. Must contain at least one letter, maximum 22 characters +6. `statementDescriptorSuffix`: [Optional String] This is used for non Indian payments. Provides information about a card payment that customers see on their statements. Concatenated with the prefix (shortened descriptor) or statement descriptor that’s set on the account to form the complete statement descriptor. Maximum 22 characters for the concatenated descriptor. +7. `description`: [Optional String] A description for the payment +8. `returnUrl`: [Optional String] The URL to which you want the user to be redirected after the completion of the payment operation (Mandatory Field for Payment Links), +9. `manualRetryAllowed`: [Optional Boolean] This is used for non Indian payments. If true the payment can be retried with same or different payment method which means the confirm call can be made again. +10. `gatewayReferenceId`: [Optional String] This is used for Indian payments. The id refers to the payment gateway reference id which you configured in hypercheckout dashboard. It becomes mandatory when multiple instances of the same gateway are configured. Sending this id will route the transaction via selected gateway.Refer [here](https://docs.juspay.in/resources/docs/common-resources/gateway-reference-id) for details. +11. `allowedPaymentMethods`: [Optional JSON] This helps you to select which payment options you want to show on your payment page. * **Indian Payments**: This expects a json object to enable and disable payment options. For more info refer [here](https://docs.juspay.in/hyper-checkout/android/resources/payment-locking). * **Non-Indian Payments**: This expects a json array of enums to enable and disable payment options. For more info refer `allowed_payment_method_types` in [payments-create](https://api-reference.hyperswitch.io/api-reference/payments/payments--create). diff --git a/explore-hyperswitch/e-commerce-platform-plugins/woocommerce-plugin/README.md b/explore-hyperswitch/e-commerce-platform-plugins/woocommerce-plugin/README.md index b49b4a4f..fe607910 100644 --- a/explore-hyperswitch/e-commerce-platform-plugins/woocommerce-plugin/README.md +++ b/explore-hyperswitch/e-commerce-platform-plugins/woocommerce-plugin/README.md @@ -1,5 +1,5 @@ --- -description: Hyperswitch Checkout for WooCommerce by hyperswitch.io +description: Accept payments via Juspay Hyperswitch on your WooCommerce store hidden: true --- @@ -37,7 +37,7 @@ With Hyperswitch private card vault, your business can exercise co control of yo In addition to the above, Hyperswitch also offers -* Access to **40+ processors** and **80+** [**payment methods**](https://hyperswitch.io/docs/paymentMethods/testCredentials) +* Access to **300+ connectors** and **300+** [**payment methods**](https://hyperswitch.io/docs/paymentMethods/testCredentials) * **PCI L1 certified** to store credit/debit card data * **GDPR ready** to store customer data * [**Smart routing engine**](https://hyperswitch.io/docs/features/smartRouter) to define business rules to optimize your payment processing costs and boost conversion rates diff --git a/explore-hyperswitch/e-commerce-platform-plugins/woocommerce-plugin/compatibility.md b/explore-hyperswitch/e-commerce-platform-plugins/woocommerce-plugin/compatibility.md index 3a11f1bb..8078b907 100644 --- a/explore-hyperswitch/e-commerce-platform-plugins/woocommerce-plugin/compatibility.md +++ b/explore-hyperswitch/e-commerce-platform-plugins/woocommerce-plugin/compatibility.md @@ -1,11 +1,13 @@ --- -description: List of all compatible WooCommerce plugins +description: Browse compatible plugins for Juspay Hyperswitch WooCommerce integration --- # Compatibility {% hint style="info" %} + This section enlists all the plugins which are compatible with the Hyperswitch WooCommerce. Search for the supported plugin here. + {% endhint %} Hyperswitch Woocommerce plugin is compatible with most of the other woocommerce plugins. You can find the exhaustive list here. diff --git a/explore-hyperswitch/e-commerce-platform-plugins/woocommerce-plugin/faqs.md b/explore-hyperswitch/e-commerce-platform-plugins/woocommerce-plugin/faqs.md index adba11cb..7bb5e9bc 100644 --- a/explore-hyperswitch/e-commerce-platform-plugins/woocommerce-plugin/faqs.md +++ b/explore-hyperswitch/e-commerce-platform-plugins/woocommerce-plugin/faqs.md @@ -1,12 +1,14 @@ --- -description: Quick answers to commonly asked questions about Hyperswitch +description: Find answers to common questions about Juspay Hyperswitch WooCommerce plugin --- # FAQs {% hint style="info" %} + This section covers the frequently asked questions you might have around Hyperswitch product, features, payment process, PCI compliance, woocommerce, etc.\ We regularly update the common questions here. + {% endhint %} **Is my customer information shared with other plugin users?** diff --git a/explore-hyperswitch/e-commerce-platform-plugins/woocommerce-plugin/roadmap.md b/explore-hyperswitch/e-commerce-platform-plugins/woocommerce-plugin/roadmap.md index f5a1187c..24d85bd8 100644 --- a/explore-hyperswitch/e-commerce-platform-plugins/woocommerce-plugin/roadmap.md +++ b/explore-hyperswitch/e-commerce-platform-plugins/woocommerce-plugin/roadmap.md @@ -1,12 +1,14 @@ --- -description: Roadmap for Woocommerce plugin +description: View upcoming features for the Juspay Hyperswitch WooCommerce plugin hidden: true --- # Roadmap {% hint style="info" %} + This section covers features in our future roadmap. Please reach out to us [here](https://join.slack.com/t/hyperswitch-io/shared_invite/zt-1k6cz4lee-SAJzhz6bjmpp4jZCDOtOIg) if you are looking for any of the features listed in this section. + {% endhint %} ### Roadmap diff --git a/explore-hyperswitch/e-commerce-platform-plugins/woocommerce-plugin/setup.md b/explore-hyperswitch/e-commerce-platform-plugins/woocommerce-plugin/setup.md index 4da36233..80572d9e 100644 --- a/explore-hyperswitch/e-commerce-platform-plugins/woocommerce-plugin/setup.md +++ b/explore-hyperswitch/e-commerce-platform-plugins/woocommerce-plugin/setup.md @@ -1,11 +1,13 @@ --- -description: WooCommerce Plugin Setup +description: Set up Juspay Hyperswitch plugin on your WordPress WooCommerce website --- # Setup {% hint style="info" %} + This section covers the steps to setup woocommerce plugin on your website and managing the orders from the dashboard. + {% endhint %} ### Prerequisites @@ -65,7 +67,7 @@ In cases where you need to issue a refund to a customer, the Hyperswitch plugin
-Note: Ensure you click on "Refund via Hyperswitch" and not the "Refund manually". Hyperswitch will handle the refund and update the payment status accordingly, ensuring a seamless refund experience for both you and your customers. +> **Note:** Ensure you click on "Refund via Hyperswitch" and not the "Refund manually". Hyperswitch will handle the refund and update the payment status accordingly, ensuring a seamless refund experience for both you and your customers. #### 2.3 Payment Sync: diff --git a/explore-hyperswitch/merchant-controls/README.md b/explore-hyperswitch/merchant-controls/README.md index b60b0639..ac70a256 100644 --- a/explore-hyperswitch/merchant-controls/README.md +++ b/explore-hyperswitch/merchant-controls/README.md @@ -6,7 +6,7 @@ icon: money-simple-from-bracket # Checkout Experience -Hyperswitch empowers you to deliver a **seamless, intuitive, and native checkout experience** without compromising transaction authenticity. +Juspay Hyperswitch empowers you to deliver a **seamless, intuitive, and native checkout experience** without compromising transaction authenticity. #### **How we improve checkout experience for your customers:** @@ -15,13 +15,15 @@ Hyperswitch empowers you to deliver a **seamless, intuitive, and native checkout * **Full Control Over Design & Functionality** – Customize both the appearance and behavior of the checkout experience. * **Advanced Security, No Redirection** – Seamlessly integrate **native 3DS** and **Click to Pay** for secure, frictionless transactions. -With Hyperswitch, you optimize the payment journey while maintaining **trust, security, and a frictionless user experience**. +With Juspay Hyperswitch, you optimize the payment journey while maintaining **trust, security, and a frictionless user experience**.
Customizable and Native Integrationsintegration-guide.md
Payment Methods Managementpayment-methods-management.md
Click To Payclick-to-pay
{% hint style="info" %} + **Have Questions?**\ Join our [Slack Community](https://join.slack.com/t/hyperswitch-io/shared_invite/zt-2jqxmpsbm-WXUENx022HjNEy~Ark7Orw) to ask questions, share feedback, and collaborate.\ Prefer direct support? Use our [Contact Us](https://hyperswitch.io/contact-us) page to reach out. + {% endhint %} diff --git a/explore-hyperswitch/merchant-controls/integration-guide.md b/explore-hyperswitch/merchant-controls/integration-guide.md index 6523262f..25fe7932 100644 --- a/explore-hyperswitch/merchant-controls/integration-guide.md +++ b/explore-hyperswitch/merchant-controls/integration-guide.md @@ -1,5 +1,5 @@ --- -description: Get started integrating the Hyperswitch web client in your app +description: Get started integrating the Juspay Hyperswitch web client in your app hidden: true icon: puzzle-piece --- diff --git a/explore-hyperswitch/merchant-controls/payment-features/3d-secure-3ds/README.md b/explore-hyperswitch/merchant-controls/payment-features/3d-secure-3ds/README.md index 8abcf0fe..e20940a5 100644 --- a/explore-hyperswitch/merchant-controls/payment-features/3d-secure-3ds/README.md +++ b/explore-hyperswitch/merchant-controls/payment-features/3d-secure-3ds/README.md @@ -42,7 +42,7 @@ By providing a native 3DS experience, the users never leave the merchant app. It Since the authentication occurs natively, merchants have more control over the branding and design of the authentication experience. This keeps the look and feel consistent with the rest of the app or website, offering a smoother, more professional user experience. -## Native 3D Secure on Hyperswitch +## Native 3D Secure on Juspay Hyperswitch 1. **In-line 3DS Challenge for web** - No redirections for the user. @@ -63,5 +63,8 @@ Since the authentication occurs natively, merchants have more control over the b To enable the Native 3DS Authentication on your website or mobile app, you need to integrate an external 3DS authentication providers. **Hyperswitch allows you to integrate external 3DS authenticators like Netcetera and 3dsecure.io with minimal development efforts, Visit the below page for detailed steps.** {% content-ref url="../../../workflows/3ds-decision-manager/external-authentication-for-3ds.md" %} + [external-authentication-for-3ds.md](../../../workflows/3ds-decision-manager/external-authentication-for-3ds.md) + {% endcontent-ref %} + diff --git a/explore-hyperswitch/merchant-controls/payment-features/3d-secure-3ds/netcetera.md b/explore-hyperswitch/merchant-controls/payment-features/3d-secure-3ds/netcetera.md index 8106499b..04c72b0f 100644 --- a/explore-hyperswitch/merchant-controls/payment-features/3d-secure-3ds/netcetera.md +++ b/explore-hyperswitch/merchant-controls/payment-features/3d-secure-3ds/netcetera.md @@ -15,38 +15,52 @@ in create payments call. You can read more about it [here](../../../workflows/3d Pass your Netcetera SDK API key to HyperSwitch SDK like below. {% tabs %} + {% tab title="Android" %} +
configuration = PaymentSheet.Configuration.Builder("Example, Inc.")
-                .netceteraSDKApiKey("YOUR_NETCETERA_API_KEY")
-                .build()
+.netceteraSDKApiKey("YOUR_NETCETERA_API_KEY")
+.build()
 
+ {% endtab %} {% tab title="iOS" %} + ```swift configuration.netceteraSDKApiKey="YOUR_NETCETERA_API_KEY" ``` + {% endtab %} {% tab title="Flutter" %} + ```dart configuration: Configuration(netceteraSDKApiKey: "") ``` + {% endtab %} + {% endtabs %} {% hint style="info" %} + In order to test external authentication on sandbox, a certificate needs to be added. Please follow the below steps. + {% endhint %} -Make the Hyperswitch [Payments - External 3DS Authentication](https://api-reference.hyperswitch.io/api-reference/payments/payments--external-3ds-authentication) request. Take the value of the field `acs_signed_content` , then decrypt it using [JWT.io](https://jwt.io/). Under the decrypted 'x5c' header you will get your root certificate. +Make the Hyperswitch [Payments - External 3DS Authentication](https://api-reference.hyperswitch.io/api-reference/payments/payments--external-3ds-authentication) request. Take the value of the field `acs_signed_content`, then decrypt it using [JWT.io](https://jwt.io/). Under the decrypted 'x5c' header you will get your root certificate. {% hint style="info" %} + This certificate is required is required to decrypt response from Netcetera's Prev (Sandbox) environment Demo ACS Server. + {% endhint %} {% hint style="success" %} + Please note the above step is not required for Production environment. + {% endhint %} ### Providing the root certificate to HyperSwitch SDK diff --git a/explore-hyperswitch/payment-experience/README.md b/explore-hyperswitch/payment-experience/README.md index 02afb8d2..64a538d2 100644 --- a/explore-hyperswitch/payment-experience/README.md +++ b/explore-hyperswitch/payment-experience/README.md @@ -1,5 +1,5 @@ --- -description: Learn about integration options for accepting payments online. +description: Explore integration options for accepting online payments icon: sidebar-flip --- @@ -8,7 +8,9 @@ icon: sidebar-flip Optimize your payments integration and unlock higher revenue with the Optimized Checkout Suite by Hyperswitch. It includes customizable payment UIs, dynamic payment method presentation, and one click checkout. Get started by choosing the integration that fits your business requirements {% hint style="info" %} + [Explore the demo](https://hyperswitch-demo-store.netlify.app/) + {% endhint %} ### Learn which payments integration fits your business diff --git a/explore-hyperswitch/payment-experience/payment-method/README.md b/explore-hyperswitch/payment-experience/payment-method/README.md index e6ef9611..902c9fa1 100644 --- a/explore-hyperswitch/payment-experience/payment-method/README.md +++ b/explore-hyperswitch/payment-experience/payment-method/README.md @@ -1,17 +1,20 @@ --- +description: Manage payment methods using vault SDK and server-to-server APIs icon: arrow-progress --- # Payment Method -Hyperswitch provides flexible payment processing with multiple flow patterns to accommodate different business needs. The system supports one-time payments, saved payment methods, and recurring billing through a comprehensive API design. +Juspay Hyperswitch provides flexible payment processing with multiple flow patterns to accommodate different business needs. The system supports one-time payments, saved payment methods, and recurring billing through a comprehensive API design. {% hint style="info" %} + ### Integration Path #### Server-to-Server (S2S) Payments Refer to this section if you intend to use the SDK exclusively for vaulting/storing card details. In this scenario, the actual payment execution is handled via S2S API calls from your backend to Hyperswitch, offering you more granular control over the transaction lifecycle. + {% endhint %} Payment method flows leverages all the capabilities available in [Payments](https://docs.hyperswitch.io/~/revisions/Moc8cqgBbfb8T8KrBi8V/about-hyperswitch/payment-suite-1/payments-cards). The primary goal here is to allow the business to control the payment journey via S2S APIs and a token or `payment_method_id` @@ -21,7 +24,6 @@ The business can use the Payment Method SDK or `/payment-methods` API to first c The business can then use the `payment_method_id` in `/payments` API to perform all functionalities supported by the [Payments](https://docs.hyperswitch.io/~/revisions/Moc8cqgBbfb8T8KrBi8V/about-hyperswitch/payment-suite-1/payments-cards) flow. - **Payment Method Lifecycle** The Payment Method flow leverages the full suite of Hyperswitch [Payment](https://docs.hyperswitch.io/~/revisions/Moc8cqgBbfb8T8KrBi8V/about-hyperswitch/payment-suite-1/payments-cards) capabilities while granting businesses granular control over the user journey. By utilizing Server-to-Server (S2S) APIs and unique identifiers `payment_method_id`, businesses can separate the collection of payment credentials from the actual transaction logic. diff --git a/explore-hyperswitch/payment-experience/payment-method/web/README.md b/explore-hyperswitch/payment-experience/payment-method/web/README.md index 986381d4..80e0f506 100644 --- a/explore-hyperswitch/payment-experience/payment-method/web/README.md +++ b/explore-hyperswitch/payment-experience/payment-method/web/README.md @@ -1,4 +1,5 @@ --- +description: Web integration for payment method management via Vault SDK icon: globe-pointer --- diff --git a/explore-hyperswitch/payment-experience/payment-method/web/vault-sdk-js-with-rest-api-integration.md b/explore-hyperswitch/payment-experience/payment-method/web/vault-sdk-js-with-rest-api-integration.md index 705523d7..6e0e6bf9 100644 --- a/explore-hyperswitch/payment-experience/payment-method/web/vault-sdk-js-with-rest-api-integration.md +++ b/explore-hyperswitch/payment-experience/payment-method/web/vault-sdk-js-with-rest-api-integration.md @@ -1,10 +1,11 @@ --- +description: Integrate Vault SDK using JavaScript for secure payment method tokenization icon: globe-pointer --- # Vault SDK - JS with REST API Integration -## Secure Tokenization using Hyperswitch's PCI Compliant Payment Methods Management SDK +## Secure Tokenization using Juspay Hyperswitch's PCI Compliant Payment Methods Management SDK The Hyperswitch Vault/Payment Methods Management SDK provides a secure solution for merchants to handle and store payment information without the burden of PCI DSS compliance requirements. By leveraging Hyperswitch's Vault service, merchants can securely store customer payment methods (credit cards, digital wallets, etc.) while minimizing their exposure to sensitive payment data. @@ -29,6 +30,7 @@ First, you'll need to set up your server to create payment method sessions, whic Get your API key from the [Hyperswitch dashboard](https://app.hyperswitch.io/developers?tabIndex=1) under Developers -> API Keys section. You'll need both your API key and profile ID for server and client integration. {% hint style="info" %} + All Vault API (V2) requests require authentication using specific API keys generated from your Vault Merchant account. These keys are distinct from your standard payment processing keys. To generate your Vault API keys, follow these steps: @@ -39,6 +41,7 @@ To generate your Vault API keys, follow these steps: 4. **Secure Storage:** Copy the generated key and store it securely. You must use this key to authenticate all Vault API (V2) calls. **Note:** We are currently working on unifying authentication across our platforms. Soon, you will be able to use a single API key for both Payments and Vault APIs. + {% endhint %} #### Creating a Payment Methods Session Endpoint diff --git a/explore-hyperswitch/payment-experience/payment-method/web/vault-sdk-react-with-rest-api-integration.md b/explore-hyperswitch/payment-experience/payment-method/web/vault-sdk-react-with-rest-api-integration.md index f01140cb..833a15ba 100644 --- a/explore-hyperswitch/payment-experience/payment-method/web/vault-sdk-react-with-rest-api-integration.md +++ b/explore-hyperswitch/payment-experience/payment-method/web/vault-sdk-react-with-rest-api-integration.md @@ -1,10 +1,11 @@ --- +description: Integrate Vault SDK in React applications for payment method management icon: rocket-vertical --- # Vault SDK Integration -## Secure Tokenization using Hyperswitch's PCI Compliant Vault SDK +## Secure Tokenization using Juspay Hyperswitch's PCI Compliant Vault SDK The Hyperswitch Vault/Payment Methods Management SDK provides a secure solution for merchants to handle and store payment information without the burden of PCI DSS compliance requirements. By leveraging Hyperswitch's Vault service, merchants can securely store customer payment methods (credit cards, digital wallets, etc.) while minimizing their exposure to sensitive payment data. @@ -36,6 +37,7 @@ Add an endpoint on your server that creates payment methods sessions. This endpo > For more details, kindly refer to the [API](https://api-reference.hyperswitch.io/introduction) reference documentation. {% hint style="info" %} + All Vault API (V2) requests require authentication using specific API keys generated from your Vault Merchant account. These keys are distinct from your standard payment processing keys. To generate your Vault API keys, follow these steps: @@ -46,6 +48,7 @@ To generate your Vault API keys, follow these steps: 4. **Secure Storage:** Copy the generated key and store it securely. You must use this key to authenticate all Vault API (V2) calls. **Note:** We are currently working on unifying authentication across our platforms. Soon, you will be able to use a single API key for both Payments and Vault APIs. + {% endhint %} ```javascript @@ -98,7 +101,7 @@ $ npm install @juspay-tech/hyper-js $ npm install @juspay-tech/react-hyper-js ``` -#### 2.2 Add Hyperswitch to Your React App +#### 2.2 Add Juspay Hyperswitch to Your React App Import the necessary components and hooks: @@ -108,7 +111,7 @@ import { loadHyper } from "@juspay-tech/hyper-js"; import { HyperManagementElements } from "@juspay-tech/react-hyper-js"; ``` -#### 2.3 Initialize the Hyperswitch Library +#### 2.3 Initialize the Juspay Hyperswitch Library Configure the library with your publishable API key and profile ID: @@ -139,8 +142,8 @@ useEffect(() => { headers: { "Content-Type": "application/json" }, body: JSON.stringify({customer_id: "customer_id"}), }) - .then((res) => res.json()) - .then((data) => { +.then((res) => res.json()) +.then((data) => { setPmClientSecret(data.pmClientSecret); setPmSessionId(data.pmSessionId); }); diff --git a/explore-hyperswitch/payment-experience/payment/README.md b/explore-hyperswitch/payment-experience/payment/README.md index feb1b36b..83b0d31b 100644 --- a/explore-hyperswitch/payment-experience/payment/README.md +++ b/explore-hyperswitch/payment-experience/payment/README.md @@ -1,17 +1,20 @@ --- +description: Process one-time and recurring payments with multiple flow patterns icon: file-invoice-dollar --- # Payment -Hyperswitch provides flexible payment processing with multiple flow patterns to accommodate different business needs. The system supports one-time payments, saved payment methods, and recurring billing through a comprehensive API design. +Juspay Hyperswitch provides flexible payment processing with multiple flow patterns to accommodate different business needs. The system supports one-time payments, saved payment methods, and recurring billing through a comprehensive API design. {% hint style="info" %} + ### Integration Path #### Client-Side SDK Payments Refer to Payments (Cards) section if your flow requires the SDK to initiate payments directly. In this model, the SDK handles the payment trigger and communicates downstream to the Hyperswitch server and your chosen Payment Service Providers (PSPs). This path is ideal for supporting dynamic, frontend-driven payment experiences. + {% endhint %}
diff --git a/explore-hyperswitch/payment-experience/payment/app-clips.md b/explore-hyperswitch/payment-experience/payment/app-clips.md index 748c855b..19dabc8c 100644 --- a/explore-hyperswitch/payment-experience/payment/app-clips.md +++ b/explore-hyperswitch/payment-experience/payment/app-clips.md @@ -46,11 +46,11 @@ icon: app-store configuration: config ) { result in switch result { - case .completed: + case.completed: self.statusLabel.text = "Payment complete" - case .failed(let error): + case.failed(let error): self.statusLabel.text = "Payment failed: \(error)" - case .canceled: + case.canceled: self.statusLabel.text = "Payment canceled." } } @@ -73,5 +73,8 @@ icon: app-store To use this feature add Lite SDK in your AppClips {% content-ref url="../../payment-experience/payment/mobile/ios/lite-sdk.md" %} + [lite-sdk.md](../../payment-experience/payment/mobile/ios/lite-sdk.md) + {% endcontent-ref %} + diff --git a/explore-hyperswitch/payment-experience/payment/enable-alternate-payment-method-widgets/README.md b/explore-hyperswitch/payment-experience/payment/enable-alternate-payment-method-widgets/README.md index cf5c4f2e..b3ae5cc1 100644 --- a/explore-hyperswitch/payment-experience/payment/enable-alternate-payment-method-widgets/README.md +++ b/explore-hyperswitch/payment-experience/payment/enable-alternate-payment-method-widgets/README.md @@ -1,4 +1,5 @@ --- +description: Extend checkout with modular alternate payment method widgets icon: bolt-lightning --- @@ -73,5 +74,8 @@ The engineering ensures support for emerging payment methods and new PSPs withou
via PSP or middle layervia Hyperwidgets

Existing APMs

  • Apple Pay - 2-3 weeks of engineering effort
  • Klarna - 2-3 weeks of engineering effort

New innovations

  • Paze - Not available via most players
  • Click2Pay - Not available via most player

One time effort of 2-weeks to enable all existing APMs and new innovations via the same integration

{% content-ref url="hyperwidget-integration-guide.md" %} + [hyperwidget-integration-guide.md](hyperwidget-integration-guide.md) + {% endcontent-ref %} + diff --git a/explore-hyperswitch/payment-experience/payment/enable-alternate-payment-method-widgets/hyperwidget-integration-guide.md b/explore-hyperswitch/payment-experience/payment/enable-alternate-payment-method-widgets/hyperwidget-integration-guide.md index 1df09b2d..d4f6b0e4 100644 --- a/explore-hyperswitch/payment-experience/payment/enable-alternate-payment-method-widgets/hyperwidget-integration-guide.md +++ b/explore-hyperswitch/payment-experience/payment/enable-alternate-payment-method-widgets/hyperwidget-integration-guide.md @@ -1,4 +1,5 @@ --- +description: Integrate Hyperwidgets for APM support with minimal code changes icon: plug-circle-bolt --- @@ -6,7 +7,7 @@ icon: plug-circle-bolt Once the merchant signs up onto the unified dashboard, they’ll get their API keys and can enable the APMs <> PSP combinations that they would like to provide on their checkout. -Hyperswitch provides a code transformer that allows the merchant to leverage their existing integration (with PSP or middle layer) and make a call to Hyperswitch server with minimal changes. Hyperwidget acts as a Unified wrapper on top of all major APMs and simplifies up-scaling or down-scaling of these APMs across one or multiple PSPs. +Juspay Hyperswitch provides a code transformer that allows the merchant to leverage their existing integration (with PSP or middle layer) and make a call to Hyperswitch server with minimal changes. Hyperwidget acts as a Unified wrapper on top of all major APMs and simplifies up-scaling or down-scaling of these APMs across one or multiple PSPs. The unified dashboard offers the merchants ability to enable or disable APMs via any PSP. The dashboard also offers capabilities like - Analytics, Operations, Refunds, Chargebacks, and Reconciliation. @@ -40,5 +41,8 @@ To start collecting payments via the APM of your choice, follow these simple ste * [For customizations on the Checkout Page follow this guide.](https://docs.hyperswitch.io/explore-hyperswitch/merchant-controls/integration-guide/web) {% content-ref url="../../../payment-orchestration/click-to-pay/" %} + [click-to-pay](../../../payment-orchestration/click-to-pay/) + {% endcontent-ref %} + diff --git a/explore-hyperswitch/payment-experience/payment/features.md b/explore-hyperswitch/payment-experience/payment/features.md index 11b4af61..dd9e84f5 100644 --- a/explore-hyperswitch/payment-experience/payment/features.md +++ b/explore-hyperswitch/payment-experience/payment/features.md @@ -1,4 +1,5 @@ --- +description: Enable card scanning features for iOS and Android SDKs icon: barcode-read --- @@ -6,19 +7,21 @@ icon: barcode-read
-#### Key Features of Hyperswitch's Card Scanning Technology +#### Key Features of Juspay Hyperswitch's Card Scanning Technology 1. **Accuracy**: Leveraging optical character recognition (OCR) technology, Hyperswitch's card scanning feature accurately extracts credit card details in real-time. This significantly reduces the likelihood of manual entry errors and speeds up the checkout process. 2. **Seamless Integration**: Hyperswitch offers a developer-friendly SDK that makes it easy to integrate the card scanning feature into various platforms, including native mobile apps ([iOS](https://docs.hyperswitch.io/hyperswitch-cloud/integration-guide/ios/features) and [Android](https://docs.hyperswitch.io/hyperswitch-cloud/integration-guide/android/features)), cross-platform frameworks, and even in-browser applications. -#### Benefits of Hyperswitch's Card Scanning Feature +#### Benefits of Juspay Hyperswitch's Card Scanning Feature 1. **Improved User Experience**: By eliminating the need for manual card data entry, the card scanning feature significantly enhances the user experience, potentially leading to higher conversion rates for businesses. 2. **Reduced Error Rates**: The scanning technology minimizes the risk of mistyped card information, reducing transaction errors and potential disputes. 3. **Time-Saving Efficiency**: For both customers and merchants, the card scanning feature saves valuable time during the checkout process, potentially leading to increased customer satisfaction and loyalty. {% tabs %} + {% tab title="Android" %} + #### 1.0 Add the Scan Card dependency Add this scan card dependency to your build.gradle file @@ -32,9 +35,11 @@ hyperswitch { scanCardVersion = "0.0.6" } ``` + {% endtab %} {% tab title="iOS" %} + #### 1.0 Configure pods to support Scan Card feature Scan Card Setup @@ -48,7 +53,7 @@ Add these lines to your Podfile: #end ``` -Note: Above subspec installs both Hyperswitch SDK and Scan Card dependencies to your app +> **Note:** Above subspec installs both Hyperswitch SDK and Scan Card dependencies to your app Run the following command: @@ -67,9 +72,11 @@ pod install --repo-update To enable scan card support, set the `NSCameraUsageDescription` (**Privacy - Camera Usage Description**) in the Info.plist of your application, and provide a reason for accessing the camera (for example, “camera access required to scan cards”). Devices with iOS 13 or higher support card scanning.
+ {% endtab %} {% tab title="Android Lite" %} + #### 1.0 Add the Scan Card Lite dependency Add this scan card lite dependency to your build.gradle file @@ -79,5 +86,8 @@ dependencies { implementation 'io.hyperswitch:hyperswitch-scan-card-lite:+' } ``` + {% endtab %} + {% endtabs %} + diff --git a/explore-hyperswitch/payment-experience/payment/mobile/README.md b/explore-hyperswitch/payment-experience/payment/mobile/README.md index 6d210241..2d8a5bee 100644 --- a/explore-hyperswitch/payment-experience/payment/mobile/README.md +++ b/explore-hyperswitch/payment-experience/payment/mobile/README.md @@ -1,4 +1,5 @@ --- +description: Integrate secure customizable mobile SDKs for iOS and Android icon: mobile --- diff --git a/explore-hyperswitch/payment-experience/payment/mobile/android/customization.md b/explore-hyperswitch/payment-experience/payment/mobile/android/customization.md index e29eeb0b..fa5549da 100644 --- a/explore-hyperswitch/payment-experience/payment/mobile/android/customization.md +++ b/explore-hyperswitch/payment-experience/payment/mobile/android/customization.md @@ -6,7 +6,9 @@ icon: bars-progress # Customization {% hint style="info" %} + You can customize the Android Unified Checkout to support your checkout context and brand guidelines by changing fonts, colors, shapes and layouts. + {% endhint %} Create a `PaymentSheet.Configuration` object with an `appearance` object in order to be able to match the design of your app. @@ -53,5 +55,8 @@ Now you can test the payments on your app and go-live! ## Next step: {% content-ref url="../../../../payment-orchestration/quickstart/payment-methods-setup/" %} + [payment-methods-setup](../../../../payment-orchestration/quickstart/payment-methods-setup/) + {% endcontent-ref %} + diff --git a/explore-hyperswitch/payment-experience/payment/mobile/android/headless.md b/explore-hyperswitch/payment-experience/payment/mobile/android/headless.md index 4d4930f1..af4b3c4d 100644 --- a/explore-hyperswitch/payment-experience/payment/mobile/android/headless.md +++ b/explore-hyperswitch/payment-experience/payment/mobile/android/headless.md @@ -1,6 +1,6 @@ --- description: >- - Hyperswitch is designed to facilitate the integration and management of + Juspay Hyperswitch is designed to facilitate the integration and management of payment-related functionalities in a decoupled or headless architecture with flexibility to customize your checkout UI. icon: table-cells-large @@ -24,7 +24,9 @@ paymentSession = PaymentSession(applicationContext, "YOUR_PUBLISHABLE_KEY") Make a request to the endpoint on your server to create a new Payment. The `clientSecret` returned by your endpoint is used to initialize the payment session. {% hint style="danger" %} + **Important**: Make sure to never share your API key with your client application as this could potentially compromise your security + {% endhint %} #### 3. Initialize your Payment Session diff --git a/explore-hyperswitch/payment-experience/payment/mobile/android/kotlin-with-rest-api-integration.md b/explore-hyperswitch/payment-experience/payment/mobile/android/kotlin-with-rest-api-integration.md index 7ed650a6..9326e6df 100644 --- a/explore-hyperswitch/payment-experience/payment/mobile/android/kotlin-with-rest-api-integration.md +++ b/explore-hyperswitch/payment-experience/payment/mobile/android/kotlin-with-rest-api-integration.md @@ -66,11 +66,11 @@ hyperswitch { ``` {% hint style="warning" %} -Note: -* If you don't specify `sdkVersion`, the plugin will automatically use the latest available version +> **Note:** * If you don't specify `sdkVersion`, the plugin will automatically use the latest available version * You only need to enable the features you plan to use * Individual feature versions are optional - the plugin will use recommended compatible versions + {% endhint %} ### 2.4 Implement the HyperInterface @@ -79,14 +79,16 @@ Next, implement the `HyperInterface` in your `CheckoutActivity`. This involves e ```kotlin class CheckoutActivity : AppCompatActivity(), HyperInterface { - // ... + //... } ``` {% hint style="warning" %} + **Note**: `PaymentSession` is designed to work with AndroidX activities. Ensure that your `CheckoutActivity` extends `FragmentActivity` or its subclass from the AndroidX library + {% endhint %} ### 2.5 Setup the SDK and fetch a Payment @@ -98,12 +100,15 @@ val paymentSession = PaymentSession(applicationContext, "YOUR_PUBLISHABLE_KEY"); ``` {% hint style="warning" %} + **Note**: PaymentSession needs to be initialised in onCreate method of your `FragmentActivity` + {% endhint %} {% hint style="warning" %} + **Note**: For an open-source setup, use the following parameters: @@ -111,6 +116,7 @@ For an open-source setup, use the following parameters: ```kotlin val paymentSession = PaymentSession(applicationContext, "YOUR_PUBLISHABLE_KEY", "YOUR_CUSTOM_BACKEND_URL", "YOUR_CUSTOM_LOG_URL") ``` + {% endhint %} **Fetch a Payment** @@ -148,7 +154,9 @@ private fun onPaymentSheetResult(paymentResult: PaymentSheetResult) { ``` {% hint style="danger" %} + Please retrieve the payment status from the Hyperswitch backend to get the terminal status of the payment. Do not rely solely on the status returned by the SDK, as it may not always reflect the final state of the transaction. + {% endhint %} **Present the Payment Page** @@ -169,7 +177,9 @@ Congratulations! You have successfully integrated the Hyperswitch Android SDK in ## Next step: {% content-ref url="../../../../payment-orchestration/quickstart/payment-methods-setup/" %} + [payment-methods-setup](../../../../payment-orchestration/quickstart/payment-methods-setup/) + {% endcontent-ref %} [^1]: [Get Latest Version](https://central.sonatype.com/artifact/io.hyperswitch/hyperswitch-gradle-plugin/versions) diff --git a/explore-hyperswitch/payment-experience/payment/mobile/android/lite-sdk.md b/explore-hyperswitch/payment-experience/payment/mobile/android/lite-sdk.md index 04a86d9b..1c8f28a0 100644 --- a/explore-hyperswitch/payment-experience/payment/mobile/android/lite-sdk.md +++ b/explore-hyperswitch/payment-experience/payment/mobile/android/lite-sdk.md @@ -1,5 +1,5 @@ --- -description: Integrate Hyperswitch Lite SDK to your Kotlin App +description: Integrate Juspay Hyperswitch Lite SDK to your Kotlin App icon: mobile-screen --- @@ -54,12 +54,15 @@ val paymentSession = PaymentSession(applicationContext, "YOUR_PUBLISHABLE_KEY") ``` {% hint style="warning" %} + **Note**: PaymentSession needs to be initialized in onCreate method of your `FragmentActivity` + {% endhint %} {% hint style="warning" %} + **Note**: For an open-source setup, use the following parameters: @@ -67,6 +70,7 @@ For an open-source setup, use the following parameters: ```kotlin val paymentSession = PaymentSession(applicationContext, "YOUR_PUBLISHABLE_KEY", "YOUR_CUSTOM_BACKEND_URL", "YOUR_CUSTOM_LOG_URL") ``` + {% endhint %} **Fetch a Payment** @@ -104,7 +108,9 @@ private fun onPaymentSheetResult(paymentResult: PaymentSheetResult) { ``` {% hint style="danger" %} + Please retrieve the payment status from the Hyperswitch backend to get the terminal status of the payment. Do not rely solely on the status returned by the SDK, as it may not always reflect the final state of the transaction. + {% endhint %} **Present the Payment Page** @@ -125,5 +131,8 @@ Congratulations! You have successfully integrated the Hyperswitch Lite SDK into ## Next step: {% content-ref url="../../../../payment-orchestration/quickstart/payment-methods-setup/" %} + [payment-methods-setup](../../../../payment-orchestration/quickstart/payment-methods-setup/) + {% endcontent-ref %} + diff --git a/explore-hyperswitch/payment-experience/payment/mobile/android/widgets/README.md b/explore-hyperswitch/payment-experience/payment/mobile/android/widgets/README.md index de3b43a7..dff83782 100644 --- a/explore-hyperswitch/payment-experience/payment/mobile/android/widgets/README.md +++ b/explore-hyperswitch/payment-experience/payment/mobile/android/widgets/README.md @@ -57,7 +57,7 @@ Next, implement the `HyperInterface` in your Activity. This involves extending ` ```kotlin class WidgetActivity : AppCompatActivity(), HyperInterface { - // ... + //... } ``` @@ -88,7 +88,9 @@ Congratulations! You have successfully integrated Hyperswitch widgets into your ## Next step: {% content-ref url="../../../../../payment-orchestration/quickstart/payment-methods-setup/" %} + [payment-methods-setup](../../../../../payment-orchestration/quickstart/payment-methods-setup/) + {% endcontent-ref %} [^1]: [Get Latest Version](https://central.sonatype.com/artifact/io.hyperswitch/hyperswitch-gradle-plugin/versions) diff --git a/explore-hyperswitch/payment-experience/payment/mobile/android/widgets/card-element.md b/explore-hyperswitch/payment-experience/payment/mobile/android/widgets/card-element.md index c2cfe521..37cbb28a 100644 --- a/explore-hyperswitch/payment-experience/payment/mobile/android/widgets/card-element.md +++ b/explore-hyperswitch/payment-experience/payment/mobile/android/widgets/card-element.md @@ -1,4 +1,5 @@ --- +description: Implement card payment widget for Android applications icon: credit-card --- diff --git a/explore-hyperswitch/payment-experience/payment/mobile/android/widgets/express-checkout.md b/explore-hyperswitch/payment-experience/payment/mobile/android/widgets/express-checkout.md index ecd64c3b..5f85a068 100644 --- a/explore-hyperswitch/payment-experience/payment/mobile/android/widgets/express-checkout.md +++ b/explore-hyperswitch/payment-experience/payment/mobile/android/widgets/express-checkout.md @@ -1,4 +1,5 @@ --- +description: Implement express checkout widget for one-click payments on Android icon: cart-shopping-fast --- diff --git a/explore-hyperswitch/payment-experience/payment/mobile/android/widgets/google-pay.md b/explore-hyperswitch/payment-experience/payment/mobile/android/widgets/google-pay.md index 1b8a3c0a..4e69c0c3 100644 --- a/explore-hyperswitch/payment-experience/payment/mobile/android/widgets/google-pay.md +++ b/explore-hyperswitch/payment-experience/payment/mobile/android/widgets/google-pay.md @@ -1,4 +1,5 @@ --- +description: Integrate Google Pay widget for Android payment acceptance icon: google --- diff --git a/explore-hyperswitch/payment-experience/payment/mobile/android/widgets/paypal.md b/explore-hyperswitch/payment-experience/payment/mobile/android/widgets/paypal.md index 1082183a..eec15cde 100644 --- a/explore-hyperswitch/payment-experience/payment/mobile/android/widgets/paypal.md +++ b/explore-hyperswitch/payment-experience/payment/mobile/android/widgets/paypal.md @@ -1,4 +1,5 @@ --- +description: Integrate PayPal widget for Android payment acceptance icon: paypal --- diff --git a/explore-hyperswitch/payment-experience/payment/mobile/cross-platform/README.md b/explore-hyperswitch/payment-experience/payment/mobile/cross-platform/README.md index 2c12ae60..7ff17148 100644 --- a/explore-hyperswitch/payment-experience/payment/mobile/cross-platform/README.md +++ b/explore-hyperswitch/payment-experience/payment/mobile/cross-platform/README.md @@ -1,10 +1,11 @@ --- +description: Build cross-platform payments with React Native and Flutter SDKs icon: layer-plus --- # Cross Platform -Hyperswitch provides **seamless cross-platform payment integrations** for both **React Native** and **Flutter**, enabling you to deliver a consistent payment experience across iOS, Android, and Web. +Juspay Hyperswitch provides **seamless cross-platform payment integrations** for both **React Native** and **Flutter**, enabling you to deliver a consistent payment experience across iOS, Android, and Web. #### Key Benefits @@ -14,9 +15,14 @@ Hyperswitch provides **seamless cross-platform payment integrations** for both * * **Customization Options** – Branding, appearance, billing, and payment method preferences are fully configurable. {% content-ref url="react-native/" %} + [react-native](react-native/) + {% endcontent-ref %} {% content-ref url="flutter/" %} + [flutter](flutter/) + {% endcontent-ref %} + diff --git a/explore-hyperswitch/payment-experience/payment/mobile/cross-platform/flutter/customization.md b/explore-hyperswitch/payment-experience/payment/mobile/cross-platform/flutter/customization.md index 79ac73bc..cf4d1382 100644 --- a/explore-hyperswitch/payment-experience/payment/mobile/cross-platform/flutter/customization.md +++ b/explore-hyperswitch/payment-experience/payment/mobile/cross-platform/flutter/customization.md @@ -6,7 +6,9 @@ icon: bars-progress # Customization {% hint style="info" %} + You can customize the Flutter Unified Checkout to supports visual customization, which allows you to match the design of your app + {% endhint %} You can modify colors, fonts, and more by using the instance of `appearance` class. @@ -77,14 +79,15 @@ Consider the below code for your reference. ``` {% hint style="info" %} + Set `displaySavedPaymentMethods` to false to disable saved cards. Set `displaySavedPaymentMethodsCheckbox` to false to stop your users from saving their payment methods.\ Set `disableBranding` to false to disable Hyperswitch branding.\ Set `primaryButtonLabel` to "Pay Button Text" to display custom text\ Set `paymentSheetHeaderLabel` to "Heading Text" to display custom heading -{% endhint %} +{% endhint %} ## Custom Placeholders And Branding @@ -106,7 +109,9 @@ configuration.disableBranding = true Finally, you can pass the object of PaymentSheetParams to `initPaymentSheet` as shown in the previous [section](flutter-with-node-backend.md#id-3.3-collect-payment-details). {% hint style="info" %} + Note To support dark mode, pass objects of `ColorsObject` class for both light and dark colors to constructor of `DynamicColors` class like below. + {% endhint %} ```dart @@ -172,14 +177,13 @@ Shapes shapes = Shapes(borderRadius:10.0, borderWidth: 10.0, shadow: shadow); Now you can test the payments on your app and go-live! - ## Languages Hyperswitch Flutter SDK supports localization in 6 languages. The default locale is English (en). To override, you can send locale in the appearance object. You may refer the below code for your reference. ```dart Appearance appearance = Appearance( - ... +... locale: 'LOCALE_CODE' ); ``` @@ -222,6 +226,8 @@ We support the following locales - ## Next step: {% content-ref url="../../../../../payment-orchestration/quickstart/payment-methods-setup/" %} + [payment-methods-setup](../../../../../payment-orchestration/quickstart/payment-methods-setup/) + {% endcontent-ref %} diff --git a/explore-hyperswitch/payment-experience/payment/mobile/cross-platform/flutter/flutter-with-node-backend.md b/explore-hyperswitch/payment-experience/payment/mobile/cross-platform/flutter/flutter-with-node-backend.md index 2312ba0a..9e4e7d65 100644 --- a/explore-hyperswitch/payment-experience/payment/mobile/cross-platform/flutter/flutter-with-node-backend.md +++ b/explore-hyperswitch/payment-experience/payment/mobile/cross-platform/flutter/flutter-with-node-backend.md @@ -6,7 +6,9 @@ icon: puzzle-piece # Flutter with REST API Integration {% hint style="info" %} + Use this guide to integrate `hyperswitch` SDK to your Flutter app. + {% endhint %} **Before following these steps, please configure your payment methods** [here](../../../../../payment-orchestration/quickstart/payment-methods-setup/cards.md). @@ -43,6 +45,7 @@ flutter pub get ``` {% hint style="info" %} + To apply plugins using Flutter, run the following command: ```sh @@ -50,6 +53,7 @@ dart run flutter_hyperswitch:apply_plugins ``` This command configures the necessary Flutter plugins for your project using the `flutter_hyperswitch` package. Ensure you have the package installed and configured correctly in your project. If you encounter any issues, check the package documentation for more details. + {% endhint %} ## 3. Complete the checkout on the client @@ -65,7 +69,9 @@ _hyper.init(HyperConfig(publishableKey: 'YOUR_PUBLISHABLE_KEY', customBackendUrl ``` {% hint style="info" %} + When utilising a custom backend or logging system, you can add the customBackendUrl to HyperConfig + {% endhint %} ### 3.2 Create a Payment Intent @@ -99,6 +105,7 @@ To display the Payment Sheet, integrate a "**Pay Now**" button within the checko Consider the below function, it invokes `presentPaymentSheet` and handles payment results. {% code fullWidth="false" %} + ```dart Future _presentPaymentSheet() async { final presentPaymentSheetResponse = await _hyper.presentPaymentSheet(_sessionId!); @@ -116,16 +123,22 @@ Future _presentPaymentSheet() async { } } ``` + {% endcode %} Congratulations! Now that you have integrated the Flutter SDK, you can [**customize**](customization.md) the payment sheet to blend with the rest of your app. {% hint style="danger" %} + Please retrieve the payment status from the Hyperswitch backend to get the terminal status of the payment. Do not rely solely on the status returned by the SDK, as it may not always reflect the final state of the transaction. + {% endhint %} ## Next step: {% content-ref url="../../../../../payment-orchestration/quickstart/payment-methods-setup/" %} + [payment-methods-setup](../../../../../payment-orchestration/quickstart/payment-methods-setup/) + {% endcontent-ref %} + diff --git a/explore-hyperswitch/payment-experience/payment/mobile/cross-platform/flutter/headless.md b/explore-hyperswitch/payment-experience/payment/mobile/cross-platform/flutter/headless.md index 31e91457..58cb788b 100644 --- a/explore-hyperswitch/payment-experience/payment/mobile/cross-platform/flutter/headless.md +++ b/explore-hyperswitch/payment-experience/payment/mobile/cross-platform/flutter/headless.md @@ -1,6 +1,6 @@ --- description: >- - Hyperswitch is designed to facilitate the integration and management of + Juspay Hyperswitch is designed to facilitate the integration and management of payment-related functionalities in a decoupled or headless architecture with flexibility to customize your checkout UI. icon: table-cells-large @@ -26,7 +26,9 @@ _hyper.init(HyperConfig(publishableKey: 'YOUR_PUBLISHABLE_KEY')); Make a request to the endpoint on your server to create a new Payment. The `clientSecret` returned by your endpoint is used to initialize the payment session. {% hint style="danger" %} + **Important**: Make sure to never share your API key with your client application as this could potentially compromise your security + {% endhint %} #### 3. Initialize your Payment Session @@ -75,7 +77,6 @@ Future _confirmPayment() async { ``` - **Payload for** `confirmWithCustomerLastUsedPaymentMethod(callback)`
options (Required)Description
callback (function)Callback to get confirm response.
diff --git a/explore-hyperswitch/payment-experience/payment/mobile/cross-platform/react-native/customization.md b/explore-hyperswitch/payment-experience/payment/mobile/cross-platform/react-native/customization.md index c624effe..5c2e56e9 100644 --- a/explore-hyperswitch/payment-experience/payment/mobile/cross-platform/react-native/customization.md +++ b/explore-hyperswitch/payment-experience/payment/mobile/cross-platform/react-native/customization.md @@ -6,7 +6,9 @@ icon: bars-progress # Customization {% hint style="info" %} + You can customize the React Native Unified Checkout to supports visual customization, which allows you to match the design of your app + {% endhint %} ## Appearance diff --git a/explore-hyperswitch/payment-experience/payment/mobile/cross-platform/react-native/expo-integration.md b/explore-hyperswitch/payment-experience/payment/mobile/cross-platform/react-native/expo-integration.md index 45726b98..20ab965f 100644 --- a/explore-hyperswitch/payment-experience/payment/mobile/cross-platform/react-native/expo-integration.md +++ b/explore-hyperswitch/payment-experience/payment/mobile/cross-platform/react-native/expo-integration.md @@ -1,12 +1,15 @@ --- +description: Integrate Hyperswitch SDK with Expo React Native applications icon: react --- # Expo integration {% hint style="info" %} + **Note:** **Expo Go is not supported.**\ The Hyperswitch SDK uses native modules, so the app must be built with native Android and iOS code. + {% endhint %} ## 1. Install Required Dependencies diff --git a/explore-hyperswitch/payment-experience/payment/mobile/cross-platform/react-native/headless.md b/explore-hyperswitch/payment-experience/payment/mobile/cross-platform/react-native/headless.md index ea0cd4df..73a2616a 100644 --- a/explore-hyperswitch/payment-experience/payment/mobile/cross-platform/react-native/headless.md +++ b/explore-hyperswitch/payment-experience/payment/mobile/cross-platform/react-native/headless.md @@ -1,6 +1,6 @@ --- description: >- - Hyperswitch is designed to facilitate the integration and management of + Juspay Hyperswitch is designed to facilitate the integration and management of payment-related functionalities in a decoupled or headless architecture with flexibility to customize your checkout UI. icon: table-cells-large @@ -31,7 +31,9 @@ function App() { Make a request to the endpoint on your server to create a new Payment. The `clientSecret` returned by your endpoint is used to initialize the payment session. {% hint style="danger" %} + **Important**: Make sure to never share your API key with your client application as this could potentially compromise your security + {% endhint %} #### 3. Initialize your Payment Session @@ -86,7 +88,7 @@ React.useEffect(()=>{ },[]) let confirmDefaultPaymentMethod = () => { -const status = await confirmWithCustomerLastUsedPaymentMethod(paymentMethodSession); +const `status = await` confirmWithCustomerLastUsedPaymentMethod(paymentMethodSession); // handle status of payment if (status != null) { const message = status.message; @@ -101,7 +103,6 @@ return ( ``` - **Payload for** `confirmWithCustomerLastUsedPaymentMethod(callback)`
options (Required)Description
callback (function)Callback to get confirm response.
diff --git a/explore-hyperswitch/payment-experience/payment/mobile/cross-platform/react-native/react-native-with-node-backend-1.md b/explore-hyperswitch/payment-experience/payment/mobile/cross-platform/react-native/react-native-with-node-backend-1.md index 76116535..b1613c53 100644 --- a/explore-hyperswitch/payment-experience/payment/mobile/cross-platform/react-native/react-native-with-node-backend-1.md +++ b/explore-hyperswitch/payment-experience/payment/mobile/cross-platform/react-native/react-native-with-node-backend-1.md @@ -1,4 +1,5 @@ --- +description: Implement embedded payment widget in React Native applications icon: input-numeric --- @@ -55,8 +56,8 @@ Send a network request to the backend endpoint created in the previous step to r ```js useEffect(() => { fetch('https://your-server.com/create-payment-intent', { method: 'POST' }) - .then((res) => res.json()) - .then(({ clientSecret, sdkAuthorization, }) => { +.then((res) => res.json()) +.then(({ clientSecret, sdkAuthorization, }) => { setClientSecret(clientSecret)); setAuthorization(sdkAuthorization); } diff --git a/explore-hyperswitch/payment-experience/payment/mobile/cross-platform/react-native/react-native-with-rest-api-integration.md b/explore-hyperswitch/payment-experience/payment/mobile/cross-platform/react-native/react-native-with-rest-api-integration.md index f5bde65c..18ca6f6c 100644 --- a/explore-hyperswitch/payment-experience/payment/mobile/cross-platform/react-native/react-native-with-rest-api-integration.md +++ b/explore-hyperswitch/payment-experience/payment/mobile/cross-platform/react-native/react-native-with-rest-api-integration.md @@ -6,7 +6,9 @@ icon: puzzle-piece # React Native with REST API Integration {% hint style="info" %} + Use this guide to integrate `hyperswitch` React Native SDK to your React Native app. You can use the following Demo App as a reference with your Hyperswitch credentials to test the setup. + {% endhint %} ## Find the demo app [here](https://github.com/juspay/react-native-hyperswitch) @@ -178,7 +180,9 @@ return ( ``` {% hint style="danger" %} + Retrieve the **payment status from the Hyperswitch backend** to determine the final (terminal) status of the transaction. Do not rely solely on the status returned by the SDK, as it may not always represent the definitive outcome of the payment. + {% endhint %} Congratulations! Now that you have integrated the payment sheet diff --git a/explore-hyperswitch/payment-experience/payment/mobile/cross-platform/troubleshooting.md b/explore-hyperswitch/payment-experience/payment/mobile/cross-platform/troubleshooting.md index 8c2b7f33..e707dfb5 100644 --- a/explore-hyperswitch/payment-experience/payment/mobile/cross-platform/troubleshooting.md +++ b/explore-hyperswitch/payment-experience/payment/mobile/cross-platform/troubleshooting.md @@ -1,3 +1,7 @@ +--- +description: Troubleshoot common issues with React Native and Flutter SDKs +--- + # Troubleshooting ## Android diff --git a/explore-hyperswitch/payment-experience/payment/mobile/ios/customization.md b/explore-hyperswitch/payment-experience/payment/mobile/ios/customization.md index a05b55bd..4938616f 100644 --- a/explore-hyperswitch/payment-experience/payment/mobile/ios/customization.md +++ b/explore-hyperswitch/payment-experience/payment/mobile/ios/customization.md @@ -6,7 +6,9 @@ icon: bars-progress # Customization {% hint style="info" %} + You can customize the iOS Unified Checkout to support your checkout context and brand guidelines by changing fonts, colours, shapes and layouts. + {% endhint %} Create a `PaymentSheet.Configuration` object with an `appearance` object in order to be able to match the design of your app. diff --git a/explore-hyperswitch/payment-experience/payment/mobile/ios/headless.md b/explore-hyperswitch/payment-experience/payment/mobile/ios/headless.md index cec2fa4f..3ccb050f 100644 --- a/explore-hyperswitch/payment-experience/payment/mobile/ios/headless.md +++ b/explore-hyperswitch/payment-experience/payment/mobile/ios/headless.md @@ -1,6 +1,6 @@ --- description: >- - Hyperswitch is designed to facilitate the integration and management of + Juspay Hyperswitch is designed to facilitate the integration and management of payment-related functionalities in a decoupled or headless architecture with flexibility to customize your checkout UI. icon: table-cells-large @@ -24,7 +24,9 @@ paymentSession = PaymentSession(publishableKey: publishableKey) Make a request to the endpoint on your server to create a new Payment. The `clientSecret` returned by your endpoint is used to initialize the payment session. {% hint style="danger" %} + **Important**: Make sure to never share your API key with your client application as this could potentially compromise your security + {% endhint %} #### 3. Initialize your Payment Session diff --git a/explore-hyperswitch/payment-experience/payment/mobile/ios/lite-sdk.md b/explore-hyperswitch/payment-experience/payment/mobile/ios/lite-sdk.md index 6aee33df..3660cfc0 100644 --- a/explore-hyperswitch/payment-experience/payment/mobile/ios/lite-sdk.md +++ b/explore-hyperswitch/payment-experience/payment/mobile/ios/lite-sdk.md @@ -1,4 +1,5 @@ --- +description: Integrate lightweight iOS SDK for payments with minimal bundle size icon: mobile-screen --- @@ -72,11 +73,11 @@ paymentSession.presentPaymentSheetLite( result in DispatchQueue.main.async { switch result { - case .completed: + case.completed: self.statusLabel.text = "Payment complete" - case .failed(let error): + case.failed(let error): self.statusLabel.text = "Payment failed: \(error)" - case .canceled: + case.canceled: self.statusLabel.text = "Payment canceled." } } diff --git a/explore-hyperswitch/payment-experience/payment/mobile/ios/swift-with-rest-api-integration.md b/explore-hyperswitch/payment-experience/payment/mobile/ios/swift-with-rest-api-integration.md index 471360c0..f6754244 100644 --- a/explore-hyperswitch/payment-experience/payment/mobile/ios/swift-with-rest-api-integration.md +++ b/explore-hyperswitch/payment-experience/payment/mobile/ios/swift-with-rest-api-integration.md @@ -6,7 +6,9 @@ icon: swift # Swift with REST API Integration {% hint style="info" %} + Use this guide to integrate Hyperswitch SDK to your iOS app. You can use the following [app](https://github.com/aashu331998/Hyperswitch-iOS-Demo-App/archive/refs/heads/main.zip) as a reference with your Hyperswitch credentials to test the setup. You can also checkout the [app on Apple Testflight](https://testflight.apple.com/join/WhPLmrT6) to test the payment flow. + {% endhint %} ## Requirements @@ -21,7 +23,7 @@ Follow the [Server Setup](../../server-setup.md) section. ## 2. Build checkout page on your app -### 2.1 Configure your repository with Hyperswitch dependency +### 2.1 Configure your repository with Juspay Hyperswitch dependency CocoaPods Setup (only required if not already done) @@ -50,7 +52,7 @@ Run the following command: pod install ``` -**Remember that moving forward, you should open your project in Xcode using the .xcworkspace file rather than the .xcodeproj file.** +**Remember that moving forward, you should open your project in Xcode using the.xcworkspace file rather than the.xcodeproj file.** To update to the latest version of the SDK, run: @@ -67,13 +69,15 @@ Set up the SDK using your publishable key. This is essential for initializing a
{% hint style="warning" %} -Note: For Open Source Setup, initialise your custom Backend app & log URL as: + +> **Note:** For Open Source Setup, initialise your custom Backend app & log URL as: ```swift paymentSession = PaymentSession(publishableKey: , customBackendUrl: , customLogUrl: ) ``` + {% endhint %} ### 2.3 Complete the payment on your app @@ -83,15 +87,19 @@ paymentSession = PaymentSession(publishableKey: , Request your server to fetch a payment as soon as your view is loaded. Store the client\_secret returned by your server. The `PaymentSession` will use this secret to complete the payment process. {% tabs %} + {% tab title="Swift" %} + ```swift var paymentSession: PaymentSession? paymentSession?.initPaymentSession(paymentIntentClientSecret: paymentIntentClientSecret) ``` + {% endtab %} {% tab title="SwiftUI" %} + ```swift @ObservedObject var model = BackendModel() @Published var paymentSheet: PaymentSession? @@ -105,7 +113,9 @@ func onPaymentCompletion(result: PaymentSheetResult) { } paymentSession?.initPaymentSession(paymentIntentClientSecret: paymentIntentClientSecret) ``` + {% endtab %} + {% endtabs %} #### **Handle Payment Result** @@ -113,7 +123,9 @@ paymentSession?.initPaymentSession(paymentIntentClientSecret: paymentIntentClien Handle the payment result in the completion block and display appropriate messages to your customer based on whether the payment fails with an error or succeeds. {% tabs %} + {% tab title="Swift" %} + ```swift @objc func openPaymentSheet(_ sender: Any) { //present payment sheet @@ -125,11 +137,11 @@ configuration.merchantDisplayName = "Example, Inc." configuration: configuration, completion: { result in switch result { - case .completed: + case.completed: print("Payment complete") - case .failed(let error): + case.failed(let error): print("Payment failed: \(error.localizedDescription)") - case .canceled: + case.canceled: print("Payment canceled.") } }) @@ -137,11 +149,15 @@ configuration.merchantDisplayName = "Example, Inc." ``` {% hint style="danger" %} + Please retrieve the payment status from the Hyperswitch backend to get the terminal status of the payment. Do not rely solely on the status returned by the SDK, as it may not always reflect the final state of the transaction. + {% endhint %} + {% endtab %} {% tab title="SwiftUI" %} + ```swift VStack { if let paymentSession = model.paymentSession { @@ -150,19 +166,19 @@ VStack { onCompletion: model.onPaymentCompletion) { Text("Hyper Payment Sheet") - .padding() - .background(.blue) - .foregroundColor(.white) - .cornerRadius(10.0) +.padding() +.background(.blue) +.foregroundColor(.white) +.cornerRadius(10.0) } if let result = model.paymentResult { switch result { - case .completed: + case.completed: Text("Payment complete") - case .failed(let error): + case.failed(let error): Text("Payment failed: \(error.domain)") - case .canceled: + case.canceled: Text("Payment canceled.") } } @@ -176,7 +192,9 @@ func configuration() -> PaymentSheet.Configuration { return configuration } ``` + {% endtab %} + {% endtabs %} ### 3. Card Element (Beta) @@ -184,7 +202,9 @@ func configuration() -> PaymentSheet.Configuration { Create a card element view and pay button and handle the payment result in the completion block and display appropriate messages to your customer based on whether the payment fails with an error or succeeds. {% tabs %} + {% tab title="Swift" %} +
//Create a card element view and pay button.
 lazy var hyperCardTextField: PaymentCardTextField = {
     let cardTextField = PaymentCardTextField()
@@ -192,11 +212,11 @@ Create a card element view and pay button and handle the payment result in the c
 }()
 
 lazy var payButton: UIButton = {
-    let button = UIButton(type: .custom)
+    let button = UIButton(type:.custom)
     button.layer.cornerRadius = 5
-    button.backgroundColor = .systemBlue
-    button.setTitle("Pay", for: .normal)
-    button.addTarget(self, action: #selector(pay), for: .touchUpInside)
+    button.backgroundColor =.systemBlue
+    button.setTitle("Pay", for:.normal)
+    button.addTarget(self, action: #selector(pay), for:.touchUpInside)
     return button
 }()
 
@@ -212,11 +232,11 @@ let paymentHandler = PaymentHandler.shared()
     paymentHandler.confirmPayment(paymentIntentParams, with: self) { 
         (status, paymentIntent, error) in
             switch (status) {
-                case .failed:
+                case.failed:
                     break
-                case .canceled:
+                case.canceled:
                     break
-                case .succeeded:
+                case.succeeded:
                     break
                 @unknown default:
                     fatalError()
@@ -225,16 +245,18 @@ let paymentHandler = PaymentHandler.shared()
     }
 }
 
+ {% endtab %} {% tab title="SwiftUI" %} + ```swift @ObservedObject var model = BackendModel() @State var paymentMethodParams: PaymentMethodParams? VStack { PaymentCardTextField.Representable(paymentMethodParams: $paymentMethodParams) - .padding() +.padding() //Create a card element view and pay button. if let paymentIntent = model.paymentIntentParams { Button("Buy") @@ -242,8 +264,8 @@ VStack { paymentIntent.paymentMethodParams = paymentMethodParams isConfirmingPayment = true } - .disabled(isConfirmingPayment || paymentMethodParams == nil) - .paymentConfirmationSheet( +.disabled(isConfirmingPayment || paymentMethodParams == nil) +.paymentConfirmationSheet( isConfirmingPayment: $isConfirmingPayment, paymentIntentParams: paymentIntent, onCompletion: model.onCompletion @@ -258,7 +280,9 @@ VStack { } }.onAppear { model.preparePaymentIntent() } ``` + {% endtab %} + {% endtabs %} Congratulations! Now that you have integrated the iOS SDK, you can customize the payment sheet to blend with the rest of your app. @@ -266,5 +290,8 @@ Congratulations! Now that you have integrated the iOS SDK, you can customize the ## Next step: {% content-ref url="../../../../payment-orchestration/quickstart/payment-methods-setup/" %} + [payment-methods-setup](../../../../payment-orchestration/quickstart/payment-methods-setup/) + {% endcontent-ref %} + diff --git a/explore-hyperswitch/payment-experience/payment/over-the-air-ota-updates/android.md b/explore-hyperswitch/payment-experience/payment/over-the-air-ota-updates/android.md index 50fb85dc..22bb4558 100644 --- a/explore-hyperswitch/payment-experience/payment/over-the-air-ota-updates/android.md +++ b/explore-hyperswitch/payment-experience/payment/over-the-air-ota-updates/android.md @@ -1,4 +1,5 @@ --- +description: Configure over-the-air updates for Juspay Hyperswitch Android SDK icon: android --- @@ -27,9 +28,11 @@ HyperOTAReact( ``` {% hint style="info" %} + Replace `hyperOTAUrl` with your environment-specific endpoint. `Example : $baseURL/mobile-ota/android/${BuildConfig.VERSION_NAME}/config.json` + {% endhint %} 2. In your `MainApplication` class, ensure `getJSBundleFile()` uses the bundle path from HyperOTA and falls back to the default asset if necessary diff --git a/explore-hyperswitch/payment-experience/payment/over-the-air-ota-updates/ios.md b/explore-hyperswitch/payment-experience/payment/over-the-air-ota-updates/ios.md index c20cf8c6..e5c6eea9 100644 --- a/explore-hyperswitch/payment-experience/payment/over-the-air-ota-updates/ios.md +++ b/explore-hyperswitch/payment-experience/payment/over-the-air-ota-updates/ios.md @@ -1,4 +1,5 @@ --- +description: Configure over-the-air updates for Juspay Hyperswitch iOS SDK icon: apple --- @@ -30,9 +31,11 @@ HyperOTAServices(payload: payload, ``` {% hint style="info" %} + Make sure `releaseConfigURL` points to the `config.json` for the correct SDK version and environment. `Example : $baseURL/mobile-ota/ios/${BuildConfig.VERSION_NAME}/config.json` + {% endhint %} For more information, [Airborne](https://github.com/juspay/airborne) diff --git a/explore-hyperswitch/payment-experience/payment/over-the-air-ota-updates/server-setup.md b/explore-hyperswitch/payment-experience/payment/over-the-air-ota-updates/server-setup.md index f1312883..f365fc7d 100644 --- a/explore-hyperswitch/payment-experience/payment/over-the-air-ota-updates/server-setup.md +++ b/explore-hyperswitch/payment-experience/payment/over-the-air-ota-updates/server-setup.md @@ -1,11 +1,11 @@ --- +description: Set up server infrastructure for over-the-air SDK updates icon: server --- # Server setup - ​Airborne requires a backend endpoint to serve the **`config.json`** and updated bundles to client apps. This server is responsible for: * Hosting `config.json` files for each app version and environment (Sandbox, Production). diff --git a/explore-hyperswitch/payment-experience/payment/payment-links/README.md b/explore-hyperswitch/payment-experience/payment/payment-links/README.md index 11e3f4bb..8807bbee 100644 --- a/explore-hyperswitch/payment-experience/payment/payment-links/README.md +++ b/explore-hyperswitch/payment-experience/payment/payment-links/README.md @@ -20,7 +20,9 @@ Introducing Payment Links - Seamlessly integrate into Hyperswitch without writin * Streamlining over-the-phone transactions {% embed url="https://www.youtube.com/watch?v=8SGyP3kIpQo" %} + API Level Overview of Payment Links with Hyperswitch + {% endembed %} ### FAQ @@ -70,5 +72,8 @@ Hyperswitch supports generation of the payment link. We are not integrated with ## Next step: {% content-ref url="configurations.md" %} + [configurations.md](configurations.md) + {% endcontent-ref %} + diff --git a/explore-hyperswitch/payment-experience/payment/payment-links/configurations.md b/explore-hyperswitch/payment-experience/payment/payment-links/configurations.md index 2b6a5d03..56248c51 100644 --- a/explore-hyperswitch/payment-experience/payment/payment-links/configurations.md +++ b/explore-hyperswitch/payment-experience/payment/payment-links/configurations.md @@ -177,7 +177,9 @@ A custom domain for hosting payment links. This is for configuring multiple styles. This is a key value pair where key represents the style ID and value is the UI configurations which were mentioned above. {% hint style="info" %} + For comprehensive guidance on Style IDs, text consistency best practices, and multi-brand customization strategies, see the [Theme configurations Guide](theme-configurations-guide.md). + {% endhint %} Example: @@ -292,5 +294,8 @@ curl --location '{{BASE_URL}}/account/{{MERCHANT_ID}}/business_profile/{{PROFILE ### Next step: {% content-ref url="create-payment-links.md" %} + [create-payment-links.md](create-payment-links.md) + {% endcontent-ref %} + diff --git a/explore-hyperswitch/payment-experience/payment/payment-links/create-payment-links.md b/explore-hyperswitch/payment-experience/payment/payment-links/create-payment-links.md index 8b7d343a..ce8c1376 100644 --- a/explore-hyperswitch/payment-experience/payment/payment-links/create-payment-links.md +++ b/explore-hyperswitch/payment-experience/payment/payment-links/create-payment-links.md @@ -88,5 +88,8 @@ curl --location '{{BASE_URL}}/payments' \ ### Next step: {% content-ref url="secure-payment-links.md" %} + [secure-payment-links.md](secure-payment-links.md) + {% endcontent-ref %} + diff --git a/explore-hyperswitch/payment-experience/payment/payment-links/secure-payment-links.md b/explore-hyperswitch/payment-experience/payment/payment-links/secure-payment-links.md index 353838ea..9e496e78 100644 --- a/explore-hyperswitch/payment-experience/payment/payment-links/secure-payment-links.md +++ b/explore-hyperswitch/payment-experience/payment/payment-links/secure-payment-links.md @@ -54,7 +54,7 @@ The response includes the following fields: ``` { - ... +... "payment_link": { "link": "http://localhost:8080/payment_link/merchant_1734676749/pay_Dw4CBoUWGGkvSXcfz1Mu?locale=en", @@ -62,7 +62,7 @@ The response includes the following fields: "payment_link_id": "plink_lF9deXMRrdIEs1drMVhF" }, - ... +... } ``` @@ -103,5 +103,8 @@ To embed a secure payment link, include it in an iframe within your HTML: ### Next step: {% content-ref url="setup-custom-domain.md" %} + [setup-custom-domain.md](setup-custom-domain.md) + {% endcontent-ref %} + diff --git a/explore-hyperswitch/payment-experience/payment/payment-links/setup-custom-domain.md b/explore-hyperswitch/payment-experience/payment/payment-links/setup-custom-domain.md index dd2ac02f..c4de6104 100644 --- a/explore-hyperswitch/payment-experience/payment/payment-links/setup-custom-domain.md +++ b/explore-hyperswitch/payment-experience/payment/payment-links/setup-custom-domain.md @@ -4,7 +4,7 @@ description: Setup custom domains # Setup Custom Domain -A custom domain name can be used for payment links. This is your own domain name which is configured at HyperSwitch side. For doing this, contact us and we will get it configured and give you a TLS certificate. +A custom domain name can be used for payment links. This is your own domain name which is configured at Juspay Hyperswitch side. For doing this, contact us and we will get it configured and give you a TLS certificate. ## How to setup custom domain within your cloud @@ -40,7 +40,7 @@ Step 3: Create CNAME record Enter the following values and save the new DNS record. -> \| FIELD | INSTRUCTIONS | DESCRIPTION | |----------|----------|----------| | Type | Select `CNAME` from the dropdown | What kind of DNS record this is. | | Name | if your custom domain is `paymentlink.xyz.com`, enter `paymentlink`| For CNAME records, this field is the first part of your subdomain (the part leading up to the first period).| | Value |Enter `sandbox.hyperswitch.io` | This is what the new subdomain record points to–in this case, Hyperswitch .Some providers may expect a trailing period (.) after the CNAME value. Make sure to verify that your CNAME value matches the format your provider expects. | | TTL/Expiry | Enter `300` | An expiration of 5 minutes (300 seconds) is OK. Your DNS provider might not allow you to change the TTL value. If this field is missing or you can’t change it, it’s safe to ignore this part of the configuration. | +> \| FIELD | INSTRUCTIONS | DESCRIPTION | |----------|----------|----------| | Type | Select `CNAME` from the dropdown | What kind of DNS record this is. | | Name | if your custom domain is `paymentlink.xyz.com`, enter `paymentlink`| For CNAME records, this field is the first part of your subdomain (the part leading up to the first period).| | Value |Enter `sandbox.hyperswitch.io` | This is what the new subdomain record points to–in this case, Hyperswitch.Some providers may expect a trailing period (.) after the CNAME value. Make sure to verify that your CNAME value matches the format your provider expects. | | TTL/Expiry | Enter `300` | An expiration of 5 minutes (300 seconds) is OK. Your DNS provider might not allow you to change the TTL value. If this field is missing or you can’t change it, it’s safe to ignore this part of the configuration. | Step 4: Create your TXT record diff --git a/explore-hyperswitch/payment-experience/payment/payment-links/theme-configurations-guide.md b/explore-hyperswitch/payment-experience/payment/payment-links/theme-configurations-guide.md index 3fb6d275..140577b9 100644 --- a/explore-hyperswitch/payment-experience/payment/payment-links/theme-configurations-guide.md +++ b/explore-hyperswitch/payment-experience/payment/payment-links/theme-configurations-guide.md @@ -16,7 +16,9 @@ Style IDs are design templates for your payment links, allowing you to create di * Language preferences (we support 19+ languages including English, Hebrew, Arabic, Japanese, German, Spanish, Chinese, and more!) {% hint style="info" %} + **Important:** Custom terms and conditions can only be configured when using a custom domain for your payment links. By default, payment links are hosted on the Hyperswitch domain. To use custom domains and unlock the ability to set custom terms and conditions, please refer to our [Setup Custom Domain](setup-custom-domain.md) guide. + {% endhint %} **How it works:** When creating a payment link, simply specify which style ID you want to use (via the `payment_link_config_id` parameter), and your customers will see that themed experience. diff --git a/explore-hyperswitch/payment-experience/payment/server-setup.md b/explore-hyperswitch/payment-experience/payment/server-setup.md index 8fed0508..fd2039dc 100644 --- a/explore-hyperswitch/payment-experience/payment/server-setup.md +++ b/explore-hyperswitch/payment-experience/payment/server-setup.md @@ -1,4 +1,5 @@ --- +description: Set up server-side payment creation and SDK integration icon: server --- @@ -39,12 +40,15 @@ async function createPaymentIntent(request) { ### Integrate Web SDK -_To integrate Web SDK, follow React , HTML and JS with REST API Integration._ +_To integrate Web SDK, follow React, HTML and JS with REST API Integration._ ### Integrate Mobile SDK -_To integrate mobile SDK, follow Kotlin, Swift_ , _React Native , and Flutter with REST API Integration_ +_To integrate mobile SDK, follow Kotlin, Swift_, _React Native, and Flutter with REST API Integration_ {% hint style="info" %} + In case your integrating the ExpressCheckout (mentioned later below), instead of creating multiple paymentIntents for the same customer session, you can also use [paymentsUpdate API](https://api-reference.hyperswitch.io/api-reference/payments/payments--update) for better analytics. + {% endhint %} + diff --git a/explore-hyperswitch/payment-experience/payment/web/README.md b/explore-hyperswitch/payment-experience/payment/web/README.md index 76ed4269..b9a09a31 100644 --- a/explore-hyperswitch/payment-experience/payment/web/README.md +++ b/explore-hyperswitch/payment-experience/payment/web/README.md @@ -26,11 +26,14 @@ While the Unified Checkout is pre-optimized for maximum conversions, Hyperswitch You can further optimize Unified Checkout web SDK by preloading all the resources that are needed by the iframe. By the time iframe is to be mounted (checkout button), everything that is required can be fetched from their server and stored in the disk cache. -* `` wrapper has to be used in the top-level of the merchants app , say web app has two pages eg: homepage and checkout page, the wrapper must be added in the homepage itself. +* `` wrapper has to be used in the top-level of the merchants app, say web app has two pages eg: homepage and checkout page, the wrapper must be added in the homepage itself. * `` has the required props to load our Hyperloader (script) which will 1. Preload the all the resources that are required by the SDK ie. files, svgs, icons, css, fonts etc. 2. Prefetch the two main API calls and is ready with response {% hint style="success" %} + **This will significantly decrease the SDK load time from \~10-15s (in slow 3G network) to just \~1-5ms.** + {% endhint %} + diff --git a/explore-hyperswitch/payment-experience/payment/web/customization.md b/explore-hyperswitch/payment-experience/payment/web/customization.md index 010a540a..e38ec8b2 100644 --- a/explore-hyperswitch/payment-experience/payment/web/customization.md +++ b/explore-hyperswitch/payment-experience/payment/web/customization.md @@ -117,7 +117,9 @@ var paymentElementOptions = { ``` {% hint style="info" %} -Note: Currently, only Google Pay, Apple Pay, and PayPal (Redirect) support being moved into the layout. Other one-click methods are hidden when this option is disabled. + +> **Note:** Currently, only Google Pay, Apple Pay, and PayPal (Redirect) support being moved into the layout. Other one-click methods are hidden when this option is disabled. + {% endhint %} ## 2. Wallets @@ -190,12 +192,12 @@ The Styling APIs could be used to blend the Unified Checkout with the rest of yo The rules option is a map of CSS-like selectors to CSS properties, allowing granular customization of individual components. After defining your theme and variables, use rules to seamlessly integrate Elements to match the design of your site. The selector for a rule can target any of the public class names in the Element, as well as the supported states, pseudo-classes, and pseudo-elements for each class. For example, the following are valid selectors: -* .Tab, .Label, .Input, .InputLogo, .SaveWalletDetailsLabel, .OrPayUsingLabel, .TermsTextLabel, .InfoElement, .OrPayUsingLine -* .Tab:focus -* .Input--invalid, .Label--invalid, .InputLogo--invalid -* .Input::placeholder -* .billing-section, .billing-details-text -* .Input--empty, .InputLogo--empty +*.Tab,.Label,.Input,.InputLogo,.SaveWalletDetailsLabel,.OrPayUsingLabel,.TermsTextLabel,.InfoElement,.OrPayUsingLine +*.Tab:focus +*.Input--invalid,.Label--invalid,.InputLogo--invalid +*.Input::placeholder +*.billing-section,.billing-details-text +*.Input--empty,.InputLogo--empty Each class name used in a selector supports an allowlist of CSS properties that you specify using camel case (for example, boxShadow for the box-shadow property). The following is the complete list of supported class names and corresponding states, pseudo-classes, and pseudo-elements. @@ -205,14 +207,14 @@ Each class name used in a selector supports an allowlist of CSS properties that | Class Name | States | Pseudo-Classes | Pseudo-Elements | | ------------ | ---------- | ---------------------------------- | --------------- | -| .Tabs | --selected | :hover, :focus, :active, :disabled | | +|.Tabs | --selected | :hover, :focus, :active, :disabled | | | fontSizeBase | --selected | :hover, :focus, :active, :disabled | | | spacingUnit | --selected | :hover, :focus, :active, :disabled | | -* .Tab, .Label, .Input -* .Tab:focus -* .Input--invalid, .Label--invalid -* .Input::placeholder +*.Tab,.Label,.Input +*.Tab:focus +*.Input--invalid,.Label--invalid +*.Input::placeholder Each class name used in a selector supports an allowlist of CSS properties that you specify using camel case (for example, boxShadow for the box-shadow property). The following is the complete list of supported class names and corresponding states, pseudo-classes, and pseudo-elements. @@ -221,7 +223,7 @@ const appearance = { variables: { buttonBackgroundColor: "#FFFFFF", buttonTextColor: "#000000", - // ... along with other variables + //... along with other variables }, rules: { ".TabLabel": { @@ -263,9 +265,9 @@ const elements = hyper.elements({ clientSecret, appearance }); | Class Name | States | Pseudo-Classes | Pseudo-Elements | | ---------- | ------------------ | ------------------------------------ | -------------------------- | -| .Label | --empty, --invalid | | | -| .Input | --empty, --invalid | :hover, :focus, :disabled, :autofill | ::placeholder, ::selection | -| .Error | | | | +|.Label | --empty, --invalid | | | +|.Input | --empty, --invalid | :hover, :focus, :disabled, :autofill | ::placeholder, ::selection | +|.Error | | | | ### Checkbox @@ -273,9 +275,9 @@ const elements = hyper.elements({ clientSecret, appearance }); | Class Name | States | Pseudo-Classes | Pseudo-Elements | | -------------- | --------- | -------------- | --------------- | -| .Checkbox | --checked | :hover | | -| .CheckboxLabel | --checked | :hover | | -| .CheckboxInput | --checked | :hover | | +|.Checkbox | --checked | :hover | | +|.CheckboxLabel | --checked | :hover | | +|.CheckboxInput | --checked | :hover | | ### InputLogo @@ -283,9 +285,9 @@ const elements = hyper.elements({ clientSecret, appearance }); | Class Name | States | Pseudo-Classes | Pseudo-Elements | | ---------- | --------- | -------------- | --------------- | -| .InputLogo | | :hover | | -| .InputLogo | --invalid | :hover, | | -| .InputLogo | --empty | :hover | | +|.InputLogo | | :hover | | +|.InputLogo | --invalid | :hover, | | +|.InputLogo | --empty | :hover | | ### SaveWalletDetailsLabel @@ -293,7 +295,7 @@ const elements = hyper.elements({ clientSecret, appearance }); | Class Name | States | Pseudo-Classes | Pseudo-Elements | | ----------------------- | ------ | -------------- | --------------- | -| .SaveWalletDetailsLabel | | :hover | | +|.SaveWalletDetailsLabel | | :hover | | ### OrPayUsingLabel @@ -301,7 +303,7 @@ const elements = hyper.elements({ clientSecret, appearance }); | Class Name | States | Pseudo-Classes | Pseudo-Elements | | ---------------- | ------ | -------------- | --------------- | -| .OrPayUsingLabel | | :hover | | +|.OrPayUsingLabel | | :hover | | ### OrPayUsingLine @@ -309,7 +311,7 @@ const elements = hyper.elements({ clientSecret, appearance }); | Class Name | States | Pseudo-Classes | Pseudo-Elements | | --------------- | ------ | -------------- | --------------- | -| .OrPayUsingLine | | :hover | | +|.OrPayUsingLine | | :hover | | ### TermsTextLabel @@ -317,7 +319,7 @@ const elements = hyper.elements({ clientSecret, appearance }); | Class Name | States | Pseudo-Classes | Pseudo-Elements | | --------------- | ------ | -------------- | --------------- | -| .TermsTextLabel | | :hover | | +|.TermsTextLabel | | :hover | | ### InfoElement @@ -325,7 +327,7 @@ const elements = hyper.elements({ clientSecret, appearance }); | Class Name | States | Pseudo-Classes | Pseudo-Elements | | ------------ | ------ | -------------- | --------------- | -| .InfoElement | | :hover | | +|.InfoElement | | :hover | | ## 5. Languages @@ -376,7 +378,7 @@ The Styling APIs could be used to blend the Confirm Payment Button (handled by S You can decide whether to display the Hyperswitch branding using the `branding` prop
var paymentElementOptions = {
- ...,
+...,
  branding: "never", // choose between "never" and "always"
 }
 
@@ -388,7 +390,7 @@ You can decide whether to display the Hyperswitch branding using the `branding`
 Customize the header text for the section displaying available payment methods.
 
 
var paymentElementOptions = {
- ...,
+...,
  paymentMethodsHeaderText: "Select Payment Method",
 }
 
@@ -400,7 +402,7 @@ Customize the header text for the section displaying available payment methods.
 Customize the header text for the section displaying saved payment methods.
 
 
var paymentElementOptions = {
- ...,
+...,
  savedPaymentMethodsHeaderText: "Saved Payment Methods",
 }
 
@@ -418,7 +420,7 @@ We provide a default message for card terms i.e.
 If you would like to customize this message, you can do so by using the `customMessageForCardTerms` property in the `paymentElementOptions` object.
 
 
var paymentElementOptions = {
- ...,
+...,
  customMessageForCardTerms: "Custom message for Card terms",
 }
 
@@ -431,7 +433,7 @@ The `hideCardNicknameField` property allows you to hide the card nickname field
 
 ```javascript
 var paymentElementOptions = {
-  ...,
+...,
   hideCardNicknameField: true,  // default - false
 };
 
@@ -444,7 +446,7 @@ The `hideExpiredPaymentMethods` property allows you to control whether expired s
 
 ```javascript
 var paymentElementOptions = {
-  ...,
+...,
   hideExpiredPaymentMethods: false, // default - false
 };
 
@@ -457,7 +459,7 @@ The `terms` property allows you to configure the display of terms for various pa
 
 ```javascript
 var paymentElementOptions = {
-  ...,
+...,
   terms: {
     auBecsDebit: "always",
     bancontact: "auto",
@@ -478,7 +480,7 @@ The `displaySavedPaymentMethods` property determines whether saved payment metho
 
 ```javascript
 var paymentElementOptions = {
-  ...,
+...,
   displaySavedPaymentMethods: false,
 };
 
@@ -491,7 +493,7 @@ The `displaySavedPaymentMethodsCheckbox` property determines whether the "Save p
 
 ```javascript
 var paymentElementOptions = {
-  ...,
+...,
   displaySavedPaymentMethodsCheckbox: false, 
 };
 
@@ -504,7 +506,7 @@ The `savedPaymentMethodsCheckboxCheckedByDefault` property determines whether th
 
 ```javascript
 var paymentElementOptions = {
-  ...,
+...,
   savedPaymentMethodsCheckboxCheckedByDefault: false, // default - false
 };
 
@@ -517,7 +519,7 @@ The `paymentMethodOrder` property allows you to specify the order in which payme
 
 ```javascript
 var paymentElementOptions = {
-  ...,
+...,
   paymentMethodOrder: ["card", "ideal", "sepaDebit", "sofort"],
 };
 
@@ -530,7 +532,7 @@ The `business` property allows you to specify a business name to be attached to
 
 ```javascript
 var paymentElementOptions = {
-  ...,
+...,
   business: {
     name: "Example Business",
   },
@@ -545,7 +547,7 @@ The `readOnly` property puts the SDK into read-only mode, disabling all interact
 
 ```javascript
 var paymentElementOptions = {
-  ...,
+...,
   readOnly: true,
 };
 
@@ -557,12 +559,14 @@ var paymentElementOptions = {
 The `showShortSurchargeMessage` property allows merchants to display a short message when a surcharge is applied, instead of the default message provided by the SDK.
 
 {% hint style="success" %}
+
 The short message format will be: **`Fee: {Currency} {Amount}`**
+
 {% endhint %}
 
 ```javascript
 var paymentElementOptions = {
-  ...,
+...,
   showShortSurchargeMessage: true, // default - false
 };
 
@@ -572,5 +576,8 @@ var paymentElementOptions = {
 ## Next step:
 
 {% content-ref url="../../../payment-orchestration/quickstart/payment-methods-setup/" %}
+
 [payment-methods-setup](../../../payment-orchestration/quickstart/payment-methods-setup/)
+
 {% endcontent-ref %}
+
diff --git a/explore-hyperswitch/payment-experience/payment/web/headless.md b/explore-hyperswitch/payment-experience/payment/web/headless.md
index fc6b2125..b56a84a4 100644
--- a/explore-hyperswitch/payment-experience/payment/web/headless.md
+++ b/explore-hyperswitch/payment-experience/payment/web/headless.md
@@ -1,6 +1,6 @@
 ---
 description: >-
-  Hyperswitch is designed to facilitate the integration and management of
+  Juspay Hyperswitch is designed to facilitate the integration and management of
   payment-related functionalities in a decoupled or headless architecture with
   flexibility to customize your checkout UI.
 icon: table-cells-large
@@ -26,7 +26,9 @@ Initialize Hyperswitch Headless SDK onto your app with your publishable key. To
 Make a request to the endpoint on your server to create a new Payment. The `clientSecret` returned by your endpoint is used to initialize the payment session.
 
 {% hint style="danger" %}
+
 **Important**: Make sure to never share your API key with your client application as this could potentially compromise your security
+
 {% endhint %}
 
 #### 3. Initialize your Payment Session
diff --git a/explore-hyperswitch/payment-experience/payment/web/html-with-rest-api-integration.md b/explore-hyperswitch/payment-experience/payment/web/html-with-rest-api-integration.md
index 1790adae..17544b73 100644
--- a/explore-hyperswitch/payment-experience/payment/web/html-with-rest-api-integration.md
+++ b/explore-hyperswitch/payment-experience/payment/web/html-with-rest-api-integration.md
@@ -1,5 +1,5 @@
 ---
-description: Integrate hyper SDK to your HTML Web App using Hyperswitch-node
+description: Integrate hyper SDK to your HTML Web App using Juspay Hyperswitch-node
 icon: html5
 ---
 
@@ -26,7 +26,9 @@ Use `HyperLoader` to ensure PCI compliant means of accepting payment details fro
 ### 2.2 Define the payment form
 
 {% hint style="info" %}
+
 This step is recommended for the Unified Checkout for an enhanced user experience. In case you are integrating Express Checkout (mentioned later below), this step is not required.
+
 {% endhint %}
 
 Add one empty placeholder `div` to your checkout form for each Widget that you’ll mount. `HyperLoader` inserts an iframe into each `div` to securely collect the customer’s email address and payment information.
@@ -56,7 +58,9 @@ const hyper = Hyper("YOUR_PUBLISHABLE_KEY",{
 ```
 
 {% tabs %}
+
 {% tab title="UnifiedCheckout" %}
+
 #### 2.4 Fetch the Payment and create the Unified Checkout
 
 
@@ -96,9 +100,11 @@ async function initialize() { unifiedCheckout.mount("#unified-checkout"); } ``` + {% endtab %} {% tab title="ExpressCheckout" %} + #### 2.4 Fetch the Payment and create the Express Checkout
@@ -139,7 +145,9 @@ async function initialize() { expressCheckout.mount("#express-checkout"); } ``` + {% endtab %} + {% endtabs %} ## 3. Complete payment on the client @@ -199,7 +207,7 @@ For SDK to render the confirm button and handle the confirm payment, in paymentE ```html const unifiedCheckoutOptions = { - ..., +..., sdkHandleConfirmPayment: { handleConfirm: true, buttonText: "SDK Pay Now", diff --git a/explore-hyperswitch/payment-experience/payment/web/react-with-rest-api-integration.md b/explore-hyperswitch/payment-experience/payment/web/react-with-rest-api-integration.md index 860ff87d..f10d4f89 100644 --- a/explore-hyperswitch/payment-experience/payment/web/react-with-rest-api-integration.md +++ b/explore-hyperswitch/payment-experience/payment/web/react-with-rest-api-integration.md @@ -1,4 +1,5 @@ --- +description: Integrate Hyperswitch SDK with React and REST API for web checkout icon: react --- @@ -62,8 +63,8 @@ useEffect(() => { headers: { "Content-Type": "application/json" }, body: JSON.stringify({ items: [{ id: "xl-tshirt" }], country: "US" }), }) - .then((res) => res.json()) - .then((data) => setClientSecret(data.clientSecret)); +.then((res) => res.json()) +.then((data) => setClientSecret(data.clientSecret)); }, []); ``` @@ -102,7 +103,9 @@ const widgets = useWidgets(); ### 3. Complete the checkout on the client {% tabs %} + {% tab title="ExpressCheckout" %} + **Key Features of Hyperswitch's Express Checkout** * Fast Performance: One-click payment at checkout enables a smooth and frictionless payment experience to customers. @@ -138,9 +141,11 @@ var expressCheckoutOptions = { ```js ``` + {% endtab %} {% tab title="UnifiedCheckout" %} + **3.1.A Add the UnifiedCheckout**
@@ -213,7 +218,7 @@ For SDK to render the confirm button and handle the confirm payment, in paymentE ```javascript var unifiedCheckoutOptions = { - ..., +..., sdkHandleConfirmPayment: { handleConfirm: true, buttonText: "SDK Pay Now", @@ -232,7 +237,9 @@ var unifiedCheckoutOptions = { For customization, please follow the [`Customization docs`](https://docs.hyperswitch.io/hyperswitch-cloud/integration-guide/web/customization#id-5.-confirm-button). + {% endtab %} + {% endtabs %} #### 3.2 Display payment status message @@ -269,7 +276,9 @@ hyper.retrievePaymentIntent(paymentID).then(({ paymentIntent }) => { ``` {% hint style="danger" %} + Please retrieve the payment status from the Hyperswitch backend to get the terminal status of the payment. Do not rely solely on the status returned by the SDK, as it may not always reflect the final state of the transaction. + {% endhint %} ### 4. Elements Events @@ -357,15 +366,21 @@ This document outlines the details and functionality of an optional callback and * **onPaymentComplete:** This callback is triggered after the payment is completed, just before the SDK redirects to `walletReturnUrl` provided. It allows the merchant to handle actions post-payment. If not provided, the SDK's default flow will proceed. {% hint style="warning" %} + **Redirection Handling:** The `onPaymentComplete` callback should handle redirection or any steps needed after payment, as the SDK no longer does this automatically. You must ensure to implement the necessary redirection logic. + {% endhint %} {% hint style="info" %} + **Fallback:** If no callbacks are provided by the merchant, the SDK will continue with its default behaviour, including automatic redirection after payment completion. + {% endhint %} {% hint style="danger" %} + The task within `onPaymentButtonClick` must be completed within 1 second. If an asynchronous callback is used, it must resolve within this time to avoid Apple Pay payment failures. + {% endhint %} **Example Usage for React Integration** @@ -388,5 +403,8 @@ The task within `onPaymentButtonClick` must be completed within 1 second. If an ## Next step: {% content-ref url="../../../payment-orchestration/quickstart/payment-methods-setup/" %} + [payment-methods-setup](../../../payment-orchestration/quickstart/payment-methods-setup/) + {% endcontent-ref %} + diff --git a/explore-hyperswitch/payment-experience/payment/web/vanilla-js-and-rest-api-integration.md b/explore-hyperswitch/payment-experience/payment/web/vanilla-js-and-rest-api-integration.md index a5449573..cc5ffb43 100644 --- a/explore-hyperswitch/payment-experience/payment/web/vanilla-js-and-rest-api-integration.md +++ b/explore-hyperswitch/payment-experience/payment/web/vanilla-js-and-rest-api-integration.md @@ -18,7 +18,9 @@ Follow the [Server Setup](../server-setup.md) section. ### 2.1 Define the payment form {% hint style="info" %} + This step is recommended for the Unified Checkout for an enhanced user experience. In case you are integrating Express Checkout (mentioned later below), this step is not required. + {% endhint %} Add one empty placeholder `div` to your checkout form for each Widget that you’ll mount. `HyperLoader` inserts an iframe into each `div` to securely collect the customer’s email address and payment information. @@ -37,7 +39,9 @@ Add one empty placeholder `div` to your checkout form for each Widget that you ``` {% tabs %} + {% tab title="UnifiedCheckout" %} + #### 2.2 Fetch the Payment and create the Unified Checkout
@@ -97,15 +101,21 @@ This document outlines the details and functionality of an optional callback `co * **completeDoThis:** This callback is triggered after the payment is completed, just before the SDK redirects to `walletReturnUrl` provided. It allows the merchant to handle actions post-payment. If not provided, the SDK's default flow will proceed. {% hint style="warning" %} + **Redirection Handling:** The `onPaymentComplete` callback should handle redirection or any steps needed after payment, as the SDK no longer does this automatically. You must ensure to implement the necessary redirection logic. + {% endhint %} {% hint style="info" %} + **Fallback:** If no callbacks are provided by the merchant, the SDK will continue with its default behaviour, including automatic redirection after payment completion. + {% endhint %} {% hint style="danger" %} + The task within `onPaymentButtonClick` must be completed within 1 second. If an asynchronous callback is used, it must resolve within this time to avoid Apple Pay payment failures. + {% endhint %} **Example Usage** @@ -124,9 +134,11 @@ unifiedCheckout.on("completeDoThis",()=>{ // Add any custom post-payment logic here, such as redirection or displaying a success message }) ``` + {% endtab %} {% tab title="ExpressCheckout" %} + #### 2.2 Fetch the Payment and create the Express Checkout
@@ -173,7 +185,9 @@ async function initialize() { document.body.appendChild(script); } ``` + {% endtab %} + {% endtabs %} ## 3. Complete payment on the client diff --git a/explore-hyperswitch/payment-flows-and-management/quickstart/payment-methods-setup/wallets/samsung-pay.md b/explore-hyperswitch/payment-flows-and-management/quickstart/payment-methods-setup/wallets/samsung-pay.md index 04a5efcc..28388b8a 100644 --- a/explore-hyperswitch/payment-flows-and-management/quickstart/payment-methods-setup/wallets/samsung-pay.md +++ b/explore-hyperswitch/payment-flows-and-management/quickstart/payment-methods-setup/wallets/samsung-pay.md @@ -27,11 +27,11 @@ To create a new service, follow the steps below: 2. Enter the new `SERVICE NAME`. 3. Select your `SERVICE COUNTRY`. 4. Choose your `PAYMENT GATEWAY` from the list of supported payment gateways. -5. Upload the .csr file you received from your processor. +5. Upload the.csr file you received from your processor. 6. In the `SERVICE DOMAIN` field, enter your merchant_domain and click the `ADD` button. If there are multiple merchant domains, add them one after the other. 7. Verify the details you've entered, check the `LEGAL AGREEMENTS` box, and click `SAVE AND NEXT`. -## **Configuring Samsung Pay on Hyperswitch** +## **Configuring Samsung Pay on Juspay Hyperswitch** To configure Samsung Pay on Hyperswitch, follow the steps below - @@ -48,3 +48,4 @@ To configure Samsung Pay on Hyperswitch, follow the steps below - 8. Select the card brands you want to allow customer to use when making Samsung Pay payments. {% hint style="warning" %} Make sure that the Samsung Pay service is in the `Approved` state before configuring it on the Hyperswitch dashboard. If it is not, the Samsung Pay button will not be displayed during the payment process. {% endhint %} + diff --git a/explore-hyperswitch/payment-orchestration/README.md b/explore-hyperswitch/payment-orchestration/README.md index 47e49cb5..e190bd86 100644 --- a/explore-hyperswitch/payment-orchestration/README.md +++ b/explore-hyperswitch/payment-orchestration/README.md @@ -1,4 +1,5 @@ --- +description: Orchestrate payments payouts and recurring billing across multiple PSPs icon: arrow-progress --- @@ -12,16 +13,18 @@ Whether you're: * **Managing payouts** to vendors * **Making recurring payments** -Hyperswitch provides a **unified solution** to maximize efficiency while minimizing costs. +Juspay Hyperswitch provides a **unified solution** to maximize efficiency while minimizing costs. Built for businesses of all sizes and types—**e-commerce platforms, SaaS companies, and marketplaces**—our orchestration platform ensures **reliability and flexibility**, helping you stay ahead in a competitive landscape.
Accept Paymentsquickstart
Process Payoutspayouts
Smart Routingsmart-router.md
Smart Retriessmart-retries
3DS / Strong Customer Authentication3ds-decision-manager
Fraud & Risk Managementfraud-and-risk-management
Subscriptionssubscriptions.md
{% hint style="info" %} + **Have Questions?**\ Join our [Slack Community](https://join.slack.com/t/hyperswitch-io/shared_invite/zt-2jqxmpsbm-WXUENx022HjNEy~Ark7Orw) to ask questions, share feedback, and collaborate.\ Prefer direct support? Use our [Contact Us](https://hyperswitch.io/contact-us) page to reach out. + {% endhint %} \\ diff --git a/explore-hyperswitch/payment-orchestration/click-to-pay/README.md b/explore-hyperswitch/payment-orchestration/click-to-pay/README.md index 72c7aa80..b073f97c 100644 --- a/explore-hyperswitch/payment-orchestration/click-to-pay/README.md +++ b/explore-hyperswitch/payment-orchestration/click-to-pay/README.md @@ -1,11 +1,14 @@ --- +description: Implement Click to Pay for seamless secure checkout with passkeys icon: chevrons-right --- # Click To Pay {% hint style="info" %} + This feature is currently in Beta. For access, please contact us at **hyperswitch@juspay.in** + {% endhint %} Click to Pay is a secure and user-friendly digital payment solution designed to simplify the online checkout process. With Click to Pay, consumers can use their saved payment cards without manually entering card details or recalling a password for each purchase. All payment information is securely stored within a single, centralized profile tied to the user via an email/phone, making it easy to manage various payment methods. @@ -16,11 +19,11 @@ This solution is built on [EMVCo](https://www.emvco.com/) standards and is suppo
-### What Makes Hyperswitch’s Implementation Unique? +### What Makes Juspay Hyperswitch’s Implementation Unique? #### Passkeys Support -* Hyperswitch is among the first certified Mastercard and Visa partners for the passkey-enabled Click to Pay solution. +* Juspay Hyperswitch is among the first certified Mastercard and Visa partners for the passkey-enabled Click to Pay solution. * Unlike the older Click to Pay versions, which required OTPs or push provisioning, Hyperswitch enables seamless biometric authentication using passkeys. #### Unified SDK @@ -62,5 +65,8 @@ By combining the tokenization of payment credentials with seamless biometric aut On the customers' side, many are hesitant to enter their card details on a merchant website due to lack of trust and security concerns. With Click to Pay, these customers need not enter their card details manually, but fetch those from a secured, known EMVCo SRC system. This reduces the cart abandonment rate and increased sales for the merchants who offer Click to Pay. {% content-ref url="../../account-management/" %} + [account-management](../../account-management/) + {% endcontent-ref %} + diff --git a/explore-hyperswitch/payment-orchestration/click-to-pay/visa-click-to-pay-v1-to-v2-migration.md b/explore-hyperswitch/payment-orchestration/click-to-pay/visa-click-to-pay-v1-to-v2-migration.md index 3eec8870..963ff807 100644 --- a/explore-hyperswitch/payment-orchestration/click-to-pay/visa-click-to-pay-v1-to-v2-migration.md +++ b/explore-hyperswitch/payment-orchestration/click-to-pay/visa-click-to-pay-v1-to-v2-migration.md @@ -20,7 +20,7 @@ The evolution from Click to Pay V1 to V2 represents a fundamental shift in digit | **🌏 Global Market Adoption** | 🚧 Limited deployment and compatibility with some regions and merchants. | ✅ Available in 35+ countries, supported by major card networks | | **🔁 Recurring Payments** | 🚧 Limited support for saving credentials and managing recurring payments | ✅ Built-in support for recurring payments and saved credentials | -### **Seamless Migration with Hyperswitch** +### **Seamless Migration with Juspay Hyperswitch** The migration to V2 is powered by Hyperswitch's specialized wrapper solution, ensuring a frictionless transition that protects your existing integration while unlocking next-generation features. Our wrapper automatically handles version detection, request/response mapping, and backward compatibility - eliminating the risk of business disruption during migration. @@ -227,7 +227,6 @@ try { ``` - ### Authentication Methods V2 supports multiple authentication methods: @@ -486,5 +485,4 @@ For additional support: * [Merchant & PSP Guide](https://developer.visa.com/capabilities/visa-secure-remote-commerce/docs-merchants-psps) - Best practices and implementation paths for merchants and payment service providers - Remember to test thoroughly in the sandbox environment before deploying to production, and enable new features gradually to ensure a smooth transition for your users. diff --git a/explore-hyperswitch/payment-orchestration/quickstart/README.md b/explore-hyperswitch/payment-orchestration/quickstart/README.md index 7f659754..4c2bedd8 100644 --- a/explore-hyperswitch/payment-orchestration/quickstart/README.md +++ b/explore-hyperswitch/payment-orchestration/quickstart/README.md @@ -1,14 +1,15 @@ --- +description: Start accepting payments with Juspay Hyperswitch in minutes icon: bolt --- # Accept Payments -We at Hyperswitch simplify accepting one-time payments by offering a seamless integration process that empowers businesses to start accepting payments in just a few minutes. +We at Juspay Hyperswitch simplify accepting one-time payments by offering a seamless integration process that empowers businesses to start accepting payments in just a few minutes. ## Get Started -### **1. Get your Hyperswitch API key** +### **1. Get your Juspay Hyperswitch API key** * **Sign up on Hyperswitch Control Centre**: If you haven’t already, create an account on the [Hyperswitch Control Centre](https://app.hyperswitch.io/). * **Locate API key**: Access your API key from the **Settings > Developers** section in the Control Center. @@ -18,16 +19,18 @@ We at Hyperswitch simplify accepting one-time payments by offering a seamless in * **Set up payment processor:** Navigate to the Connectors tab in the Control Center to configure your preferred payment processor. You’ll need API credentials for the processor. {% hint style="success" %} + **Use the dummy processors:** If credentials are unavailable, you can configure the dummy processors, pre-built into the Control Center. These processors help simulate payment flows during integration and provide a risk-free testing environment. + {% endhint %} -### 3. Integrate Hyperswitch +### 3. Integrate Juspay Hyperswitch You will use both a server-side and a client-side component of Hyperswitch to complete the integration. The payment flow begins once your user adds products to a shopping cart and wishes to make a payment. -#### **Steps to Integrate Hyperswitch** +#### **Steps to Integrate Juspay Hyperswitch**
@@ -43,15 +46,19 @@ You will use both a server-side and a client-side component of Hyperswitch to co Upon successful payment, the customer is automatically redirected to your payment status confirmation page. {% hint style="info" %} + Don’t want to write code? Check out the [Hyperswitch Postman Collection](https://api-reference.hyperswitch.io/introduction) for a no-code way to get started with Hyperswitch's API. + {% endhint %}
Connectorshttps://docs.hyperswitch.io/explore-hyperswitch/payment-flows-and-management/quickstart/connectors
Setup Payment Methodshttps://docs.hyperswitch.io/explore-hyperswitch/payment-flows-and-management/quickstart/payment-methods-setup
Payment Linkshttps://docs.hyperswitch.io/explore-hyperswitch/payment-flows-and-management/quickstart/payment-links
Save a Payment Methodhttps://docs.hyperswitch.io/explore-hyperswitch/payment-flows-and-management/quickstart/mandates-and-recurring-payments
Manual Capturehttps://docs.hyperswitch.io/explore-hyperswitch/payment-flows-and-management/quickstart/manual-capture
Incremental Authorizationhttps://docs.hyperswitch.io/explore-hyperswitch/payment-flows-and-management/quickstart/incremental-authorization
Tokenization & Card Vaulthttps://docs.hyperswitch.io/explore-hyperswitch/payment-flows-and-management/quickstart/tokenization-and-saved-cards
Supported Payment Workflowshttps://docs.hyperswitch.io/explore-hyperswitch/payment-flows-and-management/quickstart/payment-workflows
Co-badged Cardshttps://docs.hyperswitch.io/explore-hyperswitch/payment-flows-and-management/quickstart/co-badged-cards-with-hyperswitch
Webhookshttps://docs.hyperswitch.io/explore-hyperswitch/payment-flows-and-management/quickstart/webhooks
{% hint style="info" %} + **Have Questions?**\ Join our [Slack Community](https://join.slack.com/t/hyperswitch-io/shared_invite/zt-2jqxmpsbm-WXUENx022HjNEy~Ark7Orw) to ask questions, share feedback, and collaborate.\ Prefer direct support? Use our [Contact Us](https://hyperswitch.io/contact-us) page to reach out. + {% endhint %}
@@ -60,15 +67,15 @@ Prefer direct support? Use our [Contact Us](https://hyperswitch.io/contact-us) p **What is a connector?** -Hyperswitch refers to payment processors, fraud / risk engines and other payment integrations as connectors. Hyperswitch currently supports 50+ global payment processors that you can use to process payments on your application +Hyperswitch refers to payment processors, fraud / risk engines and other payment integrations as connectors. Hyperswitch currently supports 300+ connectors that you can use to process payments on your application **How can I decide the best payment methods for my business?** -Hyperswitch supports 100+ payment methods across various payment processors. There is no one size fits all payment methods but you can learn more about how you can decide the best payment methods for you business [here](payment-methods-setup/). +Hyperswitch supports 300+ payment methods across various payment processors. There is no one size fits all payment methods but you can learn more about how you can decide the best payment methods for you business [here](payment-methods-setup/). **What will the completed integration look like?** -Hyperswitch offers various customization options but you can try out our demo store [here](https://demo-hyperswitch.netlify.app/checkout) to test the checkout experience +Juspay Hyperswitch offers various customization options but you can try out our demo store [here](https://demo-hyperswitch.netlify.app/checkout) to test the checkout experience **Are there any sample integrations for reference?** diff --git a/explore-hyperswitch/payment-orchestration/quickstart/co-badged-cards-with-hyperswitch.md b/explore-hyperswitch/payment-orchestration/quickstart/co-badged-cards-with-hyperswitch.md index bc93e36e..0a36b4f1 100644 --- a/explore-hyperswitch/payment-orchestration/quickstart/co-badged-cards-with-hyperswitch.md +++ b/explore-hyperswitch/payment-orchestration/quickstart/co-badged-cards-with-hyperswitch.md @@ -1,4 +1,5 @@ --- +description: Support co-badged cards with multiple payment network options icon: credit-card --- @@ -17,7 +18,7 @@ Customers benefit from the global scope, security, and consumer protection of in * **Compliance with Global Standards**: Co-badged cards support local regulations, such as Article 8 of the [Interchange Fee Regulation](https://eur-lex.europa.eu/legal-content/EN/TXT/?uri=CELEX%3A32015R0751) (IFR) issued by the European Union, ensuring full compliance while maintaining flexibility for merchants outside the EEA. * **Cost Optimization**: The platform's debit routing engine automatically selects the most cost-effective network based on real-time data and merchant preferences. -## How to enable support for Co-badged cards with Hyperswitch? +## How to enable support for Co-badged cards with Juspay Hyperswitch? Co-badged card support is **automatically enabled** when you configure multiple card networks in your business profile. The system will: @@ -43,5 +44,8 @@ In the IFR, Article 8 mandates that customers must be free to choose their netwo Merchants can choose not to support one of the networks, and in such cases, transactions will be routed through the supported network. {% content-ref url="../../../about-hyperswitch/payment-suite-1/payments-cards/saved-card/save-a-payment-method.md" %} + [save-a-payment-method.md](../../../about-hyperswitch/payment-suite-1/payments-cards/saved-card/save-a-payment-method.md) + {% endcontent-ref %} + diff --git a/explore-hyperswitch/payment-orchestration/quickstart/extended-authorization.md b/explore-hyperswitch/payment-orchestration/quickstart/extended-authorization.md index 9529e815..6fed35ff 100644 --- a/explore-hyperswitch/payment-orchestration/quickstart/extended-authorization.md +++ b/explore-hyperswitch/payment-orchestration/quickstart/extended-authorization.md @@ -1,4 +1,5 @@ --- +description: Extend authorization hold periods for flexible capture timing hidden: true icon: clock --- @@ -110,9 +111,10 @@ Currently, manual extended authorization is supported for: Calling this endpoint will initiate an extended authorization request. The actual behavior, including how much the capture or honor period is extended, depends on the specific connector and the issuing bank. {% hint style="info" %} + Be aware: With some connectors like Adyen, a failed extended authorization attempt may also cause the initial authorization to fail. -{% endhint %} +{% endhint %} > **⚠️ Note:** diff --git a/explore-hyperswitch/payment-orchestration/quickstart/hyperswitch-split-payments.md b/explore-hyperswitch/payment-orchestration/quickstart/hyperswitch-split-payments.md index b3a8219f..f2b7b2c9 100644 --- a/explore-hyperswitch/payment-orchestration/quickstart/hyperswitch-split-payments.md +++ b/explore-hyperswitch/payment-orchestration/quickstart/hyperswitch-split-payments.md @@ -1,11 +1,11 @@ --- -description: Get started with Split Payments via Hyperswitch +description: Get started with Split Payments via Juspay Hyperswitch icon: split --- # Split Payments -Hyperswitch enables split payments, allowing a single transaction to be completed using more than one payment method. This is commonly used for gift card + card scenarios, where a customer pays partially with a gift card and covers the remaining balance with another method. +Juspay Hyperswitch enables split payments, allowing a single transaction to be completed using more than one payment method. This is commonly used for gift card + card scenarios, where a customer pays partially with a gift card and covers the remaining balance with another method. This capability helps merchants: @@ -13,7 +13,7 @@ This capability helps merchants: * Improve customer flexibility at checkout * Support common retail and digital wallet experiences -Hyperswitch manages the orchestration, balance checks, and sequential processing behind the scenes. +Juspay Hyperswitch manages the orchestration, balance checks, and sequential processing behind the scenes. ### Supported Configurations @@ -36,13 +36,11 @@ No custom orchestration logic is required on the merchant side beyond standard S
- -### Hyperswitch Split Payments Flow +### Juspay Hyperswitch Split Payments Flow
- #### 1. Payment Initialization After the [payment intent](https://api-reference.hyperswitch.io/v1/payments/payments--create) is created, the checkout SDK is initialized. The SDK retrieves and displays all supported payment methods configured for the merchant, including gift cards if they are enabled. @@ -98,11 +96,9 @@ If the gift card authorization fails after the card payment has already been pro Once all payment methods are processed, the final transaction status is returned to the SDK. - #### API Details : - **Apply a gift card** ``` @@ -129,7 +125,6 @@ curl --request POST \ ``` - **Payment Confirm with Split PM details** ``` diff --git a/explore-hyperswitch/payment-orchestration/quickstart/level-2-and-level-3-data.md b/explore-hyperswitch/payment-orchestration/quickstart/level-2-and-level-3-data.md index 13c2e503..bb543c38 100644 --- a/explore-hyperswitch/payment-orchestration/quickstart/level-2-and-level-3-data.md +++ b/explore-hyperswitch/payment-orchestration/quickstart/level-2-and-level-3-data.md @@ -1,8 +1,12 @@ +--- +description: Include enhanced L2 and L3 data to optimize interchange costs +--- + # Level 2 and Level 3 data ### Overview -Hyperswitch allows merchants to include **Level 2 and Level 3** enhanced data in payment requests to optimize interchange costs on eligible commercial card transactions. This is done using a set of unified fields in the payment\_create API, which are internally routed and transformed per connector. +Juspay Hyperswitch allows merchants to include **Level 2 and Level 3** enhanced data in payment requests to optimize interchange costs on eligible commercial card transactions. This is done using a set of unified fields in the payment\_create API, which are internally routed and transformed per connector. * Level 2: Adds tax, invoice, and reference-level data * Level 3: Adds full line-item details (e.g., item quantity, commodity code, shipping, duty) @@ -48,13 +52,13 @@ Some data is structured to align with domain-specific groupings, making it easie * customer.email
* Order Details (Line Items)\ Each item can include: - * order\_details\[].product\_name - * order\_details\[].commodity\_code - * order\_details\[].quantity - * order\_details\[].unit\_of\_measure - * order\_details\[].unit\_price - * order\_details\[].item\_tax\_amount - * order\_details\[].item\_discount\_amount + * order\_details[].product\_name + * order\_details[].commodity\_code + * order\_details[].quantity + * order\_details[].unit\_of\_measure + * order\_details[].unit\_price + * order\_details[].item\_tax\_amount + * order\_details[].item\_discount\_amount ### Supported Connectors diff --git a/explore-hyperswitch/payment-orchestration/quickstart/manual-capture.md b/explore-hyperswitch/payment-orchestration/quickstart/manual-capture.md index 3bf22a97..ca1ab2dd 100644 --- a/explore-hyperswitch/payment-orchestration/quickstart/manual-capture.md +++ b/explore-hyperswitch/payment-orchestration/quickstart/manual-capture.md @@ -10,9 +10,9 @@ icon: sack-dollar {% embed url="https://youtu.be/XtOMZVhvLwQ" %} -In most online payments use-cases, a merchant would want to capture the funds from their customers' accounts in one-step after the issuer authorizes the payment. This is called '**one-step'** payments flow and at Hyperswitch we term this the '**Automatic Capture**' flow. +In most online payments use-cases, a merchant would want to capture the funds from their customers' accounts in one-step after the issuer authorizes the payment. This is called '**one-step'** payments flow and at Juspay Hyperswitch we term this the '**Automatic Capture**' flow. -But in some cases, merchants would like to place a hold on the customer's funds post authorization so that they can capture the funds at a later time once they deliver the goods and services. This is called the '**two-step**' flow or '**Auth and Capture**' flow in general payments parlance. Here at Hyperswitch, we call this the '**Manual Capture'** flow. +But in some cases, merchants would like to place a hold on the customer's funds post authorization so that they can capture the funds at a later time once they deliver the goods and services. This is called the '**two-step**' flow or '**Auth and Capture**' flow in general payments parlance. Here at Juspay Hyperswitch, we call this the '**Manual Capture'** flow. ### Benefits of Manual Capture diff --git a/explore-hyperswitch/payment-orchestration/quickstart/migrate-from-stripe/README.md b/explore-hyperswitch/payment-orchestration/quickstart/migrate-from-stripe/README.md index 42307f65..3a02123a 100644 --- a/explore-hyperswitch/payment-orchestration/quickstart/migrate-from-stripe/README.md +++ b/explore-hyperswitch/payment-orchestration/quickstart/migrate-from-stripe/README.md @@ -6,14 +6,17 @@ hidden: true # 📥 Migrate from Stripe {% hint style="info" %} + This sections explains how you can migrate from Stripe to Hyperswitch in less than 15 minutes + {% endhint %} If you are already integrated with the leading payment processor Stripe, Hyperswitch makes your integration fast, fun and easy. -Below are the products and features of Stripe support for Hyperswitch quick migration. And once you migrate, get immediate access to 40+ payment processors and features of Hyperswitch. +Below are the products and features of Stripe support for Hyperswitch quick migration. And once you migrate, get immediate access to 300+ connectors and features of Hyperswitch. {% tabs %} + {% tab title="Stripe Products" %} @@ -21,6 +24,7 @@ Below are the products and features of Stripe support for Hyperswitch quick migr | -------------------- | ---------------------------------------------------------------------------------------------------------------------- | | Stripe Payment links | Submit a feature request [here](https://github.com/juspay/hyperswitch/discussions/new?category=ideas-feature-requests) | | Stripe Checkout | Submit a feature request [here](https://github.com/juspay/hyperswitch/discussions/new?category=ideas-feature-requests) | + {% endtab %} {% tab title="Functionalities" %} @@ -32,6 +36,7 @@ Below are the products and features of Stripe support for Hyperswitch quick migr | Customers | Supported | | Refunds | Supported | | Payment methods | Supported | + {% endtab %} {% tab title="Payment Methods" %} @@ -43,6 +48,7 @@ Below are the products and features of Stripe support for Hyperswitch quick migr | Digital wallets - Paypal, Applepay, Gpay | Supported | | Bank Transfers - Giropay, Sofort etc., | Supported | | BNPL - Klarna, Affirm, Afterpay | Supported | + {% endtab %} {% tab title="Backend platforms" %} @@ -54,6 +60,7 @@ Below are the products and features of Stripe support for Hyperswitch quick migr | Python | Submit a feature request [here](https://github.com/juspay/hyperswitch/discussions/new?category=ideas-feature-requests) | | PHP | Submit a feature request [here](https://github.com/juspay/hyperswitch/discussions/new?category=ideas-feature-requests) | | Ruby | Submit a feature request [here](https://github.com/juspay/hyperswitch/discussions/new?category=ideas-feature-requests) | + {% endtab %} {% tab title="Frontend platforms" %} @@ -69,24 +76,34 @@ Below are the products and features of Stripe support for Hyperswitch quick migr | Woocommerce | Supported | | Bigcommerce | Submit a feature request [here](https://github.com/juspay/hyperswitch/discussions/new?category=ideas-feature-requests) | | Shopify | Submit a feature request [here](https://github.com/juspay/hyperswitch/discussions/new?category=ideas-feature-requests) | + {% endtab %} + {% endtabs %} **Checkout the migration steps here:** {% content-ref url="web.md" %} + [web.md](web.md) + {% endcontent-ref %} {% content-ref url="android.md" %} + [android.md](android.md) + {% endcontent-ref %} {% content-ref url="ios.md" %} + [ios.md](ios.md) + {% endcontent-ref %} {% content-ref url="react-native.md" %} + [react-native.md](react-native.md) + {% endcontent-ref %} diff --git a/explore-hyperswitch/payment-orchestration/quickstart/migrate-from-stripe/android.md b/explore-hyperswitch/payment-orchestration/quickstart/migrate-from-stripe/android.md index c3b710d3..4f6649ad 100644 --- a/explore-hyperswitch/payment-orchestration/quickstart/migrate-from-stripe/android.md +++ b/explore-hyperswitch/payment-orchestration/quickstart/migrate-from-stripe/android.md @@ -5,10 +5,12 @@ description: Migrate from Stripe on your android app # Android {% hint style="info" %} + Migrate from Stripe on your Android app in less than 15 mins! + {% endhint %} -If you are already integrated with Stripe as your payment processor, we have made migrating to Hyperswitch much simpler for you. And we will be adding quick migration support for more leading payment processors in the near future. And once you migrate, get immediate access to 40+ payment processors and features such as Smart Router, Digital Payments Manager and many more. +If you are already integrated with Stripe as your payment processor, we have made migrating to Hyperswitch much simpler for you. And we will be adding quick migration support for more leading payment processors in the near future. And once you migrate, get immediate access to 300+ connectors and features such as Smart Router, Digital Payments Manager and many more. ### Android - Node Backend and Kotlin Frontend @@ -78,4 +80,4 @@ class CheckoutActivity : AppCompatActivity(), HyperInterface { ``` -**Step 7:** Run your application to make a test payment. And verify the status of the transaction on Hyperswitch Dashboard and Stripe Dashboard. Congratulations ! You have successfully integrated Hyperswitch to your payments stack and you now have access to a suite of 40+ payment processors and acquirers. +**Step 7:** Run your application to make a test payment. And verify the status of the transaction on Hyperswitch Dashboard and Stripe Dashboard. Congratulations ! You have successfully integrated Hyperswitch to your payments stack and you now have access to a suite of 300+ connectors and acquirers. diff --git a/explore-hyperswitch/payment-orchestration/quickstart/migrate-from-stripe/ios.md b/explore-hyperswitch/payment-orchestration/quickstart/migrate-from-stripe/ios.md index 7a1090dd..af0bb233 100644 --- a/explore-hyperswitch/payment-orchestration/quickstart/migrate-from-stripe/ios.md +++ b/explore-hyperswitch/payment-orchestration/quickstart/migrate-from-stripe/ios.md @@ -5,10 +5,12 @@ description: Migrate from Stripe on your iOS app # iOS {% hint style="info" %} + Migrate from Stripe on your iOS app in less than 15 mins! + {% endhint %} -If you are already integrated with Stripe as your payment processor, we have made migrating to Hyperswitch much simpler for you. And we will be adding quick migration support for more leading payment processors in the near future. And once you migrate, get immediate access to 40+ payment processors and features such as Smart Router, Digital Payments Manager and many more. +If you are already integrated with Stripe as your payment processor, we have made migrating to Hyperswitch much simpler for you. And we will be adding quick migration support for more leading payment processors in the near future. And once you migrate, get immediate access to 300+ connectors and features such as Smart Router, Digital Payments Manager and many more. ### iOS - Node Backend and Swift Frontend @@ -60,4 +62,4 @@ import StripePaymentSheet import hyperswitch ``` -**Step 6:** Run your application to make a test payment. And verify the status of the transaction on Hyperswitch Dashboard and Stripe Dashboard. Congratulations ! You have successfully integrated Hyperswitch to your payments stack and you now have access to a suite of 40+ payment processors and acquirers. +**Step 6:** Run your application to make a test payment. And verify the status of the transaction on Hyperswitch Dashboard and Stripe Dashboard. Congratulations ! You have successfully integrated Hyperswitch to your payments stack and you now have access to a suite of 300+ connectors and acquirers. diff --git a/explore-hyperswitch/payment-orchestration/quickstart/migrate-from-stripe/react-native.md b/explore-hyperswitch/payment-orchestration/quickstart/migrate-from-stripe/react-native.md index fd966b09..d1669122 100644 --- a/explore-hyperswitch/payment-orchestration/quickstart/migrate-from-stripe/react-native.md +++ b/explore-hyperswitch/payment-orchestration/quickstart/migrate-from-stripe/react-native.md @@ -5,10 +5,12 @@ description: Migrate from Stripe on your react native app # React Native {% hint style="info" %} + Migrate from Stripe on your React Native app in less than 15 mins! + {% endhint %} -If you are already integrated with Stripe as your payment processor, we have made migrating to Hyperswitch much simpler for you. And we will be adding quick migration support for more leading payment processors in the near future. And once you migrate, get immediate access to 40+ payment processors and features such as Smart Router, Digital Payments Manager and many more. +If you are already integrated with Stripe as your payment processor, we have made migrating to Hyperswitch much simpler for you. And we will be adding quick migration support for more leading payment processors in the near future. And once you migrate, get immediate access to 300+ connectors and features such as Smart Router, Digital Payments Manager and many more. ### React Native - Node Backend and JS Frontend @@ -53,9 +55,9 @@ import { useStripe } from "@juspay-tech/react-native-hyperswitch"; ```js // from - ... +... // to - ... +... ``` -**Step 5:** Run your application to make a test payment. And verify the status of the transaction on Hyperswitch Dashboard and Stripe Dashboard. Congratulations ! You have successfully integrated Hyperswitch to your payments stack and you now have access to a suite of 40+ payment processors and acquirers. +**Step 5:** Run your application to make a test payment. And verify the status of the transaction on Hyperswitch Dashboard and Stripe Dashboard. Congratulations ! You have successfully integrated Hyperswitch to your payments stack and you now have access to a suite of 300+ connectors and acquirers. diff --git a/explore-hyperswitch/payment-orchestration/quickstart/migrate-from-stripe/web.md b/explore-hyperswitch/payment-orchestration/quickstart/migrate-from-stripe/web.md index 74f26c23..cedcccad 100644 --- a/explore-hyperswitch/payment-orchestration/quickstart/migrate-from-stripe/web.md +++ b/explore-hyperswitch/payment-orchestration/quickstart/migrate-from-stripe/web.md @@ -5,15 +5,19 @@ description: Migrate from Stripe on your web app # Web {% hint style="info" %} + Migrate from Stripe on your web app in less than 15 mins! + {% endhint %} ## Migrate from Stripe -If you are already integrated to Stripe as your payment processor, we have made migrating to Hyperswitch much simpler for you. And once you migrate, get immediate access to 40+ payment processors and features such as Smart Router, Unified analytics and many more. +If you are already integrated to Stripe as your payment processor, we have made migrating to Hyperswitch much simpler for you. And once you migrate, get immediate access to 300+ connectors and features such as Smart Router, Unified analytics and many more. {% hint style="info" %} + Stripe’s `paymentRequestButton` is available under Hyperswitch’s UnifiedCheckout, therefore importing UnifiedCheckout would be sufficient. + {% endhint %} The code from your Stripe integration to be removed and replaced is explained below in a step by step manner for both React and HTML frontend. You can find the details for both below. @@ -83,7 +87,7 @@ import { } from "@juspay-tech/react-hyper-js"; ``` -**Step 5:** Run your application to make a test payment. And verify the status of the transaction on Hyperswitch Dashboard and Stripe Dashboard. Congratulations ! You have successfully integrated Hyperswitch to your payments stack and you now have access to a suite of 40+ payment processors and acquirers. +**Step 5:** Run your application to make a test payment. And verify the status of the transaction on Hyperswitch Dashboard and Stripe Dashboard. Congratulations ! You have successfully integrated Hyperswitch to your payments stack and you now have access to a suite of 300+ connectors and acquirers.
@@ -133,7 +137,7 @@ const stripe = Stripe("your_stripe_publishable_key"); const hyper = Hyper("your_hyperswitch_publishable_key"); ``` -**Step 5:** Run your application to make a test payment. And verify the status of the transaction on Hyperswitch Dashboard and Stripe Dashboard. Congratulations ! You have successfully integrated Hyperswitch to your payments stack and you now have access to a suite of 40+ payment processors and acquirers. +**Step 5:** Run your application to make a test payment. And verify the status of the transaction on Hyperswitch Dashboard and Stripe Dashboard. Congratulations ! You have successfully integrated Hyperswitch to your payments stack and you now have access to a suite of 300+ connectors and acquirers. diff --git a/explore-hyperswitch/payment-orchestration/quickstart/overcapture.md b/explore-hyperswitch/payment-orchestration/quickstart/overcapture.md index 082f5d03..209f138b 100644 --- a/explore-hyperswitch/payment-orchestration/quickstart/overcapture.md +++ b/explore-hyperswitch/payment-orchestration/quickstart/overcapture.md @@ -1,4 +1,5 @@ --- +description: Capture amounts greater than the originally authorized amount hidden: true icon: plus --- @@ -15,7 +16,7 @@ This is particularly useful in scenarios such as: * Price adjustments made after initial authorization. * Reducing the risk of under-capturing when final order values differ. -With Hyperswitch, you can easily enable Overcapture for supported Payment Service Providers (PSPs). +With Juspay Hyperswitch, you can easily enable Overcapture for supported Payment Service Providers (PSPs). ### Supported PSPs diff --git a/explore-hyperswitch/payment-orchestration/quickstart/payment-methods-setup/banks/bank-debits.md b/explore-hyperswitch/payment-orchestration/quickstart/payment-methods-setup/banks/bank-debits.md index 86fb3bfc..64adaee7 100644 --- a/explore-hyperswitch/payment-orchestration/quickstart/payment-methods-setup/banks/bank-debits.md +++ b/explore-hyperswitch/payment-orchestration/quickstart/payment-methods-setup/banks/bank-debits.md @@ -5,7 +5,9 @@ description: Bank Debits payment method # Bank Debits {% hint style="info" %} + Bank debits pull funds directly from the customer’s bank account. Customers provide their bank account information and agree to a mandate to debit their account at specified intervals and amount. + {% endhint %} Bank Debits enables merchants to directly pull funds from the customers' bank accounts once the customers provide authorization for the same. It is primarily used for recurring transactions/mandates and for large ticket transactions like rent, fees, etc. diff --git a/explore-hyperswitch/payment-orchestration/quickstart/payment-methods-setup/banks/bank-redirects.md b/explore-hyperswitch/payment-orchestration/quickstart/payment-methods-setup/banks/bank-redirects.md index 5786d993..e0be777a 100644 --- a/explore-hyperswitch/payment-orchestration/quickstart/payment-methods-setup/banks/bank-redirects.md +++ b/explore-hyperswitch/payment-orchestration/quickstart/payment-methods-setup/banks/bank-redirects.md @@ -5,7 +5,9 @@ description: Bank Redirects payment methods # Bank Redirects {% hint style="info" %} + Bank redirects will redirect the user to the respective bank's payment page to complete a debit payment. + {% endhint %} Bank Redirects are one of the most preferred options for paying online across the world. Due to their highly secure nature, bank redirects are used extensively in countries like Germany, Netherlands, Asia, LATAM, etc. @@ -14,7 +16,7 @@ Bank Redirects are one of the most preferred options for paying online across th When customers select one of the Bank Redirects method on the checkout page, they are redirected to their online banking portal where they login and approve the transaction for which money is debited from their bank account. Post approval, they are redirected back to the shopping page. The transaction approval step might include two factor authentication in some bank redirects. -## **Integrating Bank Redirects on Hyperswitch** +## **Integrating Bank Redirects on Juspay Hyperswitch** To enable Bank redirect on Unified Checkout, you need to enable the payment methods on the Hyperswitch Dashboard. Hyperswitch SDKs intelligently display the supported Bank redirect option(s) based on the currency and the country of the customer. diff --git a/explore-hyperswitch/payment-orchestration/quickstart/payment-methods-setup/banks/bank-transfers.md b/explore-hyperswitch/payment-orchestration/quickstart/payment-methods-setup/banks/bank-transfers.md index 448b6131..7c2deb2f 100644 --- a/explore-hyperswitch/payment-orchestration/quickstart/payment-methods-setup/banks/bank-transfers.md +++ b/explore-hyperswitch/payment-orchestration/quickstart/payment-methods-setup/banks/bank-transfers.md @@ -5,7 +5,9 @@ description: Bank Transfer payment methods # Bank Transfers {% hint style="info" %} + Bank transfers allow customers to push funds from their bank account to the merchant's. + {% endhint %} Bank Transfers are a popular way of transmitting money between different bank accounts and they are popular in US, EU and few Asian and LATAM countries. They are primarily used by businesses for accepting large payments from other businesses. Bank transfers are also used by consumers in certain countries as a preferred method for transferring money to others and while transacting online. diff --git a/explore-hyperswitch/payment-orchestration/quickstart/payment-methods-setup/banks/open-banking.md b/explore-hyperswitch/payment-orchestration/quickstart/payment-methods-setup/banks/open-banking.md index ac01a436..090d959a 100644 --- a/explore-hyperswitch/payment-orchestration/quickstart/payment-methods-setup/banks/open-banking.md +++ b/explore-hyperswitch/payment-orchestration/quickstart/payment-methods-setup/banks/open-banking.md @@ -56,7 +56,7 @@ Regional Usage: 2. They are prompted to save the payment method with hyperswitch and your configured PM auth (open banking AIS) processor. 3. Customer is then asked to select their bank account in Processor SDK for saving it with the PM auth processor. 4. Hyperswitch connects with the PM auth processor to get the necessary information about their bank accounts and saves it. -5. The customer can now select their saved bank account at hyperswitch to make payment. +5. The customer can now select their saved bank account at Juspay Hyperswitch to make payment. {% embed url="https://www.youtube.com/watch?v=T-UIaQWUQFY" %} diff --git a/explore-hyperswitch/payment-orchestration/quickstart/payment-methods-setup/cards.md b/explore-hyperswitch/payment-orchestration/quickstart/payment-methods-setup/cards.md index d0e51afd..c0ba1e19 100644 --- a/explore-hyperswitch/payment-orchestration/quickstart/payment-methods-setup/cards.md +++ b/explore-hyperswitch/payment-orchestration/quickstart/payment-methods-setup/cards.md @@ -25,7 +25,9 @@ The Saved cards feature comes out of the box without any additional integration Follow the below guide to learn how to make a saved card payment using Hyperswitch {% content-ref url="../tokenization-and-saved-cards/" %} + [tokenization-and-saved-cards](../tokenization-and-saved-cards/) + {% endcontent-ref %} ## Recurring Payments - Mandate through cards @@ -35,7 +37,9 @@ Hyperswitch supports the creation of mandates for card transactions through vari Follow the below guide to learn how to make a recurring payment with Hyperswitch {% content-ref url="../../../../about-hyperswitch/payment-suite-1/payments-cards/saved-card/save-a-payment-method.md" %} + [save-a-payment-method.md](../../../../about-hyperswitch/payment-suite-1/payments-cards/saved-card/save-a-payment-method.md) + {% endcontent-ref %} ## Auth and Capture diff --git a/explore-hyperswitch/payment-orchestration/quickstart/payment-methods-setup/crypto.md b/explore-hyperswitch/payment-orchestration/quickstart/payment-methods-setup/crypto.md index f6ffb1db..1584620b 100644 --- a/explore-hyperswitch/payment-orchestration/quickstart/payment-methods-setup/crypto.md +++ b/explore-hyperswitch/payment-orchestration/quickstart/payment-methods-setup/crypto.md @@ -15,7 +15,7 @@ Crypto payments are a new way to pay using digital currencies like Bitcoin, Ethe 4. The customer confirms the transaction in their wallet and sends the payment to the recipient's public address on the cryptocurrency network 5. Once the payment is confirmed and processed by the cryptocurrency network, the merchant can access the payment in their cryptocurrency wallet -## **Configuring Crypto on Hyperswitch** +## **Configuring Crypto on Juspay Hyperswitch** You can configure Crypto on Hyperswitch by following the steps mentioned below - diff --git a/explore-hyperswitch/payment-orchestration/quickstart/payment-methods-setup/pay-later.md b/explore-hyperswitch/payment-orchestration/quickstart/payment-methods-setup/pay-later.md index 9596c5cb..84f40356 100644 --- a/explore-hyperswitch/payment-orchestration/quickstart/payment-methods-setup/pay-later.md +++ b/explore-hyperswitch/payment-orchestration/quickstart/payment-methods-setup/pay-later.md @@ -1,5 +1,5 @@ --- -description: Accept pay later options through Hyperswitch +description: Accept pay later options through Juspay Hyperswitch icon: calendar-day --- @@ -11,7 +11,7 @@ icon: calendar-day * Affirm is a buy now pay later payment method available to US customers and supports USD. * Afterpay/Clearpay is a buy now pay later payment method available as Afterpay to customers in US, Canada, Australia, New Zealand while available as Clearpay to customers in the United Kingdom, Spain, France and Italy. It currently supports USD, CAD, AUD, NZD, EUR and GBP. -## **How to configure pay later options (Redirection flow) on Hyperswitch?** +## **How to configure pay later options (Redirection flow) on Juspay Hyperswitch?** 1. Make sure that the pay later options are enabled on your connector's dashboard 2. Enable paylater options on Hyperswitch dashboard under "payment methods" tab while configuring your connector diff --git a/explore-hyperswitch/payment-orchestration/quickstart/payment-methods-setup/test-credentials.md b/explore-hyperswitch/payment-orchestration/quickstart/payment-methods-setup/test-credentials.md index 0c9375be..c43d80e4 100644 --- a/explore-hyperswitch/payment-orchestration/quickstart/payment-methods-setup/test-credentials.md +++ b/explore-hyperswitch/payment-orchestration/quickstart/payment-methods-setup/test-credentials.md @@ -1,12 +1,14 @@ --- -description: Key to configure and test different connectors in Hyperswitch +description: Key to configure and test different connectors in Juspay Hyperswitch icon: key --- # Test Credentials {% hint style="info" %} + This section gives you an overview of how to you can make test transactions for the payment methods you have enabled + {% endhint %} ## Testing Cards across different Connectors diff --git a/explore-hyperswitch/payment-orchestration/quickstart/payment-recipes/README.md b/explore-hyperswitch/payment-orchestration/quickstart/payment-recipes/README.md index 9a5a9996..39c229d0 100644 --- a/explore-hyperswitch/payment-orchestration/quickstart/payment-recipes/README.md +++ b/explore-hyperswitch/payment-orchestration/quickstart/payment-recipes/README.md @@ -25,5 +25,8 @@ For growing businesses, sticking to one payment processor and offering only a ha ## Next step: {% content-ref url="use-paypal-with-stripe.md" %} + [use-paypal-with-stripe.md](use-paypal-with-stripe.md) + {% endcontent-ref %} + diff --git a/explore-hyperswitch/payment-orchestration/quickstart/payment-recipes/use-paypal-with-stripe.md b/explore-hyperswitch/payment-orchestration/quickstart/payment-recipes/use-paypal-with-stripe.md index 8b4f76f9..fca7ae30 100644 --- a/explore-hyperswitch/payment-orchestration/quickstart/payment-recipes/use-paypal-with-stripe.md +++ b/explore-hyperswitch/payment-orchestration/quickstart/payment-recipes/use-paypal-with-stripe.md @@ -5,14 +5,16 @@ description: 'Payment Recipe #1' # Use PayPal With Stripe {% hint style="info" %} + This section will highlight the benefits of complementing your Stripe integration with Paypal + {% endhint %}
## Use Paypal with Stripe -With Hyperswitch, you can start offering Paypal to your customers, while enjoying the convenience and developer experience offered by Stripe. You can easily migrate from Stripe to Hyperswitch in five simple steps and add Paypal with a few button clicks. If you are not already integrated with Stripe, all that it takes is 15 minutes to integrate Hyperswitch from scratch. We have ready code snippets to copy-paste and integrate. +With Juspay Hyperswitch, you can start offering Paypal to your customers, while enjoying the convenience and developer experience offered by Stripe. You can easily migrate from Stripe to Hyperswitch in five simple steps and add Paypal with a few button clicks. If you are not already integrated with Stripe, all that it takes is 15 minutes to integrate Hyperswitch from scratch. We have ready code snippets to copy-paste and integrate. ### Why is Paypal important for your online business? @@ -32,7 +34,6 @@ On one hand, Apple Pay is the most popular digital wallet on the planet, but its If you wish to start offering Paypal to your customers, Hyperswitch offers you an end-to-end and future proof payments toolkit. - You can [migrate from Stripe](../migrate-from-stripe/) to Hyperswitch in less than 15 mins and enable Paypal in a couple of clicks. Please follow the account setup (next section) to enable different payment methods of Stripe with Paypal. ### diff --git a/explore-hyperswitch/payment-orchestration/quickstart/payment-workflows.md b/explore-hyperswitch/payment-orchestration/quickstart/payment-workflows.md index 036bb39b..27a011d8 100644 --- a/explore-hyperswitch/payment-orchestration/quickstart/payment-workflows.md +++ b/explore-hyperswitch/payment-orchestration/quickstart/payment-workflows.md @@ -1,4 +1,5 @@ --- +description: Explore composable payment workflows for Vertical SaaS platforms icon: code-compare --- @@ -8,7 +9,7 @@ Hyperswitch’s three-level profile architecture enables support for composable These workflows can be modularly organized to meet diverse business needs and provide flexibility based on client requirements. Here’s a breakdown of key workflows: -### Possible Scenerios: +### Possible Scenarios: **Direct Payments:** In the case of a client using a Vertical SaaS (VSaaS) platform, the client may prefer to authorize the customer’s card only after the service is fulfilled. Therefore, the Vertical SaaS solution will need to verify and vault the card with the PSP, returning the PSP card token to the client. @@ -23,5 +24,8 @@ These workflows can be modularly organized to meet diverse business needs and pr
{% content-ref url="../../account-management/analytics-and-operations/exporting-payments-data.md" %} + [exporting-payments-data.md](../../account-management/analytics-and-operations/exporting-payments-data.md) + {% endcontent-ref %} + diff --git a/explore-hyperswitch/payment-orchestration/quickstart/tokenization-and-saved-cards/README.md b/explore-hyperswitch/payment-orchestration/quickstart/tokenization-and-saved-cards/README.md index ebe96ce6..44c5d945 100644 --- a/explore-hyperswitch/payment-orchestration/quickstart/tokenization-and-saved-cards/README.md +++ b/explore-hyperswitch/payment-orchestration/quickstart/tokenization-and-saved-cards/README.md @@ -14,26 +14,35 @@ The Hyperswitch Card Vault enables you to securely store customer card details i * **Seamless Recurring Payments**: Automatic updates to tokenized card details ensure uninterrupted subscription payments, minimizing churn. * **Global Compatibility**: Supports various payment processors and is compliant with international standards like PCI DSS and PCI SSS. -#### Learn how to save a payment method in Hyperswitch during payments: +#### Learn how to save a payment method in Juspay Hyperswitch during payments: {% content-ref url="../../../../about-hyperswitch/payment-suite-1/payments-cards/saved-card/save-a-payment-method.md" %} + [save-a-payment-method.md](../../../../about-hyperswitch/payment-suite-1/payments-cards/saved-card/save-a-payment-method.md) + {% endcontent-ref %} -#### Learn about PG Agnostic Recurring payments/Card Forwarding through Hyperswitch: +#### Learn about PG Agnostic Recurring payments/Card Forwarding through Juspay Hyperswitch: {% content-ref url="pg-agnostic-recurring-payments.md" %} + [pg-agnostic-recurring-payments.md](pg-agnostic-recurring-payments.md) + {% endcontent-ref %} -#### Learn how to use Network Tokenisation in Hyperswitch: +#### Learn how to use Network Tokenisation in Juspay Hyperswitch: {% content-ref url="network-tokenisation.md" %} + [network-tokenisation.md](network-tokenisation.md) + {% endcontent-ref %} #### Learn about our Standalone Vault service - No payment orchestration required: {% content-ref url="../../../workflows/vault/" %} + [vault](../../../workflows/vault/) + {% endcontent-ref %} + diff --git a/explore-hyperswitch/payment-orchestration/quickstart/tokenization-and-saved-cards/network-tokenisation.md b/explore-hyperswitch/payment-orchestration/quickstart/tokenization-and-saved-cards/network-tokenisation.md index 6135b278..63dbf64b 100644 --- a/explore-hyperswitch/payment-orchestration/quickstart/tokenization-and-saved-cards/network-tokenisation.md +++ b/explore-hyperswitch/payment-orchestration/quickstart/tokenization-and-saved-cards/network-tokenisation.md @@ -26,7 +26,7 @@ A network token is scoped to a Merchant, Customer & Token Requestor ensuring a m 5. **Simplified Compliance:** With tokenization, your business doesn’t need to store sensitive card data, reducing the scope and cost of compliance efforts. 6. **Reduced Interchange costs:** Networks in certain geographies provide interchange cost savings to merchants up to 10bps in case of using network tokenization -## **Supported Networks via Hyperswitch** +## **Supported Networks via Juspay Hyperswitch** Currently supported: Visa, Mastercard, American Express @@ -47,15 +47,15 @@ By leveraging Juspay’s infrastructure through Hyperswitch, you get seamless ac We also offer you the flexibility to bring your own Token Requestor credentials and configure them within our system so that all network tokenization requests are made using your own credentials. This could ensure better control, compliance alignment, and consistency across your systems. -## Hyperswitch: Network Tokenization Support Modes +## Juspay Hyperswitch: Network Tokenization Support Modes Hyperswitch supports three distinct Network Tokenization flows, depending on how you’re integrated: -#### 1. Network Tokenization during Payments (via Hyperswitch Orchestration) +#### 1. Network Tokenization during Payments (via Juspay Hyperswitch Orchestration) When you process payments using Hyperswitch’s orchestration layer, you can perform tokenized payments directly - Hyperswitch handles provisioning and using the network token dynamically at payment time. We also take care of optimizing authorization rates and latency by switching between network tokens and clear PAN. -#### 2. Network Tokenization during Vaulting (via Hyperswitch Vault service) +#### 2. Network Tokenization during Vaulting (via Juspay Hyperswitch Vault service) You can network tokenize cards at the time of storage in Hyperswitch’s Vault service. These network tokens can later be used for recurring payments, subscriptions, or one-click checkouts in combination with NTID or cryptogram. @@ -65,7 +65,7 @@ Use Juspay’s standalone Network Tokenization API service to provision, manage, *** -### 1. Network Tokenization during Payments (via Hyperswitch Orchestration) +### 1. Network Tokenization during Payments (via Juspay Hyperswitch Orchestration) _No changes required to your PSP integrations — Hyperswitch handles the token lifecycle, retries, and PAN fallback automatically._ @@ -94,7 +94,7 @@ Contact our support team to enable Network Tokenization on your merchant account *** -### 2. Network Tokenization during Vaulting (via Hyperswitch Vault) +### 2. Network Tokenization during Vaulting (via Juspay Hyperswitch Vault) In this flow: diff --git a/explore-hyperswitch/payment-orchestration/quickstart/webhooks.md b/explore-hyperswitch/payment-orchestration/quickstart/webhooks.md index 5d13bea0..3114c660 100644 --- a/explore-hyperswitch/payment-orchestration/quickstart/webhooks.md +++ b/explore-hyperswitch/payment-orchestration/quickstart/webhooks.md @@ -1,5 +1,5 @@ --- -description: Configure outgoing webhooks from Hyperswitch +description: Configure outgoing webhooks from Juspay Hyperswitch icon: anchor --- @@ -27,7 +27,7 @@ In case a merchant wants to set custom headers for sending data to a specified w
-#### Update Hyperswitch’s webhook endpoints on your connector Dashboard +#### Update Juspay Hyperswitch’s webhook endpoints on your connector Dashboard In order for Hyperswitch to receive updates from the connectors you have selected, you would need to update Hyperswitch’s corresponding endpoints on your respective connector dashboard instead of your webhook endpoints. @@ -86,8 +86,8 @@ To validate the webhook’s authenticity: If you are sure that the payload is from Hyperswitch but the signature verification fails: -* Make sure you are using the correct header. Hyperswitch recommends that you use the `x-webhook-signature-512` header, which uses the HMAC-SHA512 algorithm. If your machine does't support HMAC-SHA256, you can use `x-webhook-signature-256` header, which uses the HMAC-SHA256 algorithm. -* Make sure you are using the correct algorithm. If you are using the `x-webhook-signature-256` header , you should use the HMAC-SHA256 algorithm. +* Make sure you are using the correct header. Hyperswitch recommends that you use the `x-webhook-signature-512` header, which uses the HMAC-SHA512 algorithm. If your machine doesn't support HMAC-SHA256, you can use `x-webhook-signature-256` header, which uses the HMAC-SHA256 algorithm. +* Make sure you are using the correct algorithm. If you are using the `x-webhook-signature-256` header, you should use the HMAC-SHA256 algorithm.
diff --git a/explore-hyperswitch/payment-orchestration/smart-router.md b/explore-hyperswitch/payment-orchestration/smart-router.md index a3194da6..bf3e7b94 100644 --- a/explore-hyperswitch/payment-orchestration/smart-router.md +++ b/explore-hyperswitch/payment-orchestration/smart-router.md @@ -14,7 +14,7 @@ To get started with Smart Router, ensure to have one or more payment processors ## What is smart payment routing? -Selling globally or otherwise invariably brings in a requirement to adopt multiple payment processors to cater to a wide range of payment method needs of the customers and gives you the flexibility to switch between processors to manage down-time and , it could be vital to optimising your payment processing costs as your business can choose the most optimal payment processors for every payment based on the cost, region and customer. +Selling globally or otherwise invariably brings in a requirement to adopt multiple payment processors to cater to a wide range of payment method needs of the customers and gives you the flexibility to switch between processors to manage down-time and, it could be vital to optimising your payment processing costs as your business can choose the most optimal payment processors for every payment based on the cost, region and customer. Hence, Hyperswitch’s smart router is designed as a no-code tool to provide complete control and transparency in creating and modifying payment routing rules. Hyperswitch supports below formats of Smart Routing. @@ -44,7 +44,9 @@ Hyperswitch Smart Router Engine evaluates every payment request against your pre To test the Smart Router, after activating one rule, we can make a Test Payment using the [Hyperswitch Dashboard](https://app.hyperswitch.io/sdk) {% content-ref url="../../hyperswitch-open-source/account-setup/test-a-payment.md" %} + [test-a-payment.md](../../hyperswitch-open-source/account-setup/test-a-payment.md) + {% endcontent-ref %}
diff --git a/explore-hyperswitch/payment-orchestration/subscriptions.md b/explore-hyperswitch/payment-orchestration/subscriptions.md index 9316b1b0..3a764920 100644 --- a/explore-hyperswitch/payment-orchestration/subscriptions.md +++ b/explore-hyperswitch/payment-orchestration/subscriptions.md @@ -8,7 +8,7 @@ icon: repeat # Subscriptions -Hyperswitch enables you to work with your preferred subscription provider while having the flexibility to connect with multiple payment processors and payment methods. The benefits you gain by using Hyperswitch integration as a supplement to your Subscription Solution Provider are as follows: +Juspay Hyperswitch enables you to work with your preferred subscription provider while having the flexibility to connect with multiple payment processors and payment methods. The benefits you gain by using Hyperswitch integration as a supplement to your Subscription Solution Provider are as follows: * **Flexibility with Payment Processors** * Choose any payment processor based on better costs or authorization rates. @@ -66,14 +66,14 @@ User selects a payment method and adds the payment method details which are save * Merchant will initiate a $0 mandate with Hyperswitch ([more details](https://docs.hyperswitch.io/features/payment-flows-and-management/zero-amount-authorization)) to validate and store the payment details and create a mandate with Hyperswitch (using the same customer ID). * **Retrieve plans and create subscription** - Merchants will retrieve the eligible plans and display them on their website. The customer will select one of the plans shown to them. Merchant will use the selected plan to create a subscription with the subscription provider. * **Make payment and return invoice** - Using the mandate ID created earlier the merchant will make a payment with Hyperswitch. The subscription is marked as active upon successful payment and the invoice with the customer. - * In case the subscription start date is in future and the customer need not be charged immediately then no payment is inittaed with Hyperswitch + * In case the subscription start date is in future and the customer need not be charged immediately then no payment is initiated with Hyperswitch * **Make MIT transactions** - The subscription provider will trigger a webhook to the merchant on the date of the scheduled payment for subscription. Upon receiving the webhook, the merchant should initiate a payment with Hyperswitch using the customer ID and mandate ID. The merchant will share the invoice with the customer upon successful payment
### Subscription management portal -The customer-facing subscription management interface allows the customers to modify their billing address, add new payment method details for subscripotion payments and cancel subscription. If a merchant offers a subscription management portal then here's how Hyperswitch can support: +The customer-facing subscription management interface allows the customers to modify their billing address, add new payment method details for subscription payments and cancel subscription. If a merchant offers a subscription management portal then here's how Hyperswitch can support: * **User updates billing address** - The merchant will update the new billing address with both Hyperswitch and the subscription provider using the customer ID. * **User updates payment method details** - The merchant will load Hyperswitch SDK to allow the user to select the payment method and add the relevant payment method details. Merchant will validate and add this payment method with Hyperswitch using $0 mandate and create a new mandate. @@ -95,7 +95,7 @@ The merchant can use the Hyperswitch Payment links when sending email reminders * The send email notification is a functionality offered by most subscription providers. They also allow customising the message and payment links shared inside the email * The merchant needs to host a standard page and share the link to that page on the email * When the customer click on that link requesting to pay, the merchant will call Hyperswitch with the customer ID to create and share the Payment link -* The customer is redirected to the payment link hosted page (with a validity of 15-mins) which allows them to make the payment using any payment option +* The customer is redirected to the payment link hosted page (with a validity of 15 minutes) which allows them to make the payment using any payment option * Once the payment is successful, the merchant should mark the invoice as paid with their subscription provider and return the invoice to the customer
diff --git a/explore-hyperswitch/payments-modules/reconciliation-product/core-concepts.md b/explore-hyperswitch/payments-modules/reconciliation-product/core-concepts.md index 099797b5..a6e38c6e 100644 --- a/explore-hyperswitch/payments-modules/reconciliation-product/core-concepts.md +++ b/explore-hyperswitch/payments-modules/reconciliation-product/core-concepts.md @@ -1,3 +1,7 @@ +--- +description: Learn double-entry bookkeeping accounts entries and transactions concepts +--- + # Core Concepts ### How We Model Money diff --git a/explore-hyperswitch/payments-modules/reconciliation-product/example-e-commerce.md b/explore-hyperswitch/payments-modules/reconciliation-product/example-e-commerce.md index d8defcb4..d0b4da63 100644 --- a/explore-hyperswitch/payments-modules/reconciliation-product/example-e-commerce.md +++ b/explore-hyperswitch/payments-modules/reconciliation-product/example-e-commerce.md @@ -82,8 +82,8 @@ The core of our reconciliation engine is the rule-based architecture. Rules defi * **When to Apply (Filter)**: Transaction type equals "customer\_order" * **How to Find Match (Identifier)**: Use `order_id` to find the PSP transaction with the same `original_reference` * **What to Verify (Match Rules)**: - * `Order amount = PSP gross amount` - * `Order currency = PSP currency` + * `Order `amount = PSP` gross amount` + * `Order `currency = PSP` currency` * `Order ID = PSP original reference` #### Rule 2: PSP-to-Bank Matching @@ -95,8 +95,8 @@ The core of our reconciliation engine is the rule-based architecture. Rules defi * **When to Apply (Filter)**: Transaction type equals "psp\_settlement" * **How to Find Match (Identifier)**: Use `settlement_batch_id` to find the bank transaction with the same `batch_reference` * **What to Verify (Match Rules)**: - * `PSP net amount = Bank deposit amount` - * `PSP currency = Bank currency` + * `PSP net `amount = Bank` deposit amount` + * `PSP `currency = Bank` currency` * `Settlement date = Bank value date` ### Step 3: The Transaction Journey diff --git a/explore-hyperswitch/payments-modules/reconciliation-product/exception-handling/README.md b/explore-hyperswitch/payments-modules/reconciliation-product/exception-handling/README.md index 40af6e91..cf09626d 100644 --- a/explore-hyperswitch/payments-modules/reconciliation-product/exception-handling/README.md +++ b/explore-hyperswitch/payments-modules/reconciliation-product/exception-handling/README.md @@ -1,3 +1,7 @@ +--- +description: Handle and resolve reconciliation exceptions and anomalies +--- + # Exception Handling ## Module: Reconciliation Exception Handling @@ -16,7 +20,7 @@ We categorize exceptions into two distinct types based on the presence of counte * Definition: Records exist on both sides, and the system has attempted reconciliation. However, the comparison logic failed because key attributes do not match. * Reconciliation Status: `MISMATCHED` -* Business Context: This represents a data integrity error requiring investigation (e.g., amount discrepancies, status discrepancies , or metadata corruption) +* Business Context: This represents a data integrity error requiring investigation (e.g., amount discrepancies, status discrepancies, or metadata corruption) #### Type B: "Expected" (Timing/Availability) diff --git a/explore-hyperswitch/payments-modules/reconciliation-product/exception-handling/resolution-strategies-for-expected-exceptions.md b/explore-hyperswitch/payments-modules/reconciliation-product/exception-handling/resolution-strategies-for-expected-exceptions.md index 6b08d154..261636c2 100644 --- a/explore-hyperswitch/payments-modules/reconciliation-product/exception-handling/resolution-strategies-for-expected-exceptions.md +++ b/explore-hyperswitch/payments-modules/reconciliation-product/exception-handling/resolution-strategies-for-expected-exceptions.md @@ -1,3 +1,7 @@ +--- +description: Resolve expected exceptions using voiding and manual verification approaches +--- + # Resolution Strategies for 'Expected' Exceptions ### Overview @@ -20,7 +24,7 @@ Action: `Ignore Transaction` This action is used when the source transaction (the "Expected" item) is invalid or should not be reconciled. Since the counterparty data has not arrived yet, "Ignoring" this record effectively cancels the expectation, preventing the system from waiting indefinitely -* Logic: Marks the transaction status as `VOID` . It removes the item from the "Pending/Aging" queue +* Logic: Marks the transaction status as `VOID`. It removes the item from the "Pending/Aging" queue * Common Use Cases: * Test Transactions: An order created in the production environment for testing purposes that will never settle at the bank * Cancelled Prior to Settlement: An authorization that was voided immediately at the gateway but was logged as "Pending" in the ledger @@ -36,7 +40,6 @@ If the source transaction is valid and represents real money, but the automated
- #### Option 1: Edit Entry "The Pre-emptive Correction" diff --git a/explore-hyperswitch/payments-modules/reconciliation-product/exception-handling/resolution-strategies-for-mismatched-exceptions.md b/explore-hyperswitch/payments-modules/reconciliation-product/exception-handling/resolution-strategies-for-mismatched-exceptions.md index 1297c5d9..9a61e4c1 100644 --- a/explore-hyperswitch/payments-modules/reconciliation-product/exception-handling/resolution-strategies-for-mismatched-exceptions.md +++ b/explore-hyperswitch/payments-modules/reconciliation-product/exception-handling/resolution-strategies-for-mismatched-exceptions.md @@ -1,3 +1,7 @@ +--- +description: Fix mismatched exceptions through editing creating or replacing entries +--- + # Resolution Strategies for Mismatched Exceptions ### Overview @@ -14,7 +18,7 @@ Action: `Ignore Transaction` This action effectively "soft deletes" the exception. It is used when the transaction record itself is invalid and should not have been ingested into the reconciliation layer in the first place. Ignoring a transaction removes it from the active queue and excludes it from financial reports. -* Logic: Marks the transaction status as `VOID` . It does not delete the audit trail but prevents further processing +* Logic: Marks the transaction status as `VOID`. It does not delete the audit trail but prevents further processing * Common Use Cases: * Test Data: Developers generated $0.01 test transactions in the Production environment * Cancelled/Voided Orders: Transactions that were cancelled at the source but were erroneously synced to the reconciliation layer diff --git a/explore-hyperswitch/payments-modules/reconciliation-product/how-reconciliation-works.md b/explore-hyperswitch/payments-modules/reconciliation-product/how-reconciliation-works.md index d8654c19..4e583863 100644 --- a/explore-hyperswitch/payments-modules/reconciliation-product/how-reconciliation-works.md +++ b/explore-hyperswitch/payments-modules/reconciliation-product/how-reconciliation-works.md @@ -26,6 +26,7 @@ The reconciliation process follows a robust, end-to-end flow to ensure that ever 8. {% code title="How Reconciliation Works" fullWidth="true" %} + ```mermaid flowchart TB OD["Order Data"] -- Ingested via automated connection --> DI["Data Ingestion"] @@ -58,6 +59,7 @@ flowchart TB style MM fill:#FFCDD2 style EM fill:#C8E6C9 ``` + {% endcode %} ## Rules Architecture diff --git a/explore-hyperswitch/payments-modules/reconciliation-product/merchant-and-profile-mapping-in-recon.md b/explore-hyperswitch/payments-modules/reconciliation-product/merchant-and-profile-mapping-in-recon.md index 948db289..8c97536c 100644 --- a/explore-hyperswitch/payments-modules/reconciliation-product/merchant-and-profile-mapping-in-recon.md +++ b/explore-hyperswitch/payments-modules/reconciliation-product/merchant-and-profile-mapping-in-recon.md @@ -1,8 +1,12 @@ +--- +description: Map Juspay Hyperswitch organization merchant and profile hierarchy to reconciliation +--- + # Merchant & Profile Mapping in Recon -### Mapping Hyperswitch Org/Merchant/Profile to Recon +### Mapping Juspay Hyperswitch Org/Merchant/Profile to Recon -Hyperswitch is designed as a multi-tenant platform with a clear hierarchy: +Juspay Hyperswitch is designed as a multi-tenant platform with a clear hierarchy: * **Organisation (Org)**: Top-level container for your company/platform.\ This is the parent boundary for all merchants, products, and users @@ -71,7 +75,7 @@ This setup is preferred when you want **separate merchant workspaces per Busines **Important:** This is not necessarily about legal entities.\ It’s about **workspace separation and access boundaries**. -#### Hyperswitch example +#### Juspay Hyperswitch example * Org = “Company” * Merchant A = “BU: Consumer” @@ -117,7 +121,6 @@ Choose “merchant-per-Business-Unit” if you want: * lower risk of cross-team interference (each Business Unit isolated at merchant scope) - ### **Setup B: One Org, one Payments merchant, business units as Profiles + Recon merchant adjacent** This setup is preferred when you want: @@ -171,7 +174,6 @@ Choose “single merchant + multiple profiles” if you want: * separation where it matters (rules, logic, workflows, ops ownership) at profile level - #### **Scenario C: Payments under one merchant, reconciliation separated (Recon profiles) + Recon merchant under Org** This keeps the “payments unified” setup intact, while enabling **business unit**-level isolation in reconciliation diff --git a/explore-hyperswitch/payments-modules/reconciliation-product/services.md b/explore-hyperswitch/payments-modules/reconciliation-product/services.md index ac2f6341..2c05b863 100644 --- a/explore-hyperswitch/payments-modules/reconciliation-product/services.md +++ b/explore-hyperswitch/payments-modules/reconciliation-product/services.md @@ -1,4 +1,5 @@ --- +description: Manage data ingestion and transformation services for reconciliation hidden: true --- diff --git a/explore-hyperswitch/payments-modules/reconciliation-product/why-we-evolved-v1-vs-v2.md b/explore-hyperswitch/payments-modules/reconciliation-product/why-we-evolved-v1-vs-v2.md index b9cc3ee9..3245a583 100644 --- a/explore-hyperswitch/payments-modules/reconciliation-product/why-we-evolved-v1-vs-v2.md +++ b/explore-hyperswitch/payments-modules/reconciliation-product/why-we-evolved-v1-vs-v2.md @@ -1,4 +1,5 @@ --- +description: Compare V1 and V2 reconciliation engines and key improvements hidden: true --- diff --git a/explore-hyperswitch/payments-modules/reconciliation/README.md b/explore-hyperswitch/payments-modules/reconciliation/README.md index b4aab3f9..82af0d95 100644 --- a/explore-hyperswitch/payments-modules/reconciliation/README.md +++ b/explore-hyperswitch/payments-modules/reconciliation/README.md @@ -70,7 +70,7 @@ By integrating Juspay Hyperswitch's reconciliation module, businesses can: * Merchants can also choose whether they want to do Manual reconciliation or Automated reconciliation. * We also allow merchants to specify the details of computations based on transaction values, fees, and taxes. * For instance, consider an order of $100 sent via Juspay Hyperswitch to the payment processor which will ultimately send this amount to the merchant's bank for settlement. However, in between, the payment procesor will deduct fees as well as taxes, let's say 5% each. Therefore, the settled amount will be $90, with a $5 fee and a $5 tax. - * The payment processor report should contain these details. However, in case these details are not present in the report , the merchant can specify these values. Based on the merchant configured specifications, we will reconcile the bank's settled amount. + * The payment processor report should contain these details. However, in case these details are not present in the report, the merchant can specify these values. Based on the merchant configured specifications, we will reconcile the bank's settled amount. 3. Once reconciliation is active for your merchant account, you will be notified through an email. You can log into Juspay Hyperswitch dashboard and click on 'Go to recon tab'. You will be redirected to the Reconciliation dashboard.
diff --git a/explore-hyperswitch/payments-modules/reconciliation/getting-started-with-recon.md b/explore-hyperswitch/payments-modules/reconciliation/getting-started-with-recon.md index b62840cc..223e31d7 100644 --- a/explore-hyperswitch/payments-modules/reconciliation/getting-started-with-recon.md +++ b/explore-hyperswitch/payments-modules/reconciliation/getting-started-with-recon.md @@ -8,7 +8,9 @@ description: >- # Getting Started with Recon {% hint style="info" %} + This section outlines the supported features of Juspay Hyperswitch Reconciliation module and provides guidance on how to use them. + {% endhint %} ## Using the Reconciliation module is a 5-step process @@ -32,7 +34,9 @@ The first phase of the process involves uploading your data files into the Recon * **Manual upload to the dashboard:** For ease of use, manually upload your files directly through the Reconciliation Dashboard. {% hint style="info" %} + Files need to be uploaded in **PGName\_yyyymmdd/ MERCHANTNAME\_yyyymmdd/ BANK\_NAME\_yyyymmdd** format. + {% endhint %} * **Automated upload to dashboard:** In order to feed your PSP and bank files to the Reconciliation module you can select one of the below options during configuration. In case of automated upload of files, case all subsequent steps are also executed in an automated fashion and the reconciliation output is generated. @@ -125,7 +129,7 @@ The output table provides access to specific information categories such as Gate * **Select desired columns:** Choose which columns to view, tailoring the report to focus on specific attributes like transaction ID, amount, status, and reconciliation status. * **Column naming:** Assign specific names to columns, enhancing clarity and alignment with your business's terminology. This change needs to be done by the Juspay Hyperswitch team. -* **Column positioning :** Assign a specific order to columns, enhancing clarity and alignment with your business' requirements . This change needs to be done by the Juspay Hyperswitch team. +* **Column positioning :** Assign a specific order to columns, enhancing clarity and alignment with your business' requirements. This change needs to be done by the Juspay Hyperswitch team. -> Key columns and status definitions (these are the default names) : diff --git a/explore-hyperswitch/security-and-compliance/README.md b/explore-hyperswitch/security-and-compliance/README.md index 73c0b74f..97bf9461 100644 --- a/explore-hyperswitch/security-and-compliance/README.md +++ b/explore-hyperswitch/security-and-compliance/README.md @@ -7,7 +7,7 @@ icon: arrow-down-up-lock # Security and Compliance -At Hyperswitch, we redefine how businesses handle payments by delivering secure, reliable, and scalable solutions tailored to your unique needs. Whether you're managing subscriptions, running a global marketplace, or scaling your e-commerce platform, Hyperswitch empowers you to optimize payments and grow with confidence. +At Juspay Hyperswitch, we redefine how businesses handle payments by delivering secure, reliable, and scalable solutions tailored to your unique needs. Whether you're managing subscriptions, running a global marketplace, or scaling your e-commerce platform, Hyperswitch empowers you to optimize payments and grow with confidence. **Security and Compliance at the Core** @@ -19,14 +19,14 @@ Built on AWS infrastructure, Hyperswitch supports global operations with low-lat **Performance You Can Trust** -Hyperswitch is designed for speed, keeping application latency under 30 milliseconds and optimizing inter-regional traffic with AWS CloudFront. +Juspay Hyperswitch is designed for speed, keeping application latency under 30 milliseconds and optimizing inter-regional traffic with AWS CloudFront. ### Key Features * **Modular Architecture:** Customize your payment setup to match your business requirements. * **Unified Analytics:** Access actionable insights to optimize costs and monitor performance. * **Advanced Fraud Prevention:** Protect transactions with 3DS authentication and risk management tools. -* **No-Code Integrations:** Quickly enable 70+ payment connectors and 150+ payment methods with minimal effort +* **No-Code Integrations:** Quickly enable 300+ connectors and 300+ payment methods with minimal effort
PCI Compliancepci-compliance.md
Data Securitysecurity.md
GDPR compliancegdpr-compliance.md

Identity and Access Management

identity-and-access-management.md
diff --git a/explore-hyperswitch/security-and-compliance/gdpr-compliance.md b/explore-hyperswitch/security-and-compliance/gdpr-compliance.md index e433bfe8..18c52338 100644 --- a/explore-hyperswitch/security-and-compliance/gdpr-compliance.md +++ b/explore-hyperswitch/security-and-compliance/gdpr-compliance.md @@ -1,5 +1,5 @@ --- -description: A brief summary of measures taken at Hyperswitch to ensure GDPR compliance +description: A brief summary of measures taken at Juspay Hyperswitch to ensure GDPR compliance icon: compact-disc --- @@ -17,7 +17,7 @@ Hyperswitch plays the role of a ‘Data Processor’ and takes all the below ini ### Security -Hyperswitch is engineered with a meticulous focus on safeguarding sensitive data aligning with PCI standards. The application also employs various strategies that encompasses various stage, which includes +Juspay Hyperswitch is engineered with a meticulous focus on safeguarding sensitive data aligning with PCI standards. The application also employs various strategies that encompasses various stage, which includes * Encryption of Data at rest and Data in Transit * Masking of PII information at source @@ -49,7 +49,7 @@ We hold ourselves to the highest standards of data security and reliability. We ### Use of Sub processors -Below is the list of sub-processors we use at Hyperswitch, as well as the purpose of their use. +Below is the list of sub-processors we use at Juspay Hyperswitch, as well as the purpose of their use. | Sub processor | Purpose | Hosted region | | :--------------: | :----------------------------------------------: | :------------------------------------------------------------: | diff --git a/explore-hyperswitch/security-and-compliance/identity-and-access-management.md b/explore-hyperswitch/security-and-compliance/identity-and-access-management.md index aaaecc96..a8311ddc 100644 --- a/explore-hyperswitch/security-and-compliance/identity-and-access-management.md +++ b/explore-hyperswitch/security-and-compliance/identity-and-access-management.md @@ -6,7 +6,7 @@ icon: id-card-clip Identity and Access Management (IAM) in Hyperswitch is designed to provide a secure, user-friendly, and well-regulated environment. By implementing best practices for authentication and access control, Hyperswitch ensures data confidentiality, operational efficiency, and compliance with global standards. -### Authentication Methodology for Hyperswitch APIs +### Authentication Methodology for Juspay Hyperswitch APIs **1. Admin Services Authentication** @@ -32,7 +32,7 @@ Hyperswitch employs Multi-Factor Authentication (MFA) in conjunction with networ * **Distributed Access Model:** Hyperswitch employs a distributed model where no individual has complete control over administrative operations. * **Principle of Least Privilege:** Permissions are restricted to essential tasks to mitigate unauthorized access risks. -### Benefits of Hyperswitch IAM +### Benefits of Juspay Hyperswitch IAM 1. **Enhanced Security:** Multi-layered authentication, key management, and RBAC reduce vulnerabilities. 2. **Operational Efficiency:** Clear role definitions and access models ensure streamlined workflows. diff --git a/explore-hyperswitch/security-and-compliance/pci-compliance.md b/explore-hyperswitch/security-and-compliance/pci-compliance.md index 3cccdec5..798e129b 100644 --- a/explore-hyperswitch/security-and-compliance/pci-compliance.md +++ b/explore-hyperswitch/security-and-compliance/pci-compliance.md @@ -1,5 +1,5 @@ --- -description: A brief summary of PCI compliance for Hyperswitch Cloud users +description: A brief summary of PCI compliance for Juspay Hyperswitch Cloud users icon: credit-card --- @@ -9,10 +9,10 @@ Payment Card Industry Data Security Standard (PCI DSS) compliance ensures that s **Hyperswitch Cloud provides out-of-the-box PCI DSS Level 1 compliance**—the highest level of certification—so you can handle payments securely without worrying about card storage or compliance complexities yourself. -### **Key Features of PCI Compliance on Hyperswitch Cloud** +### **Key Features of PCI Compliance on Juspay Hyperswitch Cloud** **PCI DSS Level 1 Certification**\ -Hyperswitch is validated as a **PCI DSS v4.0 Level 1 Service Provider**, the highest level of PCI certification for service providers. This ensures robust security controls for storing, processing, and transmitting cardholder data. +Juspay Hyperswitch is validated as a **PCI DSS v4.0 Level 1 Service Provider**, the highest level of PCI certification for service providers. This ensures robust security controls for storing, processing, and transmitting cardholder data. **Annual Audits**\ Hyperswitch undergoes an annual PCI DSS audit performed by an independent Qualified Security Assessor (QSA). In addition, quarterly vulnerability scans are conducted by a PCI-approved scanning vendor (ASV), as required by PCI DSS. @@ -41,7 +41,7 @@ Many payment processors disable raw card acceptance by default. To enable it: * A redacted version of Hyperswitch’s PCI DSS Attestation of Compliance (AOC) is available to Cloud users under NDA. It can be downloaded from the Compliance section in the Dashboard. * Alternatively, email **hyperswitch@juspay.in** for assistance. -### **Why Choose Hyperswitch for PCI Compliance?** +### **Why Choose Juspay Hyperswitch for PCI Compliance?** * Simplified compliance management with automatic tokenization and secure storage. * Global security standards maintained across all integrations. diff --git a/explore-hyperswitch/security-and-compliance/security.md b/explore-hyperswitch/security-and-compliance/security.md index 7aae9eca..d3aebdfc 100644 --- a/explore-hyperswitch/security-and-compliance/security.md +++ b/explore-hyperswitch/security-and-compliance/security.md @@ -1,11 +1,11 @@ --- -description: Comprehensive measures safeguarding Data Integrity within Hyperswitch +description: Comprehensive measures safeguarding Data Integrity within Juspay Hyperswitch icon: cloud-check --- # Data Security -At Hyperswitch, we prioritize data security and adhere to PCI DSS standards to protect sensitive information. Our platform is engineered with a robust multi-layered encryption framework to secure sensitive data, including API credentials, RSA certificates, database passwords, and Personally Identifiable Information (PII), throughout its lifecycle. +At Juspay Hyperswitch, we prioritize data security and adhere to PCI DSS standards to protect sensitive information. Our platform is engineered with a robust multi-layered encryption framework to secure sensitive data, including API credentials, RSA certificates, database passwords, and Personally Identifiable Information (PII), throughout its lifecycle. ### **Benefits of Our Security Framework** @@ -50,7 +50,7 @@ To provide insights and analytics without compromising sensitive information, on ## Data Encryption Overview -At Hyperswitch, we place the utmost importance on safeguarding sensitive data, including `external API credentials, customer information, and card details`. Our application employs a multi-layered encryption approach to ensure security during data transmission and storage. +At Juspay Hyperswitch, we place the utmost importance on safeguarding sensitive data, including `external API credentials, customer information, and card details`. Our application employs a multi-layered encryption approach to ensure security during data transmission and storage. * **Masked Transmission**: All sensitive data remains masked during transmission and is never permanently stored on local systems. * **Multi-Layered Encryption**: Data is encrypted at every critical juncture, ensuring robust protection against breaches. @@ -90,14 +90,17 @@ The encryption process ensures: ### Concealing Sensitive Data in Logs -At Hyperswitch, we take extra care to protect sensitive information, even in system logs. Our application framework uses a **wrapper type** to classify all sensitive data as `Secret`. +At Juspay Hyperswitch, we take extra care to protect sensitive information, even in system logs. Our application framework uses a **wrapper type** to classify all sensitive data as `Secret`. * **Leveraging Rust's Advantages**: Hyperswitch uses Rust, a strongly typed programming language, to create a robust mechanism (`Secret`) for handling sensitive data. * **Masked Logging**: Instead of exposing sensitive details such as passwords or Personally Identifiable Information (PII), we log only the data type (e.g., `*** alloc::string::String ***`). * **Source-Level Protection**: By masking sensitive data at its source, we ensure that sensitive information is never inadvertently exposed, even in debug outputs or logs. {% hint style="info" %} + **Database at Rest Encryption** -At Hyperswitch, we encrypt database instances in our cloud-hosted environments to protect sensitive information, including card details and merchant data. For self-hosted setups, we recommend adopting similar encryption practices to ensure robust security. +At Juspay Hyperswitch, we encrypt database instances in our cloud-hosted environments to protect sensitive information, including card details and merchant data. For self-hosted setups, we recommend adopting similar encryption practices to ensure robust security. + {% endhint %} + diff --git a/explore-hyperswitch/wallets/README.md b/explore-hyperswitch/wallets/README.md index 8b73df42..67b86b87 100644 --- a/explore-hyperswitch/wallets/README.md +++ b/explore-hyperswitch/wallets/README.md @@ -1,5 +1,5 @@ --- -description: Accept PayPal, GPay and Apple Pay through Hyperswitch +description: Accept PayPal, GPay and Apple Pay through Juspay Hyperswitch icon: wallet --- diff --git a/explore-hyperswitch/wallets/apple-pay/README.md b/explore-hyperswitch/wallets/apple-pay/README.md index dadf1249..68dbd406 100644 --- a/explore-hyperswitch/wallets/apple-pay/README.md +++ b/explore-hyperswitch/wallets/apple-pay/README.md @@ -1,5 +1,5 @@ --- -description: Guide to using Apple Pay payment method on Hyperswitch +description: Guide to using Apple Pay payment method on Juspay Hyperswitch icon: apple-pay --- @@ -26,7 +26,9 @@ Follow the below guide for setting up Apple Pay on Hyperswitch based on your use * Click on verify and enable to complete your setup {% hint style="warning" %} -Please note since the Apple Pay Web Domain flow involves decryption at Hyperswitch, you may need to write to your payment processor to get this feature enabled for your account. Stripe is one among them. + +Please note since the Apple Pay Web Domain flow involves decryption at Juspay Hyperswitch, you may need to write to your payment processor to get this feature enabled for your account. Stripe is one among them. + {% endhint %}
@@ -41,7 +43,6 @@ Please note since the Apple Pay Web Domain flow involves decryption at Hyperswit
- #### **Prerequisites** Before beginning to integrate Apple Pay with Hyperswitch, below prerequisites need to be fulfilled. _Please feel free to reach out to Hyperswitch support if you are stuck at any stage when integrating and testing Apple Pay._ @@ -70,7 +71,7 @@ You can validate the merchant domain by following the steps mentioned below - * Enter your _merchant\_domain_ as domain and click on Save * Click on Download and a **.txt** file will be downloaded * Host this file on _merchant\_domain_/.well-known/apple-developer-merchantid-domain-association.txt -* Once you host the .txt file in the path mentioned above, click on Verify +* Once you host the.txt file in the path mentioned above, click on Verify * Make sure the status is verified as shown in the following image
@@ -99,9 +100,6 @@ openssl x509 -inform der -in merchant_id.cer -out certificate_sandbox.pem ``` - - - ## **iOS Application** #### **Steps To Configure :** @@ -137,7 +135,9 @@ base64 -i certificate_sandbox.key #### **Creating Apple Pay Payment Processing Certificate** {% tabs %} + {% tab title="Payment Processing Details At Connector" %} +
* You will need to get a **.csr** file from your processor's dashboard, _(like Adyen, Cybersource)_ @@ -145,14 +145,18 @@ base64 -i certificate_sandbox.key * Under the **Apple Pay Payment Processing Certificate** section, click on Create Certificate * After answering whether the Merchant ID will be processed exclusively in China mainland, click on Continue * Upload the **.csr** you received from your processor and click Continue -* Click on the prompted Download button and you will get a .**cer** file, Upload this **.cer** file you received while creating Apple MerchantID Certificate on the processor's dashboard. +* Click on the prompted Download button and you will get a.**cer** file, Upload this **.cer** file you received while creating Apple MerchantID Certificate on the processor's dashboard. {% hint style="warning" %} + This final step is specific to the processor being used and is not necessary in Sandbox Test environment for some processors, such as Authorize.Net. + {% endhint %} + {% endtab %} -{% tab title="Payment Processing Details At Hyperswitch" %} +{% tab title="Payment Processing Details At Juspay Hyperswitch" %} + \\
@@ -160,13 +164,13 @@ This final step is specific to the processor being used and is not necessary in You can create an Apple Payment Processing Certificate and Payment Processing Key by following the steps mentioned below * Note: It is recommended that you keep all the generated files in the same folder for the sake of simplicity -* Open a terminal and create .**key** file using the following command +* Open a terminal and create.**key** file using the following command ``` openssl ecparam -name prime256v1 -genkey -noout -out ppc_private.key ``` -* You can create .**csr** file using the following command and enter your details asked in the prompt. You will get a .**csr** file. +* You can create.**csr** file using the following command and enter your details asked in the prompt. You will get a.**csr** file. ``` openssl req -out ppc_uploadMe.csr -new -key ppc_private.key @@ -174,9 +178,9 @@ openssl req -out ppc_uploadMe.csr -new -key ppc_private.key * Log in to your [Apple Developer account](https://developer.apple.com/account/resources/certificates/list), go to Identifiers and select the Merchant ID / Payment Platform Integrator ID you created previously * Under the Apple Pay Payment Processing Certificate, click on Create Certificate -* Upload the .**csr** file you just created (it would be called uploadMe.csr if you copy-pasted the command) and click on Continue. -* You will get a .**cer** file on clicking Download (it will probably be named **apple\_pay.cer**). -* In Payment Processing Certificate, **base64 encode** the entire content of your .**cer** file and paste it. +* Upload the.**csr** file you just created (it would be called uploadMe.csr if you copy-pasted the command) and click on Continue. +* You will get a.**cer** file on clicking Download (it will probably be named **apple\_pay.cer**). +* In Payment Processing Certificate, **base64 encode** the entire content of your.**cer** file and paste it. ``` base64 -i apple_pay.cer @@ -187,7 +191,9 @@ base64 -i apple_pay.cer
{% hint style="warning" %} -Please note since this flow involves decryption at Hyperswitch, you may need to write to your payment processor to get this feature enabled for your account. Stripe is one among them. + +Please note since this flow involves decryption at Juspay Hyperswitch, you may need to write to your payment processor to get this feature enabled for your account. Stripe is one among them. + {% endhint %}
@@ -200,7 +206,9 @@ Please note since this flow involves decryption at Hyperswitch, you may need to * Feature Request: We are using Hyperswitch, a Level 1 PCI DSS 3.2.1 compliant Payments Orchestrator, to manage payments on our website. In addition to Stripe, since we are using other processors as well to process payments across multiple geographies, we wanted to use Hyperswitch’s Payment Processing certificate to decrypt Apple pay tokens and send the decrypted Apple pay tokens to Stripe. So, please enable processing decrypted Apple pay token feature on our Stripe account. We’ve attached Hyperswitch’s PCI DSS AoC for reference.
+ {% endtab %} + {% endtabs %} #### Integrate with Xcode diff --git a/explore-hyperswitch/wallets/apple-pay/in-app-and-web-transactions-processed-using-hyperswitch-decryption.md b/explore-hyperswitch/wallets/apple-pay/in-app-and-web-transactions-processed-using-hyperswitch-decryption.md index f423b160..b8987cec 100644 --- a/explore-hyperswitch/wallets/apple-pay/in-app-and-web-transactions-processed-using-hyperswitch-decryption.md +++ b/explore-hyperswitch/wallets/apple-pay/in-app-and-web-transactions-processed-using-hyperswitch-decryption.md @@ -1,11 +1,11 @@ -# In-App and Web Transactions Processed Using Hyperswitch Decryption +# In-App and Web Transactions Processed Using Juspay Hyperswitch Decryption In this flow Hyperswitch decrypts the token internally using your uploaded certificates and then transforms the raw data for any downstream connector. #### **Mechanism:** 1. Frontend sends **encrypted Apple Pay token** to Hyperswitch. -2. Hyperswitch unwraps the token using your private key configured at Hyperswitch. +2. Juspay Hyperswitch unwraps the token using your private key configured at Hyperswitch. 3. Hyperswitch maps the DPAN and Cryptogram to the destination PSP’s API. ### **Configuration :** @@ -38,7 +38,7 @@ You can validate the merchant domain by following the steps mentioned below - * Enter your _merchant\_domain_ as domain and click on Save * Click on Download and a **.txt** file will be downloaded * Host this file on _merchant\_domain_/.well-known/apple-developer-merchantid-domain-association.txt -* Once you host the .txt file in the path mentioned above, click on Verify +* Once you host the.txt file in the path mentioned above, click on Verify * Make sure the status is verified as shown in the following image
@@ -66,7 +66,7 @@ openssl req -out uploadMe.csr -new -newkey rsa:2048 -nodes -keyout certificate_s openssl x509 -inform der -in merchant_id.cer -out certificate_sandbox.pem ``` -#### **Configuring Apple Pay on Hyperswitch** +#### **Configuring Apple Pay on Juspay Hyperswitch** You can configure Apple Pay on Hyperswitch by following the steps mentioned below - @@ -103,13 +103,13 @@ base64 -i certificate_sandbox.key You can create an Apple Payment Processing Certificate and Payment Processing Key by following the steps mentioned below * Note: It is recommended that you keep all the generated files in the same folder for the sake of simplicity -* Open a terminal and create .**key** file using the following command +* Open a terminal and create.**key** file using the following command ``` openssl ecparam -name prime256v1 -genkey -noout -out ppc_private.key ``` -* You can create .**csr** file using the following command and enter your details asked in the prompt. You will get a .**csr** file. +* You can create.**csr** file using the following command and enter your details asked in the prompt. You will get a.**csr** file. ``` openssl req -out ppc_uploadMe.csr -new -key ppc_private.key @@ -117,9 +117,9 @@ openssl req -out ppc_uploadMe.csr -new -key ppc_private.key * Log in to your [Apple Developer account](https://developer.apple.com/account/resources/certificates/list), go to Identifiers and select the Merchant ID / Payment Platform Integrator ID you created previously * Under the Apple Pay Payment Processing Certificate, click on Create Certificate -* Upload the .**csr** file you just created (it would be called uploadMe.csr if you copy-pasted the command) and click on Continue. -* You will get a .**cer** file on clicking Download (it will probably be named **apple\_pay.cer**). -* In Payment Processing Certificate, **base64 encode** the entire content of your .**cer** file and paste it. +* Upload the.**csr** file you just created (it would be called uploadMe.csr if you copy-pasted the command) and click on Continue. +* You will get a.**cer** file on clicking Download (it will probably be named **apple\_pay.cer**). +* In Payment Processing Certificate, **base64 encode** the entire content of your.**cer** file and paste it. ``` base64 -i apple_pay.cer @@ -130,7 +130,9 @@ base64 -i apple_pay.cer
{% hint style="warning" %} -Please note since this flow involves decryption at Hyperswitch, you may need to write to your payment processor to get this feature enabled for your account. Stripe is one among them. + +Please note since this flow involves decryption at Juspay Hyperswitch, you may need to write to your payment processor to get this feature enabled for your account. Stripe is one among them. + {% endhint %}
diff --git a/explore-hyperswitch/wallets/apple-pay/in-app-and-web-transactions-processed-using-merchant-decryption.md b/explore-hyperswitch/wallets/apple-pay/in-app-and-web-transactions-processed-using-merchant-decryption.md index c5853ffd..4ed3db38 100644 --- a/explore-hyperswitch/wallets/apple-pay/in-app-and-web-transactions-processed-using-merchant-decryption.md +++ b/explore-hyperswitch/wallets/apple-pay/in-app-and-web-transactions-processed-using-merchant-decryption.md @@ -43,10 +43,8 @@ The decryption sequence ensures the integrity and security of the payment data b * **Execute Payment:** Use the now-decrypted data to trigger a payment authorization. For specific field mapping, refer to your API's technical documentation. - #### **API Mapping -** -
Parameter NameRequiredDescription
payment_method_data.wallet.apple_pay.payment_data
payment_method_data.wallet.apple_pay.payment_method
payment_method_data.wallet.apple_pay.payment_method.display_name
payment_method_data.wallet.apple_pay.payment_method.network
payment_method_data.wallet.apple_pay.payment_method.type
payment_method_data.wallet.apple_pay.payment_method.card_exp_monthUse the applicationExpirationDate value, contained in the Apple Pay token.
payment_method_data.wallet.apple_pay.payment_method.card_exp_year

Use the applicationExpirationDate value, contained in the Apple Pay token.

payment_method_data.wallet.apple_pay.payment_method.auth_code
payment_method_data.wallet.apple_pay.transaction_identifierUse the transactionId value, contained in the Apple Pay token.
diff --git a/explore-hyperswitch/wallets/apple-pay/in-app-and-web-transactions-processed-using-psp-decryption.md b/explore-hyperswitch/wallets/apple-pay/in-app-and-web-transactions-processed-using-psp-decryption.md index dd1f642c..5c58665e 100644 --- a/explore-hyperswitch/wallets/apple-pay/in-app-and-web-transactions-processed-using-psp-decryption.md +++ b/explore-hyperswitch/wallets/apple-pay/in-app-and-web-transactions-processed-using-psp-decryption.md @@ -35,7 +35,7 @@ You can validate the merchant domain by following the steps mentioned below - * Enter your _merchant\_domain_ as domain and click on Save * Click on Download and a **.txt** file will be downloaded * Host this file on _merchant\_domain_/.well-known/apple-developer-merchantid-domain-association.txt -* Once you host the .txt file in the path mentioned above, click on Verify +* Once you host the.txt file in the path mentioned above, click on Verify * Make sure the status is verified as shown in the following image
@@ -63,7 +63,7 @@ openssl req -out uploadMe.csr -new -newkey rsa:2048 -nodes -keyout certificate_s openssl x509 -inform der -in merchant_id.cer -out certificate_sandbox.pem ``` -#### **Configuring Apple Pay on Hyperswitch** +#### **Configuring Apple Pay on Juspay Hyperswitch** You can configure Apple Pay on Hyperswitch by following the steps mentioned below - @@ -94,7 +94,6 @@ base64 -i certificate_sandbox.key
- #### **Creating Apple Pay Payment Processing Certificate**
@@ -104,10 +103,12 @@ base64 -i certificate_sandbox.key * Under the **Apple Pay Payment Processing Certificate** section, click on Create Certificate * After answering whether the Merchant ID will be processed exclusively in China mainland, click on Continue * Upload the **.csr** you received from your processor and click Continue -* Click on the prompted Download button and you will get a .**cer** file, Upload this **.cer** file you received while creating Apple MerchantID Certificate on the processor's dashboard. +* Click on the prompted Download button and you will get a.**cer** file, Upload this **.cer** file you received while creating Apple MerchantID Certificate on the processor's dashboard. {% hint style="warning" %} + This final step is specific to the processor being used and is not necessary in Sandbox Test environment for some processors, such as Authorize.Net. + {% endhint %} ### Integrate with Xcode diff --git a/explore-hyperswitch/wallets/apple-pay/ios-application.md b/explore-hyperswitch/wallets/apple-pay/ios-application.md index 62d5f248..6259ec80 100644 --- a/explore-hyperswitch/wallets/apple-pay/ios-application.md +++ b/explore-hyperswitch/wallets/apple-pay/ios-application.md @@ -34,7 +34,7 @@ You can validate the merchant domain by following the steps mentioned below - * Enter your _merchant\_domain_ as domain and click on Save * Click on Download and a **.txt** file will be downloaded * Host this file on _merchant\_domain_/.well-known/apple-developer-merchantid-domain-association.txt -* Once you host the .txt file in the path mentioned above, click on Verify +* Once you host the.txt file in the path mentioned above, click on Verify * Make sure the status is verified as shown in the following image
@@ -62,7 +62,7 @@ openssl req -out uploadMe.csr -new -newkey rsa:2048 -nodes -keyout certificate_s openssl x509 -inform der -in merchant_id.cer -out certificate_sandbox.pem ``` -## **Configuring Apple Pay on Hyperswitch** +## **Configuring Apple Pay on Juspay Hyperswitch** You can configure Apple Pay on Hyperswitch by following the steps mentioned below - @@ -95,7 +95,9 @@ base64 -i certificate_sandbox.key ## **Creating Apple Pay Payment Processing Certificate** {% tabs %} + {% tab title="Payment Processing Details At Connector" %} + \\
@@ -105,14 +107,18 @@ base64 -i certificate_sandbox.key * Under the **Apple Pay Payment Processing Certificate** section, click on Create Certificate * After answering whether the Merchant ID will be processed exclusively in China mainland, click on Continue * Upload the **.csr** you received from your processor and click Continue -* Click on the prompted Download button and you will get a .**cer** file, Upload this **.cer** file you received while creating Apple MerchantID Certificate on the processor's dashboard. +* Click on the prompted Download button and you will get a.**cer** file, Upload this **.cer** file you received while creating Apple MerchantID Certificate on the processor's dashboard. {% hint style="warning" %} + This final step is specific to the processor being used and is not necessary in Sandbox Test environment for some processors, such as Authorize.Net. + {% endhint %} + {% endtab %} -{% tab title="Payment Processing Details At Hyperswitch" %} +{% tab title="Payment Processing Details At Juspay Hyperswitch" %} + \\
@@ -120,13 +126,13 @@ This final step is specific to the processor being used and is not necessary in You can create an Apple Payment Processing Certificate and Payment Processing Key by following the steps mentioned below * Note: It is recommended that you keep all the generated files in the same folder for the sake of simplicity -* Open a terminal and create .**key** file using the following command +* Open a terminal and create.**key** file using the following command ``` openssl ecparam -name prime256v1 -genkey -noout -out ppc_private.key ``` -* You can create .**csr** file using the following command and enter your details asked in the prompt. You will get a .**csr** file. +* You can create.**csr** file using the following command and enter your details asked in the prompt. You will get a.**csr** file. ``` openssl req -out ppc_uploadMe.csr -new -key ppc_private.key @@ -134,9 +140,9 @@ openssl req -out ppc_uploadMe.csr -new -key ppc_private.key * Log in to your [Apple Developer account](https://developer.apple.com/account/resources/certificates/list), go to Identifiers and select the Merchant ID / Payment Platform Integrator ID you created previously * Under the Apple Pay Payment Processing Certificate, click on Create Certificate -* Upload the .**csr** file you just created (it would be called uploadMe.csr if you copy-pasted the command) and click on Continue. -* You will get a .**cer** file on clicking Download (it will probably be named **apple\_pay.cer**). -* In Payment Processing Certificate, **base64 encode** the entire content of your .**cer** file and paste it. +* Upload the.**csr** file you just created (it would be called uploadMe.csr if you copy-pasted the command) and click on Continue. +* You will get a.**cer** file on clicking Download (it will probably be named **apple\_pay.cer**). +* In Payment Processing Certificate, **base64 encode** the entire content of your.**cer** file and paste it. ``` base64 -i apple_pay.cer @@ -147,7 +153,9 @@ base64 -i apple_pay.cer
{% hint style="warning" %} -Please note since this flow involves decryption at Hyperswitch, you may need to write to your payment processor to get this feature enabled for your account. Stripe is one among them. + +Please note since this flow involves decryption at Juspay Hyperswitch, you may need to write to your payment processor to get this feature enabled for your account. Stripe is one among them. + {% endhint %}
@@ -160,7 +168,9 @@ Please note since this flow involves decryption at Hyperswitch, you may need to * Feature Request: We are using Hyperswitch, a Level 1 PCI DSS 3.2.1 compliant Payments Orchestrator, to manage payments on our website. In addition to Stripe, since we are using other processors as well to process payments across multiple geographies, we wanted to use Hyperswitch’s Payment Processing certificate to decrypt Apple pay tokens and send the decrypted Apple pay tokens to Stripe. So, please enable processing decrypted Apple pay token feature on our Stripe account. We’ve attached Hyperswitch’s PCI DSS AoC for reference.
+ {% endtab %} + {% endtabs %} ## Integrate with Xcode diff --git a/explore-hyperswitch/wallets/apple-pay/web-domain.md b/explore-hyperswitch/wallets/apple-pay/web-domain.md index a39a0a18..c4ae737d 100644 --- a/explore-hyperswitch/wallets/apple-pay/web-domain.md +++ b/explore-hyperswitch/wallets/apple-pay/web-domain.md @@ -6,7 +6,7 @@ icon: globe-wifi # Web Domain -## **Steps to configure Apple Pay on Hyperswitch** +## **Steps to configure Apple Pay on Juspay Hyperswitch** * Login to [Hyperswitch control center](https://app.hyperswitch.io/) * In the Processor tab, select desired connector @@ -21,7 +21,9 @@ icon: globe-wifi * Click on verify and enable to complete your setup {% hint style="warning" %} -Please note since the Apple Pay Web Domain flow involves decryption at Hyperswitch, you may need to write to your payment processor to get this feature enabled for your account. Stripe is one among them. + +Please note since the Apple Pay Web Domain flow involves decryption at Juspay Hyperswitch, you may need to write to your payment processor to get this feature enabled for your account. Stripe is one among them. + {% endhint %}
diff --git a/explore-hyperswitch/wallets/apple-pay/web-transactions-processed-using-hyperswitch-decryption-without-apple-merchant-id.md b/explore-hyperswitch/wallets/apple-pay/web-transactions-processed-using-hyperswitch-decryption-without-apple-merchant-id.md index a5b663a1..85053d5d 100644 --- a/explore-hyperswitch/wallets/apple-pay/web-transactions-processed-using-hyperswitch-decryption-without-apple-merchant-id.md +++ b/explore-hyperswitch/wallets/apple-pay/web-transactions-processed-using-hyperswitch-decryption-without-apple-merchant-id.md @@ -1,4 +1,4 @@ -# Web Transactions Processed Using Hyperswitch Decryption (Without Apple Merchant ID) +# Web Transactions Processed Using Juspay Hyperswitch Decryption (Without Apple Merchant ID) In this flow Hyperswitch decrypts the token internally using own certificates and then transforms the raw data for any downstream connector. @@ -10,7 +10,7 @@ In this flow Hyperswitch decrypts the token internally using own certificates an ### **Configuration :** -#### **Steps to configure Apple Pay on Hyperswitch** +#### **Steps to configure Apple Pay on Juspay Hyperswitch** * Login to [Hyperswitch control center](https://app.hyperswitch.io/) * In the Processor tab, select desired connector @@ -25,7 +25,9 @@ In this flow Hyperswitch decrypts the token internally using own certificates an * Click on verify and enable to complete your setup {% hint style="warning" %} -Please note since the Apple Pay Web Domain flow involves decryption at Hyperswitch, you may need to write to your payment processor to get this feature enabled for your account. Stripe is one among them. + +Please note since the Apple Pay Web Domain flow involves decryption at Juspay Hyperswitch, you may need to write to your payment processor to get this feature enabled for your account. Stripe is one among them. + {% endhint %}
diff --git a/explore-hyperswitch/wallets/google-pay/in-app-and-web-transactions-processed-using-hyperswitch-decryption.md b/explore-hyperswitch/wallets/google-pay/in-app-and-web-transactions-processed-using-hyperswitch-decryption.md index f2051475..cdcc3d00 100644 --- a/explore-hyperswitch/wallets/google-pay/in-app-and-web-transactions-processed-using-hyperswitch-decryption.md +++ b/explore-hyperswitch/wallets/google-pay/in-app-and-web-transactions-processed-using-hyperswitch-decryption.md @@ -1,4 +1,4 @@ -# In-App and Web Transactions Processed Using Hyperswitch Decryption +# In-App and Web Transactions Processed Using Juspay Hyperswitch Decryption In this flow Hyperswitch decrypts the Google Pay token using your shared keys. This allows Hyperswitch to route the payment to any downstream processor. @@ -9,7 +9,7 @@ There are few prerequisites that need to be fulfilled before integrating Google 1. Configure Google Pay on your processor's dashboard 2. In order to test Google Pay integration you will need to add test cards to your google account. You can go to [Google Pay API Test Cards Allowlist](https://groups.google.com/g/googlepay-test-mode-stub-data?pli=1) and click on Join Group to automatically add test cards in your Google Developer Account -## **Configuring Google Pay on Hyperswitch** +## **Configuring Google Pay on Juspay Hyperswitch** To configure Google Pay on Hyperswitch follow the steps given below - diff --git a/explore-hyperswitch/wallets/google-pay/in-app-and-web-transactions-processed-using-psp-decryption.md b/explore-hyperswitch/wallets/google-pay/in-app-and-web-transactions-processed-using-psp-decryption.md index 2dc1ff67..d6bbd706 100644 --- a/explore-hyperswitch/wallets/google-pay/in-app-and-web-transactions-processed-using-psp-decryption.md +++ b/explore-hyperswitch/wallets/google-pay/in-app-and-web-transactions-processed-using-psp-decryption.md @@ -11,7 +11,7 @@ There are few prerequisites that need to be fulfilled before integrating Google 1. Configure Google Pay on your processor's dashboard 2. In order to test Google Pay integration you will need to add test cards to your google account. You can go to [Google Pay API Test Cards Allowlist](https://groups.google.com/g/googlepay-test-mode-stub-data?pli=1) and click on Join Group to automatically add test cards in your Google Developer Account -#### **Configuring Google Pay on Hyperswitch** +#### **Configuring Google Pay on Juspay Hyperswitch** To configure Google Pay on Hyperswitch follow the steps given below - diff --git a/explore-hyperswitch/wallets/paypal.md b/explore-hyperswitch/wallets/paypal.md index bc39e6e6..a41e3423 100644 --- a/explore-hyperswitch/wallets/paypal.md +++ b/explore-hyperswitch/wallets/paypal.md @@ -7,7 +7,7 @@ icon: paypal Paypal is a digital wallet that lets customers load balance onto the wallet and as well as save their cards for quicker one-touch checkout. Paypal currently supports 200+ countries and 25 currencies. -## **How to configure Paypal on Hyperswitch?** +## **How to configure Paypal on Juspay Hyperswitch?** Since Paypal is both a payment method (wallet) as well as a payment processor, Hyperswitch gives you the flexibility to configure Paypal through multiple avenues. diff --git a/explore-hyperswitch/wallets/samsung-pay.md b/explore-hyperswitch/wallets/samsung-pay.md index 89a35da8..e574ddfd 100644 --- a/explore-hyperswitch/wallets/samsung-pay.md +++ b/explore-hyperswitch/wallets/samsung-pay.md @@ -15,7 +15,9 @@ Samsung Pay works only on supported Samsung devices. You can find the list of su Samsung Pay requires an Samsung Developer Account. You can [Sign Up](https://developer.samsung.com/pay/native/partner-onbarding.html#Sign-up%2FSign-in) following this. {% hint style="info" %} + _Please feel free to reach out to_ [_Hyperswitch support_](https://inviter.co/hyperswitch-slack) _if you are stuck at any stage when integrating and testing Samsung Pay._ + {% endhint %} ### **Create Samsung pay Web Online Payment Service** @@ -29,11 +31,11 @@ To create a new service, follow the steps below: 2. Enter the new `SERVICE NAME`. 3. Select your `SERVICE COUNTRY`. 4. Choose your `PAYMENT GATEWAY` from the list of supported payment gateways. -5. Upload the .csr file you received from your processor. +5. Upload the.csr file you received from your processor. 6. In the `SERVICE DOMAIN` field, enter your merchant\_domain and click the `ADD` button. If there are multiple merchant domains, add them one after the other. 7. Verify the details you've entered, check the `LEGAL AGREEMENTS` box, and click `SAVE AND NEXT`. -### **Configuring Samsung Pay on Hyperswitch** +### **Configuring Samsung Pay on Juspay Hyperswitch** To configure Samsung Pay on Hyperswitch, follow the steps below - @@ -50,5 +52,8 @@ To configure Samsung Pay on Hyperswitch, follow the steps below - 8. Select the card brands you want to allow customer to use when making Samsung Pay payments. {% hint style="danger" %} + Make sure that the Samsung Pay service is in the `Approved` state before configuring it on the Hyperswitch dashboard. If it is not, the Samsung Pay button will not be displayed during the payment process. + {% endhint %} + diff --git a/explore-hyperswitch/workflows/3ds-decision-manager/3ds-intelligence-engine/README.md b/explore-hyperswitch/workflows/3ds-decision-manager/3ds-intelligence-engine/README.md index ca8e4b1f..0eb8d06a 100644 --- a/explore-hyperswitch/workflows/3ds-decision-manager/3ds-intelligence-engine/README.md +++ b/explore-hyperswitch/workflows/3ds-decision-manager/3ds-intelligence-engine/README.md @@ -87,5 +87,8 @@ A merchant has to first configure the 3DS Exemptions Rules in the [Hyperswitch D After configuring and saving the rules, merchants can test out our 3DS Intelligence Engine in the [demo playground](https://demostore3ds.netlify.app/) by running mock transactions and seeing the 3DS authentication results as defined by them. {% embed url="https://files.gitbook.com/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fkf7BGdsPkCw9nalhAIlE%2Fuploads%2FXQTcHTQiPDVDzf12tlVj%2F3DS%20Demo.mp4?alt=media&token=3614e6bd-6980-4c9b-82ab-fccbcc8ea532" %} + A demo showcasing the Custom Defined Exemption rules + {% endembed %} + diff --git a/explore-hyperswitch/workflows/3ds-decision-manager/3ds-intelligence-engine/get-started-with-3ds-decision-manager.md b/explore-hyperswitch/workflows/3ds-decision-manager/3ds-intelligence-engine/get-started-with-3ds-decision-manager.md index e22e171b..b2960918 100644 --- a/explore-hyperswitch/workflows/3ds-decision-manager/3ds-intelligence-engine/get-started-with-3ds-decision-manager.md +++ b/explore-hyperswitch/workflows/3ds-decision-manager/3ds-intelligence-engine/get-started-with-3ds-decision-manager.md @@ -6,7 +6,9 @@ icon: screwdriver-wrench # 3DS Decision Manager {% hint style="warning" %} + [3DS intelligence engine](./) is the latest upgrade to our 3DS workflows. Please refer to that section for advanced controls. + {% endhint %} ### Benefits of Using the 3DS Decision Manager: @@ -21,7 +23,7 @@ Hyperswitch 3DS Decision Manager allows the merchant to configure advanced rules ### 3DS Decision Flow: -Hyperswitch integrates with multiple payment processors, enabling seamless 3D Secure authentication. +Juspay Hyperswitch integrates with multiple payment processors, enabling seamless 3D Secure authentication.

3DS Decision Flow

@@ -32,6 +34,9 @@ For example: If you wish to enforce 3DS for transactions over $100, you can defi
{% hint style="danger" %} + * Rules set in the **3DS Decision Manager** can be overridden if an explicit value is passed in the `/payments` request using the `authentication_type` parameter. ([API Reference](https://api-reference.hyperswitch.io/v1/payments/payments--create#body-authentication-type)) * Some processors may mandate 3DS regardless of your configuration. + {% endhint %} + diff --git a/explore-hyperswitch/workflows/3ds-decision-manager/README.md b/explore-hyperswitch/workflows/3ds-decision-manager/README.md index 197a5852..725df438 100644 --- a/explore-hyperswitch/workflows/3ds-decision-manager/README.md +++ b/explore-hyperswitch/workflows/3ds-decision-manager/README.md @@ -1,4 +1,5 @@ --- +description: Implement 3D Secure and Strong Customer Authentication for payments icon: badge-check --- diff --git a/explore-hyperswitch/workflows/3ds-decision-manager/authenticate-with-3d-secure-via-psp.md b/explore-hyperswitch/workflows/3ds-decision-manager/authenticate-with-3d-secure-via-psp.md index 95e59ea3..fedddb72 100644 --- a/explore-hyperswitch/workflows/3ds-decision-manager/authenticate-with-3d-secure-via-psp.md +++ b/explore-hyperswitch/workflows/3ds-decision-manager/authenticate-with-3d-secure-via-psp.md @@ -1,4 +1,5 @@ --- +description: Authenticate payments using 3D Secure via payment service providers icon: rotate-exclamation --- diff --git a/explore-hyperswitch/workflows/3ds-decision-manager/external-authentication-for-3ds-1.md b/explore-hyperswitch/workflows/3ds-decision-manager/external-authentication-for-3ds-1.md index fe211d78..b54aabe7 100644 --- a/explore-hyperswitch/workflows/3ds-decision-manager/external-authentication-for-3ds-1.md +++ b/explore-hyperswitch/workflows/3ds-decision-manager/external-authentication-for-3ds-1.md @@ -6,7 +6,7 @@ hidden: true icon: up-right-from-square --- -# Copy of Standalone 3D Secure (via Hyperswitch) +# Copy of Standalone 3D Secure (via Juspay Hyperswitch) Standalone 3DS separates authentication from authorization, giving you the flexibility to work with multiple payment processors or support specialized payment workflows. @@ -20,7 +20,7 @@ When a Standalone 3DS authentication completes successfully, it generates a 3DS Supported [external 3DS authenticators](https://juspay.io/integrations?categories=3DS+PROVIDER) are - Juspay 3DS server, Netcetera, Cardinal and 3dsecure.io -### Setup External 3DS authentication via Hyperswitch +### Setup External 3DS authentication via Juspay Hyperswitch 1. Log into the [Hyperswitch dashboard](https://app.hyperswitch.io/) 2. Under Connectors > setup 3DS Authenticator. You can select Juspay 3DS server or any other external 3DS server @@ -156,9 +156,14 @@ curl --location 'https://sandbox.hyperswitch.io/payments/pay_xXr8btC2depRWfVYKmN After the challenge is completed, the status should go to 'succeeded' status {% hint style="warning" %} + **Visit** [**this**](../../payment-orchestration/3ds-decision-manager/broken-reference/) **page to complete few additional steps to enable this feature for Mobile SDK.** + {% endhint %} {% hint style="success" %} + Being a payments product, Hyperswitch is always up to date with the latest regulations globally. On that front, the merchants need not worry about compliance. For merchants who want to integrate the latest authentication products to offer a frictionless payment flow to their customers, but also enjoy the liability shift, Hyperswitch has got you covered. Products like Digital Authentication Framework (DAF), Delegated Authentication (DA), Secure Payment Confirmation (SPC), Click to Pay (CTP), etc. are in our roadmap. Check out the product on sandbox or get in touch with us for more information. + {% endhint %} + diff --git a/explore-hyperswitch/workflows/3ds-decision-manager/external-authentication-for-3ds.md b/explore-hyperswitch/workflows/3ds-decision-manager/external-authentication-for-3ds.md index 22fdf972..126570d1 100644 --- a/explore-hyperswitch/workflows/3ds-decision-manager/external-authentication-for-3ds.md +++ b/explore-hyperswitch/workflows/3ds-decision-manager/external-authentication-for-3ds.md @@ -5,7 +5,7 @@ description: >- icon: up-right-from-square --- -# Standalone 3D Secure (via Hyperswitch) +# Standalone 3D Secure (via Juspay Hyperswitch) Standalone 3DS separates authentication from authorization, giving you the flexibility to work with multiple payment processors or support specialized payment workflows. @@ -19,7 +19,7 @@ When a Standalone 3DS authentication completes successfully, it generates a 3DS Supported [external 3DS authenticators](https://juspay.io/integrations?categories=3DS+PROVIDER) are - Juspay 3DS server, Netcetera, Cardinal and 3dsecure.io -### Setup External 3DS authentication via Hyperswitch +### Setup External 3DS authentication via Juspay Hyperswitch 1. Log into the [Hyperswitch dashboard](https://app.hyperswitch.io/) 2. Under Connectors > setup 3DS Authenticator. You can select Juspay 3DS server or any other external 3DS server diff --git a/explore-hyperswitch/workflows/3ds-decision-manager/import-3d-secure-results.md b/explore-hyperswitch/workflows/3ds-decision-manager/import-3d-secure-results.md index ed95f09f..2e9ac276 100644 --- a/explore-hyperswitch/workflows/3ds-decision-manager/import-3d-secure-results.md +++ b/explore-hyperswitch/workflows/3ds-decision-manager/import-3d-secure-results.md @@ -1,5 +1,5 @@ --- -description: Process payments when 3D Secure runs outside Hyperswitch +description: Process payments when 3D Secure runs outside Juspay Hyperswitch icon: shield-slash --- diff --git a/explore-hyperswitch/workflows/3ds-decision-manager/native-3ds-authentication-for-mobile-payments.md b/explore-hyperswitch/workflows/3ds-decision-manager/native-3ds-authentication-for-mobile-payments.md index eca685cb..8bd14664 100644 --- a/explore-hyperswitch/workflows/3ds-decision-manager/native-3ds-authentication-for-mobile-payments.md +++ b/explore-hyperswitch/workflows/3ds-decision-manager/native-3ds-authentication-for-mobile-payments.md @@ -1,4 +1,5 @@ --- +description: Implement native 3DS authentication for seamless mobile checkout hidden: true icon: star-shooting --- @@ -42,7 +43,7 @@ By providing a native 3DS experience, the users never leave the merchant app. It Since the authentication occurs natively, merchants have more control over the branding and design of the authentication experience. This keeps the look and feel consistent with the rest of the app or website, offering a smoother, more professional user experience. -## Native 3D Secure on Hyperswitch +## Native 3D Secure on Juspay Hyperswitch 1. **In-line 3DS Challenge for web** - No redirections for the user. @@ -63,5 +64,8 @@ Since the authentication occurs natively, merchants have more control over the b To enable the Native 3DS Authentication on your website or mobile app, you need to integrate an external 3DS authentication providers. **Hyperswitch allows you to integrate external 3DS authenticators like Netcetera and 3dsecure.io with minimal development efforts, Visit the below page for detailed steps.** {% content-ref url="external-authentication-for-3ds.md" %} + [external-authentication-for-3ds.md](external-authentication-for-3ds.md) + {% endcontent-ref %} + diff --git a/explore-hyperswitch/workflows/fraud-and-risk-management/activating-frm-in-hyperswitch.md b/explore-hyperswitch/workflows/fraud-and-risk-management/activating-frm-in-hyperswitch.md index 2f9bf0cf..165e1f48 100644 --- a/explore-hyperswitch/workflows/fraud-and-risk-management/activating-frm-in-hyperswitch.md +++ b/explore-hyperswitch/workflows/fraud-and-risk-management/activating-frm-in-hyperswitch.md @@ -1,8 +1,9 @@ --- +description: Activate fraud risk management solutions in Juspay Hyperswitch icon: shield-plus --- -# Activating FRM in Hyperswitch +# Activating FRM in Juspay Hyperswitch You can enable the [FRM solution](https://juspay.io/integrations) of your choice with few clicks and very minimal code changes. Below are the two scenarios for activating FRM within Hyperswitch. @@ -42,7 +43,9 @@ The Post-Auth flow occurs after payment authorization by the processor and is on * If `declined`: Void the payment. {% hint style="warning" %} + If the connector doesn’t support manual capture, Post-Authorization manual review should be avoided during configuration setup for the respective connector. + {% endhint %} #### FRM workflow diff --git a/explore-hyperswitch/workflows/fraud-and-risk-management/fraud-blocklist.md b/explore-hyperswitch/workflows/fraud-and-risk-management/fraud-blocklist.md index 6b55c507..eb4aad7b 100644 --- a/explore-hyperswitch/workflows/fraud-and-risk-management/fraud-blocklist.md +++ b/explore-hyperswitch/workflows/fraud-and-risk-management/fraud-blocklist.md @@ -33,7 +33,7 @@ Should the need arise, merchants can selectively unblock specific fingerprints, In summary, a blocklist feature empowers merchants to proactively manage the security of their payment processing systems by blocking specific fingerprints, card bins, or extended card bins. This not only safeguards against potential fraud but also provides a customizable and flexible approach to control and monitor payment transactions effectively. -### Blocklist via Hyperswitch +### Blocklist via Juspay Hyperswitch Currently we support blocking three types of resources i.e. card numbers (payment instrument), card bin, and extended card bin. A prerequisite to use this feature is to enable it using the /blocklist API as mentioned below. @@ -54,14 +54,14 @@ Currently we support blocking three types of resources i.e. card numbers (paymen block the card. * Try the payment again (should fail) -#### Enabling blocklist guard on Hyperswitch +#### Enabling blocklist guard on Juspay Hyperswitch ``` -curl --location --request POST '{{base_url}}/blocklist/toggle?status=true' \ +curl --location --request POST '{{base_url}}/blocklist/toggle?`status = true'` \ --header 'api-key: dev_xxxxxxxxxxxxxxxx' ``` -### Configuring blocklist on Hyperswitch using API +### Configuring blocklist on Juspay Hyperswitch using API 1. Create card payment through Hyperswitch using [Payments Create API](https://api-reference.hyperswitch.io/v1/payments/payments--create) 2. In the [Payments response](https://api-reference.hyperswitch.io/v1/payments/payments--create#response-fingerprint-one-of-0), make note of the `fingerprint` field which is the unique fingerprint for a card passed to Hyperswitch @@ -92,7 +92,7 @@ curl --location --request POST '{{base_url}}/blocklist/toggle?status=true' \ } }, - ... +... "fingerprint": "CKz5s9W4FX03eydwgGun" diff --git a/explore-hyperswitch/workflows/intelligent-routing/README.md b/explore-hyperswitch/workflows/intelligent-routing/README.md index 5c2fccf8..99652a30 100644 --- a/explore-hyperswitch/workflows/intelligent-routing/README.md +++ b/explore-hyperswitch/workflows/intelligent-routing/README.md @@ -1,4 +1,5 @@ --- +description: Route payments dynamically using ML-based intelligent routing icon: flux-capacitor --- @@ -19,7 +20,7 @@ Hyperswitch supports four intelligent routing strategies: * The hedging percentage decides the exploration factor of the model * **Least Cost Routing:** Picks the least cost network for every transaction basis the availability of back-of-the-card network and processor compatibility * **Elimination Routing:** Tracks acute incidents such as downtimes and technical errors to de-prioritise gateways. This will be used as a final check after other routing logics are applied. -* **Contracts-Based Routing:** Distributes payments across processors to meet contractual volume commitments. \[BETA FEATURE] +* **Contracts-Based Routing:** Distributes payments across processors to meet contractual volume commitments. [BETA FEATURE] ### Architecture Diagram diff --git a/explore-hyperswitch/workflows/intelligent-routing/auth-rate-based-routing.md b/explore-hyperswitch/workflows/intelligent-routing/auth-rate-based-routing.md index 853e7a87..2a756825 100644 --- a/explore-hyperswitch/workflows/intelligent-routing/auth-rate-based-routing.md +++ b/explore-hyperswitch/workflows/intelligent-routing/auth-rate-based-routing.md @@ -1,4 +1,5 @@ --- +description: Optimize routing using real-time authorization rate data icon: badge-check --- @@ -28,7 +29,7 @@ Key Configurations * Max: No. of buckets used to calculate scores (FIFO manner). It determines the reaction time * Min: No. of buckets after which the scores will be used. It is equivalent to the zero error/offset for error tolerance -### How to setup Auth Rate Based Routing for your Hyperswitch Merchant? +### How to setup Auth Rate Based Routing for your Juspay Hyperswitch Merchant? 1. Enabling your profile with Auth Rate based routing @@ -77,7 +78,7 @@ You can use the routing playground tool to simulate different payment scenarios Access the tool using this URL - [https://hyperswitch-ten.vercel.app/](https://hyperswitch-ten.vercel.app/) 1. Create a merchant on Hyperswitch Control Center -2. Ensure to configure at least two payment processors for the merhcant profile +2. Ensure to configure at least two payment processors for the merchant profile 3. Enter the sandbox API key, merchant id and profile id in the modal that pops-up once you click the 'Start Simulation' button on the top-right corner 4. Head to the 'routing' tab on the left nav bar and toggle the Success Based Routing button 5. Select the desired routing configuration settings diff --git a/explore-hyperswitch/workflows/intelligent-routing/default-fallback-routing.md b/explore-hyperswitch/workflows/intelligent-routing/default-fallback-routing.md index a7bbc454..cec84187 100644 --- a/explore-hyperswitch/workflows/intelligent-routing/default-fallback-routing.md +++ b/explore-hyperswitch/workflows/intelligent-routing/default-fallback-routing.md @@ -11,7 +11,7 @@ icon: shield-exclamation ## Get started with Default Fallback Routing -In the Default Fallback , if the active routing rules are not applicable, the priority order of all configured payment processors is used to route payments. This priority order is configurable from the Dashboard. +In the Default Fallback, if the active routing rules are not applicable, the priority order of all configured payment processors is used to route payments. This priority order is configurable from the Dashboard. ### Steps to configure Default fallback Configuration in Smart Router: diff --git a/explore-hyperswitch/workflows/intelligent-routing/rule-based-routing.md b/explore-hyperswitch/workflows/intelligent-routing/rule-based-routing.md index 0cd9460e..6ddb1225 100644 --- a/explore-hyperswitch/workflows/intelligent-routing/rule-based-routing.md +++ b/explore-hyperswitch/workflows/intelligent-routing/rule-based-routing.md @@ -24,7 +24,6 @@ A rule-based routing configuration comprises of one or more rules with each rule ## Steps to configure Rule Based Configuration in Smart Router: - _**Step 1:**_ Click on `Setup` for **Rule Based Configuration:**
@@ -44,3 +43,4 @@ _**Step 4:**_ You can view your active routing algorithm as well as all previous ## How does Rule Based Routing works {% embed url="https://hyperswitch.io/video/Rule_Based_video.mp4" %} + diff --git a/explore-hyperswitch/workflows/intelligent-routing/self-deployment-guide.md b/explore-hyperswitch/workflows/intelligent-routing/self-deployment-guide.md index 81d67439..ddd8a276 100644 --- a/explore-hyperswitch/workflows/intelligent-routing/self-deployment-guide.md +++ b/explore-hyperswitch/workflows/intelligent-routing/self-deployment-guide.md @@ -1,4 +1,5 @@ --- +description: Self-deploy the intelligent routing engine with Docker icon: screwdriver-wrench --- diff --git a/explore-hyperswitch/workflows/smart-retries/README.md b/explore-hyperswitch/workflows/smart-retries/README.md index 617f2925..72029497 100644 --- a/explore-hyperswitch/workflows/smart-retries/README.md +++ b/explore-hyperswitch/workflows/smart-retries/README.md @@ -92,7 +92,6 @@ Each of the error codes are mapped individually as to whether they are eligible **User Consent-based Retries:** These retries are applicable for payment flows that need an additional level of user authentication (example: Apple Pay, Google Pay, 3DS cards, bank transfers). Such payment flows need an additional authentication from the user. Hence smart retries are not possible for such scenarios. - ## How to enable Smart Retries? **Step 1:** Ensure that you have enabled the pecking order of payment processors on the Hyperswitch dashboard. You can access the settings from Routing > Default fallback > Manage. @@ -105,7 +104,6 @@ Each of the error codes are mapped individually as to whether they are eligible #### - ## FAQs
diff --git a/explore-hyperswitch/workflows/smart-retries/manual-user-triggered-retries.md b/explore-hyperswitch/workflows/smart-retries/manual-user-triggered-retries.md index 660ce218..3d6151a5 100644 --- a/explore-hyperswitch/workflows/smart-retries/manual-user-triggered-retries.md +++ b/explore-hyperswitch/workflows/smart-retries/manual-user-triggered-retries.md @@ -127,7 +127,7 @@ If this payment fails, the response will include: #### 3️⃣ Retry the Payment (If Allowed) -If `manual_retry_allowed : true` , you can retry on the same Payment Intent.\\ +If `manual_retry_allowed : true`, you can retry on the same Payment Intent.\\ * For redirect flows, this can be done by remounting the SDK as described earlier. * For SDK-managed (non-redirect) flows, Hyperswitch automatically handles this internally. diff --git a/explore-hyperswitch/workflows/smart-retries/processor-error-code-mapping.md b/explore-hyperswitch/workflows/smart-retries/processor-error-code-mapping.md index 43d350ca..5214b18c 100644 --- a/explore-hyperswitch/workflows/smart-retries/processor-error-code-mapping.md +++ b/explore-hyperswitch/workflows/smart-retries/processor-error-code-mapping.md @@ -18,7 +18,6 @@ Upon receiving an error, the system classifies the transaction as either Non-Ret To illustrate the classification process, the following tables lists few sample Stripe error codes and how our AI model categorizes them into Retryable versus Non-Retryable workflows. - #### **Error codes categorize as Retryable :** | code | message | @@ -43,7 +42,6 @@ To illustrate the classification process, the following tables lists few sample | fraudulent | The payment was declined because Stripe suspects that it's fraudulent. | - #### **Error codes categorize as Non-Retryable :** | **Error Code** | **Description / Message** | diff --git a/explore-hyperswitch/workflows/vault/README.md b/explore-hyperswitch/workflows/vault/README.md index 74a8a936..8efef065 100644 --- a/explore-hyperswitch/workflows/vault/README.md +++ b/explore-hyperswitch/workflows/vault/README.md @@ -1,11 +1,11 @@ --- -description: Modular vaulting in Hyperswitch +description: Modular vaulting in Juspay Hyperswitch icon: vault --- # Vault -Hyperswitch offers flexible vault deployment options to suit different merchant PCI profiles and hosting preferences. Whether you’re self-hosting Hyperswitch with your own PCI setup or leveraging the fully managed SaaS orchestration layer, Hyperswitch’s modular vault architecture adapts seamlessly to your compliance boundary.\ +Juspay Hyperswitch offers flexible vault deployment options to suit different merchant PCI profiles and hosting preferences. Whether you’re self-hosting Hyperswitch with your own PCI setup or leveraging the fully managed SaaS orchestration layer, Hyperswitch’s modular vault architecture adapts seamlessly to your compliance boundary.\ \ This section outlines the various Vault Flavors supported by Hyperswitch - covering self-hosted and SaaS environments, in-house and outsourced PCI models, and integrations with Juspay-hosted or third-party vaults such as VGS and Tokenex. Each model includes sequence diagrams, supported feature sets, and references to relevant configuration guides. @@ -13,7 +13,7 @@ This section outlines the various Vault Flavors supported by Hyperswitch - cover
Merchant ProfileHosting TypeVault OptionPCI ResponsibilityExample Use Case
Merchant ProfileHosting TypeVault OptionPCI ResponsibilityExample Use Case
SaaS orchestration + Juspay vaultJuspay hosts Hyperswitch orchestrationJuspay hosted vaultPCI handled by JuspayEnterprise or mid-scale merchants using Hyperswitch SaaS
SaaS orchestration + third-party vaultJuspay hosts Hyperswitch orchestrationThird-party vault or vault + SDKPCI shared with external vault providerMerchants already invested in external token vaults
Self-hosted & in-house PCIMerchant hosts Hyperswitch orchestrationNative vault within self deployed HyperswitchMerchant manages PCI DSS complianceLarge enterprise merchants with full PCI scope
Self-hosted & outsourced PCI (similar to SaaS with 3rd party vault)Merchant hosts Hyperswitch orchestrationJuspay hosted vault + SDK or third-party vault + SDK (VGS, Tokenex) PCI outsourced to third-party providerMerchants who want control over orchestration but offload PCI
Vaulting & outsourced PCI-Juspay hosted vault + SDKPCI handled by JuspayMerchants looking for unified token vault with Proxy API
-### Modular vaulting in Hyperswitch +### Modular vaulting in Juspay Hyperswitch Modular Vaulting is a key component of Juspay’s payment system, offering merchants the flexibility to either use Hyperswitch’s built-in PCI-compliant vault with advanced tokenization and security features or connect to any third party vault provider. This flexibility enables businesses to start simple and scale confidently without re-architecting their entire system. diff --git a/explore-hyperswitch/workflows/vault/connect-external-vaults-to-hyperswitch-orchestration.md b/explore-hyperswitch/workflows/vault/connect-external-vaults-to-hyperswitch-orchestration.md index 511747a7..5dc1801b 100644 --- a/explore-hyperswitch/workflows/vault/connect-external-vaults-to-hyperswitch-orchestration.md +++ b/explore-hyperswitch/workflows/vault/connect-external-vaults-to-hyperswitch-orchestration.md @@ -6,9 +6,9 @@ hidden: true icon: plug --- -# Connect External Vaults to Hyperswitch Orchestration +# Connect External Vaults to Juspay Hyperswitch Orchestration -### Modular Vaulting in Hyperswitch +### Modular Vaulting in Juspay Hyperswitch Hyperswitch addresses the challenges with traditional vaults through Modular Vaulting: a flexible, merchant-centric approach to payment data infrastructure that emphasizes control, interoperability, and security. @@ -39,7 +39,7 @@ Merchants can outsource their PCI compliance to Juspay by opting to use [Juspay #### Third Party Vault -Through Hyperswitch, Merchants can add [external vault providers](https://juspay.io/integrations) such as VGS, HashiCorp, and Voltage, leveraging their SDKs to collect and tokenize cards. This ensures flexibility in vault selection while maintaining compliance, security, and seamless token management across multiple payment processors. Additionally, we also support other extended features vai an external vault such as: +Through Juspay Hyperswitch, Merchants can add [external vault providers](https://juspay.io/integrations) such as VGS, HashiCorp, and Voltage, leveraging their SDKs to collect and tokenize cards. This ensures flexibility in vault selection while maintaining compliance, security, and seamless token management across multiple payment processors. Additionally, we also support other extended features vai an external vault such as: * Network Tokenization - Merchants can configure Network Tokenization through either Juspay as TSP or use the External Vault as TSP, ensuring flexibility and control over token provisioning * Proxy Payments through External Vaults - Support for processing payments through Proxy layers to ensure PCI compliance diff --git a/explore-hyperswitch/workflows/vault/external-vault-sdk-+-storage/README.md b/explore-hyperswitch/workflows/vault/external-vault-sdk-+-storage/README.md index 67490f8f..011def9c 100644 --- a/explore-hyperswitch/workflows/vault/external-vault-sdk-+-storage/README.md +++ b/explore-hyperswitch/workflows/vault/external-vault-sdk-+-storage/README.md @@ -12,7 +12,7 @@ In this approach, card data is captured and tokenized using an external vault SD The merchant configures connectors and orchestration logic in the Hyperswitch Dashboard. Hyperswitch does not participate in card capture or storage. -#### Configuring External Vault on Hyperswitch +#### Configuring External Vault on Juspay Hyperswitch For External Vaults to work with Hyperswitch you need to configure the required API credentials on the Hyperswitch dashboard. You can do this by navigating to _**Orchestrator > Connector > Vault Processor**_ and entering the required details. @@ -24,7 +24,6 @@ When utilizing External Vaults, merchants have the flexibility to define how pay * **Independent Integration:** The External Vault SDK manages the card data and user experience entirely independently of the Hyperswitch SDK. The card is tokenized directly with your chosen vault, after which you will have to pass the token returned by external vault along with the card metadata to Hyperswitch to process the payment. - ### **Understanding the flow** #### **Layered Integration** @@ -36,7 +35,6 @@ When utilizing External Vaults, merchants have the flexibility to define how pay Your Merchant Server initiates the process by calling the [`payments/create`](https://api-reference.hyperswitch.io/v1/payments/payments--create) API. Hyperswitch returns the `payment_id` and `client_secret`. These credentials are then passed to your frontend to begin the secure session. - **2. Dual SDK Initialization** The Hyperswitch SDK initializes on the frontend and performs two critical tasks: @@ -45,7 +43,6 @@ The Hyperswitch SDK initializes on the frontend and performs two critical tasks: * Vault Integration: It triggers the loading of the External Vault SDK. This creates a secure "iframe" or isolated field specifically for capturing card data. - **3. Secure Data Capture** The customer enters their payment details into the checkout form. @@ -54,25 +51,21 @@ The customer enters their payment details into the checkout form. * Tokenization: Before the payment is even submitted to the processor, the external Vault SDK sends the details to the External Vault, which returns a secure token representing that card. - **4. Payment Confirmation via Token** When the customer clicks "Pay," the Hyperswitch SDK sends a confirmation request to the Hyperswitch Server. Instead of containing actual card numbers, this request contains the Vault Token. - **5. Orchestration and Processing** The Hyperswitch uses the poxy API of the external vault and passed the the token, the external vault resplace the token with raw card data and send the payment request to the PSP. - **6. Completion** Once the processor provides a final status, the response is relayed back from the external vault to the SDK. The customer is then redirected to your `return_url` to finalize the order experience. - #### **Independent Integration**
@@ -82,25 +75,21 @@ Once the processor provides a final status, the response is relayed back from th The merchant integrates the External Vault SDK to securely capture and tokenize the customer's card details. - **2.Payment Initiation** The merchant server triggers the Hyperswitch `payments/create` API, passing the external vault token within the request payload alongside standard payment parameters. - **3.Card Data Retrieval** Hyperswitch securely communicates with the external vault to exchange the token for the raw card data. - **4.Processor Handover** Hyperswitch routes the payment request to the chosen Payment Service Provider (PSP) using the raw card credentials. - **5.Payment Confirmation** The merchant receives the final `payments/create` API response, confirming the transaction status and payment details. diff --git a/explore-hyperswitch/workflows/vault/external-vault-sdk-+-storage/processing-payments-with-external-vault.md b/explore-hyperswitch/workflows/vault/external-vault-sdk-+-storage/processing-payments-with-external-vault.md index 53ae8f71..36278f70 100644 --- a/explore-hyperswitch/workflows/vault/external-vault-sdk-+-storage/processing-payments-with-external-vault.md +++ b/explore-hyperswitch/workflows/vault/external-vault-sdk-+-storage/processing-payments-with-external-vault.md @@ -5,7 +5,6 @@ icon: money-bill-wave # Processing payments with external vault - When working with an external vault provider, here’re the options available to handle a saved card transaction. **Option 1 -** Hyperswitch server uses the proxy payments flow of external vaults to send vault tokens in the PSP payment request. These tokens are replaced with raw card data by the external vault before the request is forwarded to the PSP.
diff --git a/explore-hyperswitch/workflows/vault/hyperswitch-sdk-+-external-vault.md b/explore-hyperswitch/workflows/vault/hyperswitch-sdk-+-external-vault.md index 8d6b12d9..e64ed5a7 100644 --- a/explore-hyperswitch/workflows/vault/hyperswitch-sdk-+-external-vault.md +++ b/explore-hyperswitch/workflows/vault/hyperswitch-sdk-+-external-vault.md @@ -26,7 +26,9 @@ Your Merchant Client (frontend) uses the `client_secret` to initialize the Hyper **3. Customer Selection & Data Entry** -The SDK displays the payment interface to the customer. Once the customer selects a payment method (such as entering credit card details), the SDK captures this information. Note: This data is handled within the secure SDK environment, ensuring sensitive details do not pass through your servers. +The SDK displays the payment interface to the customer. Once the customer selects a payment method (such as entering credit card details), the SDK captures this information. + +> **Note:** This data is handled within the secure SDK environment, ensuring sensitive details do not pass through your servers. **4. Payment Confirmation** @@ -69,7 +71,6 @@ The Hyperswitch Server forwards the raw card data, along with your merchant cred The connector returns the transaction status (e.g., "Succeeded" or "Failed") to the Hyperswitch Server. This status is passed down to the SDK, which then handles the final redirect to your `return_url`. - **Integration Documentation :** * [**Unified Checkout Integration guide**](https://docs.hyperswitch.io/explore-hyperswitch/merchant-controls/integration-guide) diff --git a/explore-hyperswitch/workflows/vault/hyperswitch-vault-pass-through-proxy-payments.md b/explore-hyperswitch/workflows/vault/hyperswitch-vault-pass-through-proxy-payments.md index 35863b69..b3750afd 100644 --- a/explore-hyperswitch/workflows/vault/hyperswitch-vault-pass-through-proxy-payments.md +++ b/explore-hyperswitch/workflows/vault/hyperswitch-vault-pass-through-proxy-payments.md @@ -4,7 +4,7 @@ hidden: true icon: arrows-repeat --- -# Hyperswitch Vault: Pass Through Proxy Payments +# Juspay Hyperswitch Vault: Pass Through Proxy Payments **📌 What is it?** diff --git a/explore-hyperswitch/workflows/vault/payment-methods-management-sdk.md b/explore-hyperswitch/workflows/vault/payment-methods-management-sdk.md index 58149474..12f614ff 100644 --- a/explore-hyperswitch/workflows/vault/payment-methods-management-sdk.md +++ b/explore-hyperswitch/workflows/vault/payment-methods-management-sdk.md @@ -1,6 +1,6 @@ --- description: >- - Learn how to tokenize cards at Hyperswitch Vault Service using our Payment + Learn how to tokenize cards at Juspay Hyperswitch Vault Service using our Payment Methods Management SDK hidden: true icon: gear @@ -9,7 +9,7 @@ coverY: 0 # Payment Methods Management SDK -## Secure Tokenization using Hyperswitch's PCI Compliant Payment Methods Management SDK +## Secure Tokenization using Juspay Hyperswitch's PCI Compliant Payment Methods Management SDK The Hyperswitch Payment Methods Management SDK provides a secure solution for merchants to handle and store payment information without the burden of PCI DSS compliance requirements. By leveraging Hyperswitch's Vault service, merchants can securely store customer payment methods (credit cards, digital wallets, etc.) while minimizing their exposure to sensitive payment data. @@ -36,6 +36,7 @@ Get your API key from the [Hyperswitch dashboard](https://app.hyperswitch.io/dev #### Creating a Payment Methods Session Endpoint {% hint style="info" %} + All Vault API (V2) requests require authentication using specific API keys generated from your Vault Merchant account. These keys are distinct from your standard payment processing keys. To generate your Vault API keys, follow these steps: @@ -46,6 +47,7 @@ To generate your Vault API keys, follow these steps: 4. **Secure Storage:** Copy the generated key and store it securely. You must use this key to authenticate all Vault API (V2) calls. **Note:** We are currently working on unifying authentication across our platforms. Soon, you will be able to use a single API key for both Payments and Vault APIs. + {% endhint %} Add an endpoint on your server that creates payment methods sessions. This endpoint will return the necessary session information to your client application: @@ -103,7 +105,7 @@ $ npm install @juspay-tech/hyper-js $ npm install @juspay-tech/react-hyper-js ``` -#### 2.2 Add Hyperswitch to Your React App +#### 2.2 Add Juspay Hyperswitch to Your React App Import the necessary components and hooks: @@ -113,7 +115,7 @@ import { loadHyper } from "@juspay-tech/hyper-js"; import { HyperManagementElements } from "@juspay-tech/react-hyper-js"; ``` -#### 2.3 Initialize the Hyperswitch Library +#### 2.3 Initialize the Juspay Hyperswitch Library Configure the library with your publishable API key and profile ID: @@ -140,8 +142,8 @@ useEffect(() => { headers: { "Content-Type": "application/json" }, body: JSON.stringify({customer_id: "customer_id"}), }) - .then((res) => res.json()) - .then((data) => { +.then((res) => res.json()) +.then((data) => { setPmClientSecret(data.pmClientSecret); setPmSessionId(data.pmSessionId); }); diff --git a/explore-hyperswitch/workflows/vault/saas-orchestration-with-third-party-vault.md b/explore-hyperswitch/workflows/vault/saas-orchestration-with-third-party-vault.md index 358b6d87..37d70867 100644 --- a/explore-hyperswitch/workflows/vault/saas-orchestration-with-third-party-vault.md +++ b/explore-hyperswitch/workflows/vault/saas-orchestration-with-third-party-vault.md @@ -22,7 +22,7 @@ Key Highlights: For External Vaults to work with Hyperswitch you need to configure the required API credentials on the Hyperswitch dashboard. You can do this by navigating to _Orchestrator > Connector > Vault Processor_ and entering the required details. -#### **1. Hyperswitch managed client and card form** +#### **1. Juspay Hyperswitch managed client and card form** In this approach, the Hyperswitch SDK is used to capture card details, but card storage and tokenization are handled by an external vault. Hyperswitch backend orchestrates payments using tokens issued by the external vault. @@ -32,7 +32,7 @@ In this approach, the Hyperswitch SDK is used to capture card details, but card 2. The [Payment Confirm API request](https://api-reference.hyperswitch.io/v1/payments/payments--confirm) containing the payment method is sent to the PSP from Hyperswitch 3. Once the PSP responds with the outcome `approved` or `declined` along with the PSP token, Hyperswitch then proceeds to store and tokenize the card. 4. The card is stored in external vault, which returns a `vault_token` -5. Upon receiving the `vault_token`, Hyperswitch generates a `payment_method_id` . A `payment_method_id` is a versatile token and connects a lot of entities together like `customer_id`, `psp_token`, `vault_token` +5. Upon receiving the `vault_token`, Hyperswitch generates a `payment_method_id`. A `payment_method_id` is a versatile token and connects a lot of entities together like `customer_id`, `psp_token`, `vault_token` 6. This `Payment_method_id` is returned to the merchant via web hooks **Repeat user payments flow** @@ -41,7 +41,7 @@ In this approach, the Hyperswitch SDK is used to capture card details, but card 2. The end-user can select the desired payment option and add their `CVV` 3. The SDK sends the [Payment Confirm API request](https://api-reference.hyperswitch.io/v1/payments/payments--confirm) when the user hits `Pay` 4. The Hyperswitch backend resolves the `payment_method_id` to identify available `vault_token` - 1. Hyperswitch can use the `detokenize` flow to obtain the raw card in exchange for the `vault_token` . It will the send payload with the raw card credential to the payment provider or PSP downstream. + 1. Hyperswitch can use the `detokenize` flow to obtain the raw card in exchange for the `vault_token`. It will the send payload with the raw card credential to the payment provider or PSP downstream. **Merchant Initiated Transaction (MIT) flow** @@ -49,7 +49,7 @@ In this approach, the Hyperswitch SDK is used to capture card details, but card
-#### **2. Hyperswitch managed client with External Vault's card form** +#### **2. Juspay Hyperswitch managed client with External Vault's card form** In this flow, the External Vault SDK is layered directly onto the Hyperswitch Unified Checkout SDK. The External Vault SDK captures card details and tokenizes them immediately at the vault. This ensures that sensitive card data never touches the Hyperswitch server. @@ -63,7 +63,7 @@ In this flow, the External Vault SDK is layered directly onto the Hyperswitch Un 6. This PSP Payload containing the `vault_token` is sent to the Proxy endpoint of the external vault 7. The external vault replaces the `vault_token` with the raw card and sends the request the PSP 8. Once the PSP responds with the outcome `approved` or `declined` along with the PSP token, the Proxy endpoint of the external vault sends the response back to Hyperswitch server -9. Upon receiving the `vault_token`, Hyperswitch generates a `payment_method_id` . A `payment_method_id` is a versatile token and connects a lot of entities together like `customer_id`, `psp_token`, `vault_token` +9. Upon receiving the `vault_token`, Hyperswitch generates a `payment_method_id`. A `payment_method_id` is a versatile token and connects a lot of entities together like `customer_id`, `psp_token`, `vault_token` 10. This `Payment_method_id` and `vault_token` are returned to the merchant via web hooks **Repeat user payments flow** @@ -72,7 +72,7 @@ In this flow, the External Vault SDK is layered directly onto the Hyperswitch Un 2. The end-user can select the desired payment option and add their `CVV` 3. The SDK sends the [Payment Confirm API request](https://api-reference.hyperswitch.io/v1/payments/payments--confirm) API request to the Hyperswitch server when the user hits `Pay` 4. The Hyperswitch backend resolves the `payment_method_id` to identify available `vault_token` - 1. Hyperswitch can use the `detokenize` flow to obtain the raw card in exchange for the `vault_token` . It will the send payload with the raw card credential to the payment provider or PSP downstream. + 1. Hyperswitch can use the `detokenize` flow to obtain the raw card in exchange for the `vault_token`. It will the send payload with the raw card credential to the payment provider or PSP downstream. **Merchant Initiated Transaction (MIT) flow** @@ -94,13 +94,13 @@ The merchant integrated with external vault SDK which manages the card data and 6. This PSP Payload containing the `vault_token` is sent to the Proxy endpoint of the external vault 7. The external vault replaces the `vault_token` with the raw card and sends the request the PSP 8. Once the PSP responds with the outcome `approved` or `declined` along with the PSP token, the Proxy endpoint of the external vault sends the response back to Hyperswitch server -9. Upon receiving the `vault_token`, Hyperswitch generates a `payment_method_id` . A `payment_method_id` is a versatile token and connects a lot of entities together like `customer_id`, `psp_token`, `vault_token` +9. Upon receiving the `vault_token`, Hyperswitch generates a `payment_method_id`. A `payment_method_id` is a versatile token and connects a lot of entities together like `customer_id`, `psp_token`, `vault_token` 10. This `Payment_method_id` and `vault_token` are returned to the merchant via web hooks **Repeat user payments flow** 1. In a repeat-user the payment, the merchant needs to load the stored payment methods of the customer based the `customer_id` sent as part of the [Payment Method - List Customer Saved Payment Methods](https://api-reference.hyperswitch.io/v2/payment-methods/payment-method--list-customer-saved-payment-methods-v1) API request. -2. The end-user can select the desired payment option and add their `CVV` . This `CVV` is entered directly into the elements provided by external vault. +2. The end-user can select the desired payment option and add their `CVV`. This `CVV` is entered directly into the elements provided by external vault. 3. The external vault tokenizes the CVV temporarily and returns a `temp_vault_token` 4. The merchant will use [Payments Create API request](https://api-reference.hyperswitch.io/v1/payments/payments--create) to send the `vault_token` and the `temp_vault_token` of the card selected by the end user. 5. Hyperswitch server then creates the PSP payload based on the payment providers or PSPs configured for the merchant diff --git a/explore-hyperswitch/workflows/vault/self-hosted-orchestration-with-external-or-third-party-pci-vault.md b/explore-hyperswitch/workflows/vault/self-hosted-orchestration-with-external-or-third-party-pci-vault.md index 2148357c..0539f902 100644 --- a/explore-hyperswitch/workflows/vault/self-hosted-orchestration-with-external-or-third-party-pci-vault.md +++ b/explore-hyperswitch/workflows/vault/self-hosted-orchestration-with-external-or-third-party-pci-vault.md @@ -68,7 +68,7 @@ The merchant client/checkout integrates the external vault SDK **directly** whic
-#### Option 2: Hyperswitch Managed Merchant Client +#### Option 2: Juspay Hyperswitch Managed Merchant Client This is an extension of the previous approach where instead of the merchant client directly mounting the external Vault SDK on their checkout client, merchant client mounts the Hyperswitch SDK which internally loads the external Vault SDK and handles token management. @@ -139,7 +139,7 @@ This abstraction allows merchants to: ### Configuration Guide -#### Configuring the External Vault in Hyperswitch +#### Configuring the External Vault in Juspay Hyperswitch To enable an external vault with your self-hosted Hyperswitch instance: diff --git a/explore-hyperswitch/workflows/vault/server-to-server-vault-tokenization.md b/explore-hyperswitch/workflows/vault/server-to-server-vault-tokenization.md index d496708e..fff50d2d 100644 --- a/explore-hyperswitch/workflows/vault/server-to-server-vault-tokenization.md +++ b/explore-hyperswitch/workflows/vault/server-to-server-vault-tokenization.md @@ -38,6 +38,7 @@ To implement server-to-server tokenization, you need: ### API Requests for Server to Server Tokenization {% hint style="info" %} + All Vault API (V2) requests require authentication using specific API keys generated from your Vault Merchant account. These keys are distinct from your standard payment processing keys. To generate your Vault API keys, follow these steps: @@ -48,6 +49,7 @@ To generate your Vault API keys, follow these steps: 4. **Secure Storage:** Copy the generated key and store it securely. You must use this key to authenticate all Vault API (V2) calls. **Note:** We are currently working on unifying authentication across our platforms. Soon, you will be able to use a single API key for both Payments and Vault APIs. + {% endhint %} #### 1. Create a Customer diff --git a/explore-hyperswitch/workflows/vault/vault-sdk-integration-1.md b/explore-hyperswitch/workflows/vault/vault-sdk-integration-1.md index ebfc5edf..6430811b 100644 --- a/explore-hyperswitch/workflows/vault/vault-sdk-integration-1.md +++ b/explore-hyperswitch/workflows/vault/vault-sdk-integration-1.md @@ -1,6 +1,6 @@ --- description: >- - Learn how to tokenize cards at Hyperswitch Vault Service using our Payment + Learn how to tokenize cards at Juspay Hyperswitch Vault Service using our Payment Methods Management SDK hidden: true icon: desktop @@ -8,7 +8,7 @@ icon: desktop # Vault SDK - JS with REST API Integration -## Secure Tokenization using Hyperswitch's PCI Compliant Payment Methods Management SDK +## Secure Tokenization using Juspay Hyperswitch's PCI Compliant Payment Methods Management SDK The Hyperswitch Vault/Payment Methods Management SDK provides a secure solution for merchants to handle and store payment information without the burden of PCI DSS compliance requirements. By leveraging Hyperswitch's Vault service, merchants can securely store customer payment methods (credit cards, digital wallets, etc.) while minimizing their exposure to sensitive payment data. @@ -33,6 +33,7 @@ First, you'll need to set up your server to create payment method sessions, whic Get your API key from the [Hyperswitch dashboard](https://app.hyperswitch.io/developers?tabIndex=1) under Developers -> API Keys section. You'll need both your API key and profile ID for server and client integration. {% hint style="info" %} + All Vault API (V2) requests require authentication using specific API keys generated from your Vault Merchant account. These keys are distinct from your standard payment processing keys. To generate your Vault API keys, follow these steps: @@ -43,6 +44,7 @@ To generate your Vault API keys, follow these steps: 4. **Secure Storage:** Copy the generated key and store it securely. You must use this key to authenticate all Vault API (V2) calls. **Note:** We are currently working on unifying authentication across our platforms. Soon, you will be able to use a single API key for both Payments and Vault APIs. + {% endhint %} #### Creating a Payment Methods Session Endpoint diff --git a/explore-hyperswitch/workflows/vault/vault-sdk-integration.md b/explore-hyperswitch/workflows/vault/vault-sdk-integration.md index 35f9068e..ff3008bd 100644 --- a/explore-hyperswitch/workflows/vault/vault-sdk-integration.md +++ b/explore-hyperswitch/workflows/vault/vault-sdk-integration.md @@ -1,6 +1,6 @@ --- description: >- - Learn how to tokenize cards at Hyperswitch Vault Service using our Payment + Learn how to tokenize cards at Juspay Hyperswitch Vault Service using our Payment Methods Management SDK hidden: true icon: desktop @@ -8,7 +8,7 @@ icon: desktop # Vault SDK Integration -## Secure Tokenization using Hyperswitch's PCI Compliant Vault SDK +## Secure Tokenization using Juspay Hyperswitch's PCI Compliant Vault SDK The Hyperswitch Vault/Payment Methods Management SDK provides a secure solution for merchants to handle and store payment information without the burden of PCI DSS compliance requirements. By leveraging Hyperswitch's Vault service, merchants can securely store customer payment methods (credit cards, digital wallets, etc.) while minimizing their exposure to sensitive payment data. @@ -40,6 +40,7 @@ Add an endpoint on your server that creates payment methods sessions. This endpo > For more details, kindly refer to the [API](https://api-reference.hyperswitch.io/introduction) reference documentation. {% hint style="info" %} + All Vault API (V2) requests require authentication using specific API keys generated from your Vault Merchant account. These keys are distinct from your standard payment processing keys. To generate your Vault API keys, follow these steps: @@ -50,6 +51,7 @@ To generate your Vault API keys, follow these steps: 4. **Secure Storage:** Copy the generated key and store it securely. You must use this key to authenticate all Vault API (V2) calls. **Note:** We are currently working on unifying authentication across our platforms. Soon, you will be able to use a single API key for both Payments and Vault APIs. + {% endhint %} ```javascript @@ -102,7 +104,7 @@ $ npm install @juspay-tech/hyper-js $ npm install @juspay-tech/react-hyper-js ``` -#### 2.2 Add Hyperswitch to Your React App +#### 2.2 Add Juspay Hyperswitch to Your React App Import the necessary components and hooks: @@ -112,7 +114,7 @@ import { loadHyper } from "@juspay-tech/hyper-js"; import { HyperManagementElements } from "@juspay-tech/react-hyper-js"; ``` -#### 2.3 Initialize the Hyperswitch Library +#### 2.3 Initialize the Juspay Hyperswitch Library Configure the library with your publishable API key and profile ID: @@ -143,8 +145,8 @@ useEffect(() => { headers: { "Content-Type": "application/json" }, body: JSON.stringify({customer_id: "customer_id"}), }) - .then((res) => res.json()) - .then((data) => { +.then((res) => res.json()) +.then((data) => { setPmClientSecret(data.pmClientSecret); setPmSessionId(data.pmSessionId); }); From 84cf27f7676872fceeecce138e029347ce591961 Mon Sep 17 00:00:00 2001 From: Atul P Date: Mon, 30 Mar 2026 16:16:39 +0530 Subject: [PATCH 2/2] docs: convert flow diagram images to Mermaid code blocks - Convert architecture diagrams to Mermaid flowcharts - File 1: External Vault SDK options diagram - File 2: Visa Click to Pay V1 to V2 migration wrapper diagram --- .../visa-click-to-pay-v1-to-v2-migration.md | 29 ++++++++++++++++++- ...nal-vaults-to-hyperswitch-orchestration.md | 27 ++++++++++++++++- 2 files changed, 54 insertions(+), 2 deletions(-) diff --git a/explore-hyperswitch/payment-orchestration/click-to-pay/visa-click-to-pay-v1-to-v2-migration.md b/explore-hyperswitch/payment-orchestration/click-to-pay/visa-click-to-pay-v1-to-v2-migration.md index 963ff807..fdf1d2d5 100644 --- a/explore-hyperswitch/payment-orchestration/click-to-pay/visa-click-to-pay-v1-to-v2-migration.md +++ b/explore-hyperswitch/payment-orchestration/click-to-pay/visa-click-to-pay-v1-to-v2-migration.md @@ -26,7 +26,34 @@ The migration to V2 is powered by Hyperswitch's specialized wrapper solution, en This guide will help you migrate from Visa Click to Pay SDK V1 to V2 in less than 30 minutes. Our wrapper maintains backward compatibility while giving you access to V2's enhanced features. -![Architecture diagram of Visa Click to Pay integration, showing how the Wrapper mediates between Client browser/app and Visa's Click to Pay server while supporting both V1 and V2 SDKs.](../../../../.gitbook/assets/1.png) + + +```mermaid +flowchart LR + subgraph Client["Client Side"] + A[Browser/App] + end + + subgraph Hyperswitch["Juspay Hyperswitch"] + B[Wrapper
V1/V2 Detection] + end + + subgraph Visa["Visa Click to Pay"] + C[V1 SDK] + D[V2 SDK] + end + + A -->|V1 Requests| B + A -->|V2 Requests| B + B -->|V1 Flow| C + B -->|V2 Flow| D + C -->|Process| Visa + D -->|Process| Visa + + style A fill:#f9f,stroke:#333 + style B fill:#ff9,stroke:#333 + style Visa fill:#9f9,stroke:#333 +``` ### Integration Methods diff --git a/explore-hyperswitch/workflows/vault/connect-external-vaults-to-hyperswitch-orchestration.md b/explore-hyperswitch/workflows/vault/connect-external-vaults-to-hyperswitch-orchestration.md index 5dc1801b..b46e4a31 100644 --- a/explore-hyperswitch/workflows/vault/connect-external-vaults-to-hyperswitch-orchestration.md +++ b/explore-hyperswitch/workflows/vault/connect-external-vaults-to-hyperswitch-orchestration.md @@ -49,7 +49,32 @@ Through Juspay Hyperswitch, Merchants can add [external vault providers](https:/ In case of using External vaults, merchants also have the option to choose which SDK to use to collect payment method details from their customers. -![](../../../.gitbook/assets/2.png) + + +```mermaid +flowchart TD + subgraph Client["Client Side"] + A[Customer] --> B{Hyperswitch SDK} + end + + subgraph Option1["Option 1: Hyperswitch Unified Checkout SDK"] + B --> C[Hyperswitch Server] + C --> D[External Vault
Tokenize Card] + D --> E[Hyperswitch Server
Retrieve Raw Card] + E --> F[PSP
Process Payment] + end + + subgraph Option2["Option 2: External Vault SDK"] + B --> G[External Vault SDK
Tokenize Card] + G --> H[External Vault
De-tokenize] + H --> F + end + + style A fill:#f9f,stroke:#333 + style F fill:#9f9,stroke:#333 + style D fill:#ff9,stroke:#333 + style G fill:#ff9,stroke:#333 +```

Flexible External Vaulting with Choice of Vault SDK or Hyperswitch SDKs for Card Collection