> For the complete documentation index, see [llms.txt](https://docs.hyperswitch.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.hyperswitch.io/self-hosting/want-to-explore/account-setup/using-postman.md). # Using postman Create your Hyperswitch account and add a payment provider using Hyperswitch APIs through postman ### Create a Hyperswitch account ​Hyperswitch operates on a multi-tenant architecture, enabling a single application server to support multiple merchants. To create a new merchant account, follow these steps:​ 1. **Locate the Admin API Key**: * Find the `config/docker_compose.toml` file in your Hyperswitch setup.​ * Search for the `api_key` entry within this file to retrieve your admin API key.​ 2. **Execute the cURL Command**: * Use the following cURL command to create a merchant account:​ * Replace `` with your actual admin API key.
Merchant Account - Create ```json curl --location 'http://localhost:8080/accounts' \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \ --header 'api-key: ' \ --data-raw '{ "merchant_id": "Test_merchant", "locker_id": "m0010", "merchant_name": "NewAge Retailer", "merchant_details": { "primary_contact_person": "John Test", "primary_email": "JohnTest@test.com", "primary_phone": "sunt laborum", "secondary_contact_person": "John Test2", "secondary_email": "JohnTest2@test.com", "secondary_phone": "cillum do dolor id", "website": "www.example.com", "about_business": "Online Retail with a wide selection of organic products for North America", "address": { "line1": "1467", "line2": "Harrison Street", "line3": "Harrison Street", "city": "San Fransico", "state": "California", "zip": "94122", "country": "US" } }, "return_url": "https://google.com", "sub_merchants_enabled": false }' ```
3. **Receive the Response**: * Upon executing the command, you should receive a response containing the `merchant_id` and `publishable_key`.​ ### Create an API key To generate an API key for your merchant account in Hyperswitch, follow these steps:​ 1. **Prepare the cURL Command**: * Replace `` with the `merchant_id` obtained from the previous step.​ * Replace `` with your admin API key.​
API Key - Create ```json curl --location 'http://localhost:8080/api_keys/' \ --header 'Content-Type: application/json' \ --header 'Accept: application/json' \ --header 'api-key: ' \ --data '{ "name": "API Key 1", "description": null, "expiration": "2023-09-23T01:02:03.000Z" }' ```
2. **Secure the API Key**: * The response will include the plaintext API key. Store this key securely, as it is essential for authenticating API requests from your merchant server.​ ### Set up a payment processor ​To integrate your preferred payment processor with Hyperswitch, follow these steps:​ **1. Obtain API Credentials from Your Payment Processor:** * Sign up with your chosen payment processor (e.g., Stripe, Adyen) and acquire the necessary API credentials.​ 2. **Set Up the Payment Processor in Hyperswitch:** * Use the following cURL command to configure the payment processor * Replace `` with your merchant ID obtained earlier. * Replace `` with your admin API key. * Replace `` with the name of your payment processor (e.g., "stripe"). * Replace `` with the API key provided by your payment processor.
Payment Connector - Create ```json curl --location 'http://localhost:8080/account//connectors' \ --header 'Content-Type: application/json' \ --header 'Accept: application/json' \ --header 'api-key: ' \ --data '{ "connector_type": "fiz_operations", "connector_name": "stripe", "connector_account_details": { "auth_type": "HeaderKey", "api_key": "" }, "test_mode": false, "disabled": false, "payment_methods_enabled": [ { "payment_method": "card", "payment_method_types": [ { "payment_method_type": "credit", "card_networks": [ "Visa", "Mastercard" ], "minimum_amount": 1, "maximum_amount": 68607706, "recurring_enabled": true, "installment_payment_enabled": true }, { "payment_method_type": "debit", "card_networks": [ "Visa", "Mastercard" ], "minimum_amount": 1, "maximum_amount": 68607706, "recurring_enabled": true, "installment_payment_enabled": true } ] }, { "payment_method": "pay_later", "payment_method_types": [ { "payment_method_type": "klarna", "payment_experience": "redirect_to_url", "minimum_amount": 1, "maximum_amount": 68607706, "recurring_enabled": true, "installment_payment_enabled": true }, { "payment_method_type": "affirm", "payment_experience": "redirect_to_url", "minimum_amount": 1, "maximum_amount": 68607706, "recurring_enabled": true, "installment_payment_enabled": true } } }' ```
**3. Customize Connector Account Details:** * The `connector_account_details` field requires specific authentication details for your chosen payment processor. For payment processors, the required fields may vary. **4. Enable Payment Methods:** * In the `payment_methods_enabled` section, specify the payment methods and types you wish to enable. For example, to enable credit card payments via Visa and Mastercard, include them as shown in the cURL command above. ### **Resources** * To explore more of our APIs, please check the remaining folders in the [Postman collection](https://www.postman.com/hyperswitch/workspace/hyperswitch-development/collection/25176162-630b5353-7002-44d1-8ba1-ead6c230f2e3) ### Next step {% content-ref url="/pages/l28HCGRBvHUVXZcSIrCF" %} [Test a payment](/self-hosting/want-to-explore/account-setup/test-a-payment.md) {% endcontent-ref %} --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation by asking a question. Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters: ``` GET https://docs.hyperswitch.io/self-hosting/want-to-explore/account-setup/using-postman.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case. 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.