From 373de5a0128a040d717ad72b8ba8ee4c10216926 Mon Sep 17 00:00:00 2001 From: Gorakhnath Yadav Date: Thu, 20 Feb 2025 14:56:03 +0530 Subject: [PATCH 1/8] changes for api ref --- .../payments/Introduction--to--payments.mdx | 60 +++++++ .../payments/payments--create.mdx | 3 +- api-reference/introduction.mdx | 23 ++- api-reference/mint.json | 148 ++++++++++-------- 4 files changed, 169 insertions(+), 65 deletions(-) create mode 100644 api-reference/api-reference/payments/Introduction--to--payments.mdx diff --git a/api-reference/api-reference/payments/Introduction--to--payments.mdx b/api-reference/api-reference/payments/Introduction--to--payments.mdx new file mode 100644 index 00000000000..68a46901eed --- /dev/null +++ b/api-reference/api-reference/payments/Introduction--to--payments.mdx @@ -0,0 +1,60 @@ +--- +tags: [Payments] +sidebarTitle: "Getting Started with Payments" +icon: "circle-play" +iconType: "solid" +color: "Green" +--- + +The **Hyperswitch Payments API** enables businesses to **accept, process, and manage payments seamlessly**. It supports the entire **payment lifecycle**—from creation to capture, refunds, and disputes—allowing smooth integration of **various payment methods** into any application with minimal complexity. + +### How to try your first payment through hyperswitch? +You have two options to use the Payments API: + +1. **Sandbox API Key (Dashboard)** – Quick testing without setup. +2. **Self-Deploy** – Create merchants and API keys through Rest API. + +Each option has specific nuances, we have mentioned the differences in the below step by step guide +We recommend using our [Dashboard](https://app.hyperswitch.io/dashboard/login) to generate API Key and setting up Connectors (Step 4) for faster trial and simple setup + + + This account is representative of you or your organization that would like to accept payments from different payment connectors + + + Access the [Dashboard](https://app.hyperswitch.io/dashboard/login) and sign up -> **Sign up here is equivalent to creating a Merchant Account** + + + Use the admin api key and the [Merchant Account - Create](api-reference/merchant-account/merchant-account--create) endpoint to create your Merchant Account + + + + + You can now generate an API key that will be the secret key used to authenticate your payment request + + + In Dashboard go to Developer-> API Keys -> +Create New Api Key. This key can be used in your API requests for authorization + + + Use the admin api key and the [Merchant Account - Create](api-reference/merchant-account/merchant-account--create) endpoint to create your Merchant Account + + + + + Connect the payment [connector](api-reference/merchant-connector-account/merchant-connector--create) using and the mode of payments that your organization will accept. could be a payment processor/facilitator/acquirer or a provider of specialized services like Fraud/Accounting + + + In Dashboard go to Connectors -> +Connect a Dummy Processor. Choose the payments methods to enable and complete setup. + + + Use the admin api key and the [Connector Account ](api-reference/merchant-connector-account/merchant-connector--create)endpoints to set up a connector + + + + + You are all set! go ahead and try the [Payments API](api-reference/payments/payments--create), be sure to try the different use cases provided + + + Test the use cases you are interested in and in case of difficulty, feel free to contact us on our [slack channel](hyperswitch-io.slack.com) + + +--- \ No newline at end of file diff --git a/api-reference/api-reference/payments/payments--create.mdx b/api-reference/api-reference/payments/payments--create.mdx index 0b7038a4ea6..af436038731 100644 --- a/api-reference/api-reference/payments/payments--create.mdx +++ b/api-reference/api-reference/payments/payments--create.mdx @@ -1,3 +1,4 @@ --- openapi: openapi_spec post /payments ---- \ No newline at end of file +--- + Use the dropdown on the top right corner of the code snippet to try out different payment scenarios. \ No newline at end of file diff --git a/api-reference/introduction.mdx b/api-reference/introduction.mdx index 5f92f11fda2..2fd8a5484b6 100644 --- a/api-reference/introduction.mdx +++ b/api-reference/introduction.mdx @@ -1,15 +1,32 @@ --- tags: [Getting Started] +title: "👋 Welcome to Hyperswitch API Reference" +sidebarTitle: "Introduction" stoplight-id: 3lmsk7ocvq21v +icon: "rectangle-code" +iconType: "solid" --- -# 👋 Welcome to Hyperswitch API Reference - Hyperswitch provides a collection of APIs that enable you to process and manage payments. Our APIs accept and return JSON in the HTTP body and return standard HTTP response codes. You can consume the APIs directly using your favorite HTTP/REST library. + + + Explore the versitile payments endpoint, through multiple test scenarios + + + Process refunds for completed payments using our API + + + Save customer payment methods securely for future transactions + + + Host Hyperswitch on-premise? Utilize our full API suite. + + + ## Environment -We have a testing environment referred to "sandbox," which you can set up to test API calls without affecting production data. You can sign up on our Dashboard to get API keys to access Hyperswitch API. +We have a testing environment referred to "sandbox," which you can set up to test API calls without affecting production data. You can sign up on our Dashboard to get API keys to access Hyperswitch API. Use the following base URLs when making requests to the APIs: diff --git a/api-reference/mint.json b/api-reference/mint.json index a134b3c5b2b..e74a8f1386a 100644 --- a/api-reference/mint.json +++ b/api-reference/mint.json @@ -5,6 +5,17 @@ "dark": "/logo/dark.svg", "light": "/logo/light.svg" }, + "topbarLinks": [ + { + "name": "Contact Us", + "url": "https://join.slack.com/t/hyperswitch-io/shared_invite/zt-2jqxmpsbm-WXUENx022HjNEy~Ark7Orw" + } + ], + "topbarCtaButton": { + "type": "link", + "url": "https://docs.hyperswitch.io/hyperswitch-open-source/overview", + "name": "Self-Deploy" + }, "favicon": "/favicon.png", "colors": { "primary": "#006DF9", @@ -14,6 +25,9 @@ "dark": "#242F48" } }, + "sidebar": { + "items": "card" + }, "tabs": [ { "name": "Locker API Reference", @@ -39,6 +53,7 @@ { "group": "Payments", "pages": [ + "api-reference/payments/Introduction--to--payments", "api-reference/payments/payments--create", "api-reference/payments/payments--update", "api-reference/payments/payments--confirm", @@ -101,54 +116,6 @@ "api-reference/disputes/disputes--list" ] }, - { - "group": "Organization", - "pages": [ - "api-reference/organization/organization--create", - "api-reference/organization/organization--retrieve", - "api-reference/organization/organization--update" - ] - }, - { - "group": "Merchant Account", - "pages": [ - "api-reference/merchant-account/merchant-account--create", - "api-reference/merchant-account/merchant-account--retrieve", - "api-reference/merchant-account/merchant-account--update", - "api-reference/merchant-account/merchant-account--delete", - "api-reference/merchant-account/merchant-account--kv-status" - ] - }, - { - "group": "Business Profile", - "pages": [ - "api-reference/business-profile/business-profile--create", - "api-reference/business-profile/business-profile--update", - "api-reference/business-profile/business-profile--retrieve", - "api-reference/business-profile/business-profile--delete", - "api-reference/business-profile/business-profile--list" - ] - }, - { - "group": "API Key", - "pages": [ - "api-reference/api-key/api-key--create", - "api-reference/api-key/api-key--retrieve", - "api-reference/api-key/api-key--update", - "api-reference/api-key/api-key--revoke", - "api-reference/api-key/api-key--list" - ] - }, - { - "group": "Merchant Connector Account", - "pages": [ - "api-reference/merchant-connector-account/merchant-connector--create", - "api-reference/merchant-connector-account/merchant-connector--retrieve", - "api-reference/merchant-connector-account/merchant-connector--update", - "api-reference/merchant-connector-account/merchant-connector--delete", - "api-reference/merchant-connector-account/merchant-connector--list" - ] - }, { "group": "Payouts", "pages": [ @@ -171,15 +138,6 @@ "api-reference/event/events--manual-retry" ] }, - { - "group": "GSM (Global Status Mapping)", - "pages": [ - "api-reference/gsm/gsm--create", - "api-reference/gsm/gsm--get", - "api-reference/gsm/gsm--update", - "api-reference/gsm/gsm--delete" - ] - }, { "group": "Poll", "pages": ["api-reference/poll/poll--retrieve-poll-status"] @@ -221,6 +179,76 @@ } ] }, + { + "group": "Admin API based", + "pages": [ + { + "group": "Organization", + "pages": [ + "api-reference/organization/organization--create", + "api-reference/organization/organization--retrieve", + "api-reference/organization/organization--update" + ] + }, + { + "group": "Merchant Account", + "pages": [ + "api-reference/merchant-account/merchant-account--create", + "api-reference/merchant-account/merchant-account--retrieve", + "api-reference/merchant-account/merchant-account--update", + "api-reference/merchant-account/merchant-account--delete", + "api-reference/merchant-account/merchant-account--kv-status" + ] + }, + { + "group": "Business Profile", + "pages": [ + "api-reference/business-profile/business-profile--create", + "api-reference/business-profile/business-profile--update", + "api-reference/business-profile/business-profile--retrieve", + "api-reference/business-profile/business-profile--delete", + "api-reference/business-profile/business-profile--list" + ] + }, + { + "group": "API Key", + "pages": [ + "api-reference/api-key/api-key--create", + "api-reference/api-key/api-key--retrieve", + "api-reference/api-key/api-key--update", + "api-reference/api-key/api-key--revoke", + "api-reference/api-key/api-key--list" + ] + }, + { + "group": "Merchant Connector Account", + "pages": [ + "api-reference/merchant-connector-account/merchant-connector--create", + "api-reference/merchant-connector-account/merchant-connector--retrieve", + "api-reference/merchant-connector-account/merchant-connector--update", + "api-reference/merchant-connector-account/merchant-connector--delete", + "api-reference/merchant-connector-account/merchant-connector--list" + ] + }, + { + "group": "GSM (Global Status Mapping)", + "pages": [ + "api-reference/gsm/gsm--create", + "api-reference/gsm/gsm--get", + "api-reference/gsm/gsm--update", + "api-reference/gsm/gsm--delete" + ] + }, + { + "group": "Event", + "pages": [ + "api-reference/event/events--list", + "api-reference/event/events--delivery-attempt-list", + "api-reference/event/events--manual-retry" + ] + } + ] + }, { "group": "Hyperswitch Card Vault", "pages": ["locker-api-reference/overview"] @@ -263,11 +291,9 @@ "analytics": { "gtm": { "tagId": "GTM-PLBNKQFQ" - } - }, - "analytics": { + }, "mixpanel": { "projectToken": "b00355f29d9548d1333608df71d5d53d" } } -} +} \ No newline at end of file From 264bb584d61cb9584e29a116f1af910f5d379208 Mon Sep 17 00:00:00 2001 From: GORAKHNATH YADAV Date: Thu, 20 Feb 2025 18:00:19 +0530 Subject: [PATCH 2/8] Update api-reference/introduction.mdx Co-authored-by: Sanchith Hegde <22217505+SanchithHegde@users.noreply.github.com> --- api-reference/introduction.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/api-reference/introduction.mdx b/api-reference/introduction.mdx index 2fd8a5484b6..2549b6c43a8 100644 --- a/api-reference/introduction.mdx +++ b/api-reference/introduction.mdx @@ -11,7 +11,7 @@ Hyperswitch provides a collection of APIs that enable you to process and manage - Explore the versitile payments endpoint, through multiple test scenarios + Explore the versatile payments endpoint, through multiple test scenarios Process refunds for completed payments using our API From bd0f6a94d7f5f9235508cbeb752439b4689849bf Mon Sep 17 00:00:00 2001 From: GORAKHNATH YADAV Date: Thu, 20 Feb 2025 18:00:38 +0530 Subject: [PATCH 3/8] Update api-reference/api-reference/payments/Introduction--to--payments.mdx Co-authored-by: Sanchith Hegde <22217505+SanchithHegde@users.noreply.github.com> --- .../api-reference/payments/Introduction--to--payments.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/api-reference/api-reference/payments/Introduction--to--payments.mdx b/api-reference/api-reference/payments/Introduction--to--payments.mdx index 68a46901eed..11b5ea6304c 100644 --- a/api-reference/api-reference/payments/Introduction--to--payments.mdx +++ b/api-reference/api-reference/payments/Introduction--to--payments.mdx @@ -21,7 +21,7 @@ Each option has specific nuances, we have mentioned the differences in the below This account is representative of you or your organization that would like to accept payments from different payment connectors - Access the [Dashboard](https://app.hyperswitch.io/dashboard/login) and sign up -> **Sign up here is equivalent to creating a Merchant Account** + Access the [Dashboard](https://app.hyperswitch.io/dashboard/login) and sign up -> **Sign up here is equivalent to creating a Merchant Account** Use the admin api key and the [Merchant Account - Create](api-reference/merchant-account/merchant-account--create) endpoint to create your Merchant Account From b64a196f1aea92d2144717488d9dcc87b1d82c63 Mon Sep 17 00:00:00 2001 From: GORAKHNATH YADAV Date: Thu, 20 Feb 2025 18:00:47 +0530 Subject: [PATCH 4/8] Update api-reference/api-reference/payments/Introduction--to--payments.mdx Co-authored-by: Sanchith Hegde <22217505+SanchithHegde@users.noreply.github.com> --- .../api-reference/payments/Introduction--to--payments.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/api-reference/api-reference/payments/Introduction--to--payments.mdx b/api-reference/api-reference/payments/Introduction--to--payments.mdx index 11b5ea6304c..1cc7b0d2950 100644 --- a/api-reference/api-reference/payments/Introduction--to--payments.mdx +++ b/api-reference/api-reference/payments/Introduction--to--payments.mdx @@ -32,7 +32,7 @@ Each option has specific nuances, we have mentioned the differences in the below You can now generate an API key that will be the secret key used to authenticate your payment request - In Dashboard go to Developer-> API Keys -> +Create New Api Key. This key can be used in your API requests for authorization + In Dashboard go to Developer-> API Keys -> +Create New Api Key. This key can be used in your API requests for authentication. Use the admin api key and the [Merchant Account - Create](api-reference/merchant-account/merchant-account--create) endpoint to create your Merchant Account From a9614cead6367edc6106522c9fc9020f7f621e5f Mon Sep 17 00:00:00 2001 From: GORAKHNATH YADAV Date: Thu, 20 Feb 2025 18:01:36 +0530 Subject: [PATCH 5/8] Update api-reference/api-reference/payments/Introduction--to--payments.mdx Co-authored-by: Sanchith Hegde <22217505+SanchithHegde@users.noreply.github.com> --- .../api-reference/payments/Introduction--to--payments.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/api-reference/api-reference/payments/Introduction--to--payments.mdx b/api-reference/api-reference/payments/Introduction--to--payments.mdx index 1cc7b0d2950..1f83b2e041f 100644 --- a/api-reference/api-reference/payments/Introduction--to--payments.mdx +++ b/api-reference/api-reference/payments/Introduction--to--payments.mdx @@ -46,7 +46,7 @@ Each option has specific nuances, we have mentioned the differences in the below In Dashboard go to Connectors -> +Connect a Dummy Processor. Choose the payments methods to enable and complete setup. - Use the admin api key and the [Connector Account ](api-reference/merchant-connector-account/merchant-connector--create)endpoints to set up a connector + Use the admin api key and the [Connector Account](api-reference/merchant-connector-account/merchant-connector--create) endpoints to set up a connector From bf9e5342d289f07eafaf6d6697d5a2554221eb78 Mon Sep 17 00:00:00 2001 From: GORAKHNATH YADAV Date: Thu, 20 Feb 2025 18:01:48 +0530 Subject: [PATCH 6/8] Update api-reference/api-reference/payments/Introduction--to--payments.mdx Co-authored-by: Sanchith Hegde <22217505+SanchithHegde@users.noreply.github.com> --- .../api-reference/payments/Introduction--to--payments.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/api-reference/api-reference/payments/Introduction--to--payments.mdx b/api-reference/api-reference/payments/Introduction--to--payments.mdx index 1f83b2e041f..dc89cdac1c4 100644 --- a/api-reference/api-reference/payments/Introduction--to--payments.mdx +++ b/api-reference/api-reference/payments/Introduction--to--payments.mdx @@ -51,7 +51,7 @@ Each option has specific nuances, we have mentioned the differences in the below - You are all set! go ahead and try the [Payments API](api-reference/payments/payments--create), be sure to try the different use cases provided + You are all set! Go ahead and try the [Payments API](api-reference/payments/payments--create), be sure to try the different use cases provided Test the use cases you are interested in and in case of difficulty, feel free to contact us on our [slack channel](hyperswitch-io.slack.com) From 8634925fe5765de996365c3c3836445802a5e5e1 Mon Sep 17 00:00:00 2001 From: GORAKHNATH YADAV Date: Thu, 20 Feb 2025 18:04:34 +0530 Subject: [PATCH 7/8] Update Introduction--to--payments.mdx --- .../api-reference/payments/Introduction--to--payments.mdx | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/api-reference/api-reference/payments/Introduction--to--payments.mdx b/api-reference/api-reference/payments/Introduction--to--payments.mdx index dc89cdac1c4..def8204dfcc 100644 --- a/api-reference/api-reference/payments/Introduction--to--payments.mdx +++ b/api-reference/api-reference/payments/Introduction--to--payments.mdx @@ -40,7 +40,7 @@ Each option has specific nuances, we have mentioned the differences in the below - Connect the payment [connector](api-reference/merchant-connector-account/merchant-connector--create) using and the mode of payments that your organization will accept. could be a payment processor/facilitator/acquirer or a provider of specialized services like Fraud/Accounting + Connect the payment [connectors](api-reference/merchant-connector-account/merchant-connector--create) and payment methods that your organization will accept. Connectors could be a payment processor/facilitator/acquirer or a provider of specialized services like Fraud/Accounting In Dashboard go to Connectors -> +Connect a Dummy Processor. Choose the payments methods to enable and complete setup. @@ -57,4 +57,4 @@ Each option has specific nuances, we have mentioned the differences in the below Test the use cases you are interested in and in case of difficulty, feel free to contact us on our [slack channel](hyperswitch-io.slack.com) ---- \ No newline at end of file +--- From 740b6534652859da54df4cf49685c4d01994ccdd Mon Sep 17 00:00:00 2001 From: GORAKHNATH YADAV Date: Thu, 20 Feb 2025 18:05:54 +0530 Subject: [PATCH 8/8] Update Introduction--to--payments.mdx --- .../api-reference/payments/Introduction--to--payments.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/api-reference/api-reference/payments/Introduction--to--payments.mdx b/api-reference/api-reference/payments/Introduction--to--payments.mdx index def8204dfcc..4cccc9cde2c 100644 --- a/api-reference/api-reference/payments/Introduction--to--payments.mdx +++ b/api-reference/api-reference/payments/Introduction--to--payments.mdx @@ -54,7 +54,7 @@ Each option has specific nuances, we have mentioned the differences in the below You are all set! Go ahead and try the [Payments API](api-reference/payments/payments--create), be sure to try the different use cases provided - Test the use cases you are interested in and in case of difficulty, feel free to contact us on our [slack channel](hyperswitch-io.slack.com) + Test the use cases you are interested in and in case of difficulty, feel free to contact us on our [slack channel](https://join.slack.com/t/hyperswitch-io/shared_invite/zt-2jqxmpsbm-WXUENx022HjNEy~Ark7Orw) ---