# Proxy Payment The Proxy Payments Service allows merchants to tokenize cards via Juspay Hyperswitch Vault and make API calls to PSPs using those tokens. The Vault intercepts these requests, replaces tokens with raw card data (de-tokenization), and forwards them securely to the PSP. Key Highlights: * No PSP re-integration needed – Keep your existing PSP connections. * PCI DSS scope reduction – Raw card data stays within Vault. * Data security – Detokenization happens only during the request lifecycle. * Centralized token management – One vault, many PSPs. ### Vault and Proxy - Vaulting and Payments Flow ```mermaid %%{init: { "theme": "base", "themeVariables": { "primaryColor": "#ffffff", "primaryBorderColor": "#2563EB", "lineColor": "#2563EB", "secondaryColor": "#EFF6FF", "tertiaryColor": "#DBEAFE", "fontFamily": "Inter, system-ui, sans-serif", "fontSize": "14px", "textColor": "#000000", "actorBkg": "#346DDB", "actorBorder": "#999999", "actorTextColor": "#ffffff", "signalColor": "#000000", "signalTextColor": "#696969", "labelBoxBkgColor": "#346DDB", "labelBoxBorderColor": "#2563EB" } }}%% sequenceDiagram participant C as Consumer participant MFE as Merchant FE participant PSDK as Hyperswitch PM SDK participant MBE as Merchant BE participant HBE as Hyperswitch BE participant V as Vault participant PSP as PSP MFE ->> MBE: Create-payment-method-session with customer_id MBE ->> HBE: "Create-payment-method-session" API using Merchant HS API Key & Profile ID HBE -->> MBE: sdk_authorization MBE -->> MFE: sdk_authorization Note over MFE: Create a script tag to load HyperLoader.js Note over MFE: Initialize window.Hyper using the Publishable Key Note over MFE: Create PMM elements group using sdkAuthorization Note over MFE: Create specific widget instance & mount SDK C ->> PSDK: Add Payment method PSDK ->> HBE: "Payment Method Session - Confirm a payment method session" API with card details HBE ->> V: Store card details Note over MBE: CVV is stored temporarily for a specific TTL or until first txn V -->> HBE: Response HBE -->> PSDK: Response (Session id & associated_token_id) MBE ->> HBE: "Payment Method Session - List Payment Methods" API with Session id HBE -->> MBE: Response (PM_ID) Note over MBE: Response contains all payment methods associated with customer Note over MBE: Choose the PM_ID for the Session id of the session Note over MBE: Making a proxy payment MBE ->> HBE: Send PSP payment request to Vault proxy endpoint with PM_ID HBE ->> PSP: Send PSP payment request
to PSP (PM_ID replaced with actual card data) PSP -->> HBE: Payment response HBE -->> MBE: Payment response ``` #### 1. Create Payment Method Session (Server-Side) The merchant server initiates the flow by calling the Hyperswitch [`Create-payment-method-session`](https://api-reference.hyperswitch.io/v2/payment-method-session/payment-method-session--create-v1) API with the `customer_id`. Hyperswitch responds with a `sdk_authorization`, which are required to authenticate the client-side session. ```bash curl --request POST \ --url https://sandbox.hyperswitch.io/v1/payment-method-sessions \ --header 'Authorization: ' \ --header 'Content-Type: application/json' \ --header 'X-Profile-Id: ' \ --data ' { "customer_id": "12345_cus_abcdefghijklmnopqrstuvwxyz" } ' ``` #### 2. Initialize SDK (Client-Side) The merchant client loads the `HyperLoader.js` script and initializes `window.Hyper` using the Publishable Key. Using the `sdk_authorization`, the SDK creates a Payment Method Management (PMM) group and mounts the specific widget instance to the UI. ```js // Fetches a payment method session and mounts the payment methods management element async function initialize() { // Step 1: Create payment method session const response = await fetch("/create-payment-method-session", { method: "POST", headers: { "Content-Type": "application/json" }, body: JSON.stringify({ customer_id: "CUSTOMER_ID", }), }); const { sdkAuthorization } = await response.json(); // Step 2: Initialize HyperLoader.js var script = document.createElement("script"); script.type = "text/javascript"; script.src = "https://beta.hyperswitch.io/v1/HyperLoader.js"; let hyper; script.onload = () => { // Step 3: Initialize Hyper with your publishable key and profile ID hyper = window.Hyper({ publishableKey: "YOUR_PUBLISHABLE_KEY", profileId: "YOUR_PROFILE_ID", }); // Step 4: Configure appearance const appearance = { theme: "default", }; // Step 5: Create payment methods management elements const paymentMethodsManagementElements = hyper.paymentMethodsManagementElements({ appearance, sdkAuthorization: sdkAuthorization, }); // Step 6: Create and mount the paymentMethodsManagement element const paymentMethodsManagement = paymentMethodsManagementElements.create( "paymentMethodsManagement" ); paymentMethodsManagement.mount("#payment-methods-management-elements"); }; document.body.appendChild(script); } // Call initialize when page loads or when user clicks a button initialize(); ``` #### 3. Collect and Vault Card (Client-Side) The customer enters their card details directly into the SDK-managed widget. Upon confirmation, the SDK calls the `/Confirm a payment method session` API. Hyperswitch securely receives the data, stores it in the Vault (retaining the CVV temporarily for the transaction TTL), and returns a success response with the `session_id` to the client. #### 4. Retrieve Payment Method ID (Server-Side) The merchant server calls the "List Payment Methods" API using the `session_id`. Hyperswitch returns a list of payment methods associated with the customer, from which the merchant server selects the appropriate `PM_ID` (Payment Method ID) to use for the transaction. #### Execute Proxy Payment (Server-Side) The merchant server initiates the payment by sending a request to the [Hyperswitch vault proxy](https://docs.hyperswitch.io/~/revisions/01bZ2maqjwpnmrttix7i/explore-hyperswitch/payments-modules/vault/hyperswitch-vault-pass-through-proxy-payments) endpoint using the `payment_method_id`. The proxy securely replaces the token with the actual card data from the Vault and forwards the request to the Payment Service Provider (PSP), returning the final payment response to the merchant. #### New User Payments Flow 1. Create Payment Method Session (Server-Side) The merchant server initiates the flow by calling the Hyperswitch 2. [Initialize SDK (Client-Side)](/integration-guide/payment-experience/payment-method.md) The merchant client loads the `HyperLoader.js` script and initializes `window.Hyper` using the Publishable Key. Using the `sdk_authorization`, the SDK creates a Payment Method Management (PMM) group and mounts the specific widget instance to the UI. 3. Collect and Vault Card (Client-Side) The customer enters their card details directly into the SDK-managed widget. Upon confirmation, the SDK calls the `/Confirm a payment method session` API. Hyperswitch securely receives the data, stores it in the Vault (retaining the CVV temporarily for the transaction TTL), and returns a success response with the `session_id` to the client. 4. Retrieve Payment Method ID (Server-Side) The merchant server calls the "List Payment Methods" API using the `session_id`. Hyperswitch returns a list of payment methods associated with the customer, from which the merchant server selects the appropriate `PM_ID` (Payment Method ID) to use for the transaction. 5. Execute Proxy Payment (Server-Side) The merchant server initiates the payment by sending a request to the #### Proxy Payment Request Include the following details: 1. Include the Hyperswitch Proxy payments related fields in the headers: 1. URL: Proxy endpoint () 2. API Key: Your API key for the merchant\_id under which the vault service was created on Hyperswitch dashboard 3. Profile\_id: Your profile\_id for the merchant\_id under which the vault service was created on Hyperswitch dashboard 2. Include the following details in the body: 1. `request_body`: Include the request body of the PSP payment request 2. `destination_url`, `method`, `headers`: Pass your PSP url as destination url, PSP endpoint method and headers under the respective fields 3. Vault tokens: 1. `token_type`: Choose payment\_method\_id or tokenization\_id 2. `token`: Plug the payment\_method\_id or tokenization\_id that you would have received when tokenizing card data or PII data at Hyperswitch vault 4. Placeholders for token data: In the `request_body`, Plug in the dynamic placeholders `{{$card_number}}`, `{{$card_exp_month}}`, `{{$card_exp_year}}` against the PSP request fields where you want the actual values of the tokens from the Vault to be substituted #### Sample Proxy Payment Request (Checkout.com) 
curl --location 'https://sandbox.hyperswitch.io/proxy' \
--header 'Content-Type: application/json' \
--header 'Accept: application/json' \
--header 'X-Profile-Id: pro_p3ifmp0HzuC0Bp1KhMnK' \
--header 'Authorization: api-key=dev_bBPAkg0KX9Wn4Zewavrd0W76LsgDpGSey8iMARauXDWqzX4zwk4D03d0851Tx0EV' \
--header 'api-key: dev_30hnPzj6Kk6UAETk9hjWdaIxdVVuTk3mjmz2kxh6CIhq1K1DJ4nTZdpGt986L53G' \
--data '{
    "request_body": {
        "source": {
            "type": "card",
            "number": "{{$card_number}}",
            "expiry_month": "{{$card_exp_month}}",
            "expiry_year": "{{$card_exp_year}}",
            "billing_address": {
                "address_line1": "123 High St.",
                "address_line2": "Flat 456",
                "city": "London",
                "state": "GB",
                "zip": "SW1A 1AA",
                "country": "GB"
            }
        },
        "processing_channel_id": "pc_jx5lvimg..",
        "amount": 6540,
        "currency": "USD",
        "payment_type": "Regular",
        "reference": "ORD-5023-4E89",
        "description": "Set of 3 masks",
        "capture": true,
        "capture_on": "2019-09-10T10:11:12Z",
    },
    "destination_url": "https://api.sandbox.checkout.com/payments",
    "headers": {
        "Content-Type": "application/json",
        "Authorization": "Bearer sk_sbox_3uu..."
    },
    "token": "12345_pm_0196f252baa1736190bf0fc81b9651ea",
    "token_type": "payment_method_id",
    "method": "POST"

}'
#### Sample Response ```bash { "response": { "id": "pay_7f6x6vki25futmy54uot5c3ama", "action_id": "act_egzzg6mojknungbe3367fvsiaq", "amount": 6540, "currency": "USD", "approved": true, "status": "Authorized", "auth_code": "690380", "response_code": "10000", "response_summary": "Approved", "risk": { "flagged": false, "score": 0.0 }, "source": { "id": "src_jliqxofnudseteb5dl4hl7frh4", "type": "card", "expiry_month": 12, "expiry_year": 2026, "scheme": "Visa", "last4": "0093", "fingerprint": "EEF6D525CC7C861D6AB1CEB56F9285839AE850E79BA43D7D8C06790B7A0ABD7C", "bin": "476136", "card_type": "CREDIT", "card_category": "CONSUMER", "issuer": "YES BANK, LTD.", "issuer_country": "IN", "product_id": "F", "product_type": "Visa Classic", "avs_check": "G", "payment_account_reference": "V001711066651680047", "regulated_indicator": false }, "processed_on": "2025-05-21T10:10:42.7625936Z", "reference": "ORD-5023-4E89", "scheme_id": "509352732623965", "processing": { "acquirer_transaction_id": "096359746174895421192", "retrieval_reference_number": "404030119279", "merchant_category_code": "5815", "scheme_merchant_id": "75155", "scheme": "VISA", "aft": false, "pan_type_processed": "fpan", "cko_network_token_available": false, "provision_network_token": false }, "expires_on": "2025-06-20T10:10:42.7625936Z", "_links": { "self": { "href": "https://api.sandbox.checkout.com/payments/pay_7f6x6vki25futmy54uot5c3ama" }, "actions": { "href": "https://api.sandbox.checkout.com/payments/pay_7f6x6vki25futmy54uot5c3ama/actions" }, "capture": { "href": "https://api.sandbox.checkout.com/payments/pay_7f6x6vki25futmy54uot5c3ama/captures" }, "void": { "href": "https://api.sandbox.checkout.com/payments/pay_7f6x6vki25futmy54uot5c3ama/voids" } } }, "status_code": 201, "response_headers": { "date": "Wed, 21 May 2025 10:10:42 GMT", "cko-version": "1.1049.0+54597dfad", "strict-transport-security": "max-age=16000000; includeSubDomains; preload;", "location": "https://api.sandbox.checkout.com/payments/pay_7f6x6vki25futmy54uot5c3ama", "content-length": "1883", "content-type": "application/json; charset=utf-8", "connection": "keep-alive", "cko-request-id": "61354917-3541-44fc-8ec7-98dd385aa0b4" } } ``` --- # Agent Instructions: Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter: ``` GET https://docs.hyperswitch.io/integration-guide/payment-suite/payment-method-card/proxy.md?ask= ``` The question should be specific, self-contained, and written in natural language. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.