mirror of
https://github.com/juspay/hyperswitch.git
synced 2025-11-01 02:57:02 +08:00
docs: fix quick start guide and update dashboard link (#454)
This commit is contained in:
Narayan Bhat
@ -45,7 +45,7 @@ to integrate._
|
|||||||
|
|
||||||
## Quick Start Guide
|
## Quick Start Guide
|
||||||
|
|
||||||
You have two options to try out HyperSwitch:
|
You have three options to try out HyperSwitch:
|
||||||
|
|
||||||
1. [Try it in our Sandbox Environment](/docs/try_sandbox.md): Fast and easy to
|
1. [Try it in our Sandbox Environment](/docs/try_sandbox.md): Fast and easy to
|
||||||
start.
|
start.
|
||||||
@ -55,6 +55,7 @@ You have two options to try out HyperSwitch:
|
|||||||
<a href="https://github.com/aashu331998/hyperswitch-react-demo-app/archive/refs/heads/main.zip">
|
<a href="https://github.com/aashu331998/hyperswitch-react-demo-app/archive/refs/heads/main.zip">
|
||||||
<img src= "./docs/imgs/download-button.png" alt="Download Now" width="190rem" />
|
<img src= "./docs/imgs/download-button.png" alt="Download Now" width="190rem" />
|
||||||
</a>
|
</a>
|
||||||
|
|
||||||
3. [Install in your local system](/docs/try_local_system.md): Configurations and
|
3. [Install in your local system](/docs/try_local_system.md): Configurations and
|
||||||
setup required in your system.
|
setup required in your system.
|
||||||
Suitable if you like to customize the core offering.
|
Suitable if you like to customize the core offering.
|
||||||
@ -69,7 +70,7 @@ Try the steps below to get a feel for how quick the setup is:
|
|||||||
2. Follow the instructions detailed on our
|
2. Follow the instructions detailed on our
|
||||||
[documentation page][migrate-from-stripe].
|
[documentation page][migrate-from-stripe].
|
||||||
|
|
||||||
[dashboard]: https://dashboard-hyperswitch.netlify.app
|
[dashboard]: https://app.hyperswitch.io
|
||||||
[migrate-from-stripe]: https://hyperswitch.io/docs/migrateFromStripe
|
[migrate-from-stripe]: https://hyperswitch.io/docs/migrateFromStripe
|
||||||
|
|
||||||
## Supported Features
|
## Supported Features
|
||||||
|
|||||||
@ -30,7 +30,7 @@ Use the following base URLs when making requests to the APIs:
|
|||||||
|
|
||||||
## Authentication
|
## Authentication
|
||||||
|
|
||||||
When you sign up on our [dashboard](https://dashboard-hyperswitch.netlify.app) and create a merchant
|
When you sign up on our [dashboard](https://app.hyperswitch.io) and create a merchant
|
||||||
account, you are given a secret key (also referred as api-key).
|
account, you are given a secret key (also referred as api-key).
|
||||||
You may authenticate all API requests with Juspay server by providing the appropriate key in the
|
You may authenticate all API requests with Juspay server by providing the appropriate key in the
|
||||||
request Authorization header.
|
request Authorization header.
|
||||||
|
|||||||
@ -67,7 +67,7 @@ Hope you got a hang of our APIs.
|
|||||||
To explore more of our APIs, please check the remaining folders in the
|
To explore more of our APIs, please check the remaining folders in the
|
||||||
[Postman collection][postman-collection].
|
[Postman collection][postman-collection].
|
||||||
|
|
||||||
[dashboard]: https://dashboard-hyperswitch.netlify.app
|
[dashboard]: https://app.hyperswitch.io
|
||||||
[postman]: https://www.postman.com
|
[postman]: https://www.postman.com
|
||||||
[postman-collection]: https://www.postman.com/hyperswitch/workspace/hyperswitch/collection/25176183-e36f8e3d-078c-4067-a273-f456b6b724ed
|
[postman-collection]: https://www.postman.com/hyperswitch/workspace/hyperswitch/collection/25176183-e36f8e3d-078c-4067-a273-f456b6b724ed
|
||||||
[variables]: https://www.postman.com/hyperswitch/workspace/hyperswitch/collection/25176183-e36f8e3d-078c-4067-a273-f456b6b724ed?tab=variables
|
[variables]: https://www.postman.com/hyperswitch/workspace/hyperswitch/collection/25176183-e36f8e3d-078c-4067-a273-f456b6b724ed?tab=variables
|
||||||
|
|||||||
@ -2,7 +2,7 @@
|
|||||||
"openapi": "3.0.3",
|
"openapi": "3.0.3",
|
||||||
"info": {
|
"info": {
|
||||||
"title": "Juspay Router - API Documentation",
|
"title": "Juspay Router - API Documentation",
|
||||||
"description": "\n## Get started\n\nJuspay Router provides a collection of APIs that enable you to process and manage payments.\nOur APIs accept and return JSON in the HTTP body, and return standard HTTP response codes.\n\nYou can consume the APIs directly using your favorite HTTP/REST library.\n\nWe have a testing environment referred to \"sandbox\", which you can setup to test API calls without\naffecting production data.\n\n### Base URLs\n\nUse the following base URLs when making requests to the APIs:\n\n| Environment | Base URL |\n|---------------|------------------------------------------------------|\n| Sandbox | <https://sandbox.hyperswitch.io> |\n| Production | <https://router.juspay.io> |\n\n## Authentication\n\nWhen you sign up on our [dashboard](https://dashboard-hyperswitch.netlify.app) and create a merchant\naccount, you are given a secret key (also referred as api-key).\nYou may authenticate all API requests with Juspay server by providing the appropriate key in the\nrequest Authorization header.\n\nNever share your secret api keys. Keep them guarded and secure.\n",
|
"description": "\n## Get started\n\nJuspay Router provides a collection of APIs that enable you to process and manage payments.\nOur APIs accept and return JSON in the HTTP body, and return standard HTTP response codes.\n\nYou can consume the APIs directly using your favorite HTTP/REST library.\n\nWe have a testing environment referred to \"sandbox\", which you can setup to test API calls without\naffecting production data.\n\n### Base URLs\n\nUse the following base URLs when making requests to the APIs:\n\n| Environment | Base URL |\n|---------------|------------------------------------------------------|\n| Sandbox | <https://sandbox.hyperswitch.io> |\n| Production | <https://router.juspay.io> |\n\n## Authentication\n\nWhen you sign up on our [dashboard](https://app.hyperswitch.io) and create a merchant\naccount, you are given a secret key (also referred as api-key).\nYou may authenticate all API requests with Juspay server by providing the appropriate key in the\nrequest Authorization header.\n\nNever share your secret api keys. Keep them guarded and secure.\n",
|
||||||
"contact": {
|
"contact": {
|
||||||
"name": "Juspay Support",
|
"name": "Juspay Support",
|
||||||
"url": "https://juspay.io",
|
"url": "https://juspay.io",
|
||||||
@ -26,9 +26,7 @@
|
|||||||
"paths": {
|
"paths": {
|
||||||
"/account": {
|
"/account": {
|
||||||
"post": {
|
"post": {
|
||||||
"tags": [
|
"tags": ["crate::routes::admin"],
|
||||||
"crate::routes::admin"
|
|
||||||
],
|
|
||||||
"summary": "Merchant Account - Create",
|
"summary": "Merchant Account - Create",
|
||||||
"description": "Merchant Account - Create\n\nCreate a new account for a merchant and the merchant could be a seller or retailer or client who likes to receive and send payments.",
|
"description": "Merchant Account - Create\n\nCreate a new account for a merchant and the merchant could be a seller or retailer or client who likes to receive and send payments.",
|
||||||
"operationId": "merchant_account_create",
|
"operationId": "merchant_account_create",
|
||||||
@ -62,9 +60,7 @@
|
|||||||
},
|
},
|
||||||
"/payments": {
|
"/payments": {
|
||||||
"post": {
|
"post": {
|
||||||
"tags": [
|
"tags": ["crate::routes::payments"],
|
||||||
"crate::routes::payments"
|
|
||||||
],
|
|
||||||
"summary": "Payments - Create",
|
"summary": "Payments - Create",
|
||||||
"description": "Payments - Create\n\nTo create a new payment, against a merchant API key",
|
"description": "Payments - Create\n\nTo create a new payment, against a merchant API key",
|
||||||
"operationId": "payments_create",
|
"operationId": "payments_create",
|
||||||
@ -98,9 +94,7 @@
|
|||||||
},
|
},
|
||||||
"/refunds": {
|
"/refunds": {
|
||||||
"post": {
|
"post": {
|
||||||
"tags": [
|
"tags": ["crate::routes::refunds"],
|
||||||
"crate::routes::refunds"
|
|
||||||
],
|
|
||||||
"summary": "Refunds - Create",
|
"summary": "Refunds - Create",
|
||||||
"description": "Refunds - Create\n\nTo create a refund against an already processed payment",
|
"description": "Refunds - Create\n\nTo create a refund against an already processed payment",
|
||||||
"operationId": "refunds_create",
|
"operationId": "refunds_create",
|
||||||
@ -137,10 +131,7 @@
|
|||||||
"schemas": {
|
"schemas": {
|
||||||
"AcceptanceType": {
|
"AcceptanceType": {
|
||||||
"type": "string",
|
"type": "string",
|
||||||
"enum": [
|
"enum": ["online", "offline"]
|
||||||
"online",
|
|
||||||
"offline"
|
|
||||||
]
|
|
||||||
},
|
},
|
||||||
"Address": {
|
"Address": {
|
||||||
"type": "object",
|
"type": "object",
|
||||||
@ -214,10 +205,7 @@
|
|||||||
},
|
},
|
||||||
"AuthenticationType": {
|
"AuthenticationType": {
|
||||||
"type": "string",
|
"type": "string",
|
||||||
"enum": [
|
"enum": ["three_ds", "no_three_ds"]
|
||||||
"three_ds",
|
|
||||||
"no_three_ds"
|
|
||||||
]
|
|
||||||
},
|
},
|
||||||
"CCard": {
|
"CCard": {
|
||||||
"type": "object",
|
"type": "object",
|
||||||
@ -258,12 +246,7 @@
|
|||||||
},
|
},
|
||||||
"CaptureMethod": {
|
"CaptureMethod": {
|
||||||
"type": "string",
|
"type": "string",
|
||||||
"enum": [
|
"enum": ["automatic", "manual", "manual_multiple", "scheduled"]
|
||||||
"automatic",
|
|
||||||
"manual",
|
|
||||||
"manual_multiple",
|
|
||||||
"scheduled"
|
|
||||||
]
|
|
||||||
},
|
},
|
||||||
"Connector": {
|
"Connector": {
|
||||||
"type": "string",
|
"type": "string",
|
||||||
@ -301,9 +284,7 @@
|
|||||||
},
|
},
|
||||||
"CreateMerchantAccount": {
|
"CreateMerchantAccount": {
|
||||||
"type": "object",
|
"type": "object",
|
||||||
"required": [
|
"required": ["merchant_id"],
|
||||||
"merchant_id"
|
|
||||||
],
|
|
||||||
"properties": {
|
"properties": {
|
||||||
"merchant_id": {
|
"merchant_id": {
|
||||||
"type": "string",
|
"type": "string",
|
||||||
@ -489,9 +470,7 @@
|
|||||||
},
|
},
|
||||||
"CustomerAcceptance": {
|
"CustomerAcceptance": {
|
||||||
"type": "object",
|
"type": "object",
|
||||||
"required": [
|
"required": ["acceptance_type"],
|
||||||
"acceptance_type"
|
|
||||||
],
|
|
||||||
"properties": {
|
"properties": {
|
||||||
"acceptance_type": {
|
"acceptance_type": {
|
||||||
"$ref": "#/components/schemas/AcceptanceType"
|
"$ref": "#/components/schemas/AcceptanceType"
|
||||||
@ -589,10 +568,7 @@
|
|||||||
},
|
},
|
||||||
"CustomerResponse": {
|
"CustomerResponse": {
|
||||||
"type": "object",
|
"type": "object",
|
||||||
"required": [
|
"required": ["customer_id", "created_at"],
|
||||||
"customer_id",
|
|
||||||
"created_at"
|
|
||||||
],
|
|
||||||
"properties": {
|
"properties": {
|
||||||
"customer_id": {
|
"customer_id": {
|
||||||
"type": "string",
|
"type": "string",
|
||||||
@ -646,11 +622,7 @@
|
|||||||
},
|
},
|
||||||
"DeleteMcaResponse": {
|
"DeleteMcaResponse": {
|
||||||
"type": "object",
|
"type": "object",
|
||||||
"required": [
|
"required": ["merchant_id", "merchant_connector_id", "deleted"],
|
||||||
"merchant_id",
|
|
||||||
"merchant_connector_id",
|
|
||||||
"deleted"
|
|
||||||
],
|
|
||||||
"properties": {
|
"properties": {
|
||||||
"merchant_id": {
|
"merchant_id": {
|
||||||
"type": "string",
|
"type": "string",
|
||||||
@ -673,10 +645,7 @@
|
|||||||
},
|
},
|
||||||
"DeleteResponse": {
|
"DeleteResponse": {
|
||||||
"type": "object",
|
"type": "object",
|
||||||
"required": [
|
"required": ["merchant_id", "deleted"],
|
||||||
"merchant_id",
|
|
||||||
"deleted"
|
|
||||||
],
|
|
||||||
"properties": {
|
"properties": {
|
||||||
"merchant_id": {
|
"merchant_id": {
|
||||||
"type": "string",
|
"type": "string",
|
||||||
@ -693,17 +662,11 @@
|
|||||||
},
|
},
|
||||||
"FutureUsage": {
|
"FutureUsage": {
|
||||||
"type": "string",
|
"type": "string",
|
||||||
"enum": [
|
"enum": ["off_session", "on_session"]
|
||||||
"off_session",
|
|
||||||
"on_session"
|
|
||||||
]
|
|
||||||
},
|
},
|
||||||
"GpayAllowedMethodsParameters": {
|
"GpayAllowedMethodsParameters": {
|
||||||
"type": "object",
|
"type": "object",
|
||||||
"required": [
|
"required": ["allowed_auth_methods", "allowed_card_networks"],
|
||||||
"allowed_auth_methods",
|
|
||||||
"allowed_card_networks"
|
|
||||||
],
|
|
||||||
"properties": {
|
"properties": {
|
||||||
"allowed_auth_methods": {
|
"allowed_auth_methods": {
|
||||||
"type": "array",
|
"type": "array",
|
||||||
@ -723,11 +686,7 @@
|
|||||||
},
|
},
|
||||||
"GpayAllowedPaymentMethods": {
|
"GpayAllowedPaymentMethods": {
|
||||||
"type": "object",
|
"type": "object",
|
||||||
"required": [
|
"required": ["type", "parameters", "tokenization_specification"],
|
||||||
"type",
|
|
||||||
"parameters",
|
|
||||||
"tokenization_specification"
|
|
||||||
],
|
|
||||||
"properties": {
|
"properties": {
|
||||||
"type": {
|
"type": {
|
||||||
"type": "string",
|
"type": "string",
|
||||||
@ -743,9 +702,7 @@
|
|||||||
},
|
},
|
||||||
"GpayMerchantInfo": {
|
"GpayMerchantInfo": {
|
||||||
"type": "object",
|
"type": "object",
|
||||||
"required": [
|
"required": ["merchant_name"],
|
||||||
"merchant_name"
|
|
||||||
],
|
|
||||||
"properties": {
|
"properties": {
|
||||||
"merchant_name": {
|
"merchant_name": {
|
||||||
"type": "string",
|
"type": "string",
|
||||||
@ -755,10 +712,7 @@
|
|||||||
},
|
},
|
||||||
"GpayTokenParameters": {
|
"GpayTokenParameters": {
|
||||||
"type": "object",
|
"type": "object",
|
||||||
"required": [
|
"required": ["gateway", "gateway_merchant_id"],
|
||||||
"gateway",
|
|
||||||
"gateway_merchant_id"
|
|
||||||
],
|
|
||||||
"properties": {
|
"properties": {
|
||||||
"gateway": {
|
"gateway": {
|
||||||
"type": "string",
|
"type": "string",
|
||||||
@ -772,10 +726,7 @@
|
|||||||
},
|
},
|
||||||
"GpayTokenizationSpecification": {
|
"GpayTokenizationSpecification": {
|
||||||
"type": "object",
|
"type": "object",
|
||||||
"required": [
|
"required": ["type", "parameters"],
|
||||||
"type",
|
|
||||||
"parameters"
|
|
||||||
],
|
|
||||||
"properties": {
|
"properties": {
|
||||||
"type": {
|
"type": {
|
||||||
"type": "string",
|
"type": "string",
|
||||||
@ -829,22 +780,15 @@
|
|||||||
},
|
},
|
||||||
"KlarnaRedirectIssuer": {
|
"KlarnaRedirectIssuer": {
|
||||||
"type": "string",
|
"type": "string",
|
||||||
"enum": [
|
"enum": ["stripe"]
|
||||||
"stripe"
|
|
||||||
]
|
|
||||||
},
|
},
|
||||||
"KlarnaSdkIssuer": {
|
"KlarnaSdkIssuer": {
|
||||||
"type": "string",
|
"type": "string",
|
||||||
"enum": [
|
"enum": ["klarna"]
|
||||||
"klarna"
|
|
||||||
]
|
|
||||||
},
|
},
|
||||||
"MandateAmountData": {
|
"MandateAmountData": {
|
||||||
"type": "object",
|
"type": "object",
|
||||||
"required": [
|
"required": ["amount", "currency"],
|
||||||
"amount",
|
|
||||||
"currency"
|
|
||||||
],
|
|
||||||
"properties": {
|
"properties": {
|
||||||
"amount": {
|
"amount": {
|
||||||
"type": "integer",
|
"type": "integer",
|
||||||
@ -859,10 +803,7 @@
|
|||||||
},
|
},
|
||||||
"MandateData": {
|
"MandateData": {
|
||||||
"type": "object",
|
"type": "object",
|
||||||
"required": [
|
"required": ["customer_acceptance", "mandate_type"],
|
||||||
"customer_acceptance",
|
|
||||||
"mandate_type"
|
|
||||||
],
|
|
||||||
"properties": {
|
"properties": {
|
||||||
"customer_acceptance": {
|
"customer_acceptance": {
|
||||||
"$ref": "#/components/schemas/CustomerAcceptance"
|
"$ref": "#/components/schemas/CustomerAcceptance"
|
||||||
@ -876,9 +817,7 @@
|
|||||||
"oneOf": [
|
"oneOf": [
|
||||||
{
|
{
|
||||||
"type": "object",
|
"type": "object",
|
||||||
"required": [
|
"required": ["single_use"],
|
||||||
"single_use"
|
|
||||||
],
|
|
||||||
"properties": {
|
"properties": {
|
||||||
"single_use": {
|
"single_use": {
|
||||||
"$ref": "#/components/schemas/MandateAmountData"
|
"$ref": "#/components/schemas/MandateAmountData"
|
||||||
@ -887,9 +826,7 @@
|
|||||||
},
|
},
|
||||||
{
|
{
|
||||||
"type": "object",
|
"type": "object",
|
||||||
"required": [
|
"required": ["multi_use"],
|
||||||
"multi_use"
|
|
||||||
],
|
|
||||||
"properties": {
|
"properties": {
|
||||||
"multi_use": {
|
"multi_use": {
|
||||||
"$ref": "#/components/schemas/MandateAmountData"
|
"$ref": "#/components/schemas/MandateAmountData"
|
||||||
@ -984,10 +921,7 @@
|
|||||||
},
|
},
|
||||||
"MerchantConnectorId": {
|
"MerchantConnectorId": {
|
||||||
"type": "object",
|
"type": "object",
|
||||||
"required": [
|
"required": ["merchant_id", "merchant_connector_id"],
|
||||||
"merchant_id",
|
|
||||||
"merchant_connector_id"
|
|
||||||
],
|
|
||||||
"properties": {
|
"properties": {
|
||||||
"merchant_id": {
|
"merchant_id": {
|
||||||
"type": "string"
|
"type": "string"
|
||||||
@ -1071,9 +1005,7 @@
|
|||||||
},
|
},
|
||||||
"NextAction": {
|
"NextAction": {
|
||||||
"type": "object",
|
"type": "object",
|
||||||
"required": [
|
"required": ["type"],
|
||||||
"type"
|
|
||||||
],
|
|
||||||
"properties": {
|
"properties": {
|
||||||
"type": {
|
"type": {
|
||||||
"$ref": "#/components/schemas/NextActionType"
|
"$ref": "#/components/schemas/NextActionType"
|
||||||
@ -1096,10 +1028,7 @@
|
|||||||
},
|
},
|
||||||
"OnlineMandate": {
|
"OnlineMandate": {
|
||||||
"type": "object",
|
"type": "object",
|
||||||
"required": [
|
"required": ["ip_address", "user_agent"],
|
||||||
"ip_address",
|
|
||||||
"user_agent"
|
|
||||||
],
|
|
||||||
"properties": {
|
"properties": {
|
||||||
"ip_address": {
|
"ip_address": {
|
||||||
"type": "string",
|
"type": "string",
|
||||||
@ -1114,10 +1043,7 @@
|
|||||||
},
|
},
|
||||||
"OrderDetails": {
|
"OrderDetails": {
|
||||||
"type": "object",
|
"type": "object",
|
||||||
"required": [
|
"required": ["product_name", "quantity"],
|
||||||
"product_name",
|
|
||||||
"quantity"
|
|
||||||
],
|
|
||||||
"properties": {
|
"properties": {
|
||||||
"product_name": {
|
"product_name": {
|
||||||
"type": "string",
|
"type": "string",
|
||||||
@ -1137,18 +1063,12 @@
|
|||||||
"oneOf": [
|
"oneOf": [
|
||||||
{
|
{
|
||||||
"type": "object",
|
"type": "object",
|
||||||
"required": [
|
"required": ["klarna_redirect"],
|
||||||
"klarna_redirect"
|
|
||||||
],
|
|
||||||
"properties": {
|
"properties": {
|
||||||
"klarna_redirect": {
|
"klarna_redirect": {
|
||||||
"type": "object",
|
"type": "object",
|
||||||
"description": "For KlarnaRedirect as PayLater Option",
|
"description": "For KlarnaRedirect as PayLater Option",
|
||||||
"required": [
|
"required": ["issuer_name", "billing_email", "billing_country"],
|
||||||
"issuer_name",
|
|
||||||
"billing_email",
|
|
||||||
"billing_country"
|
|
||||||
],
|
|
||||||
"properties": {
|
"properties": {
|
||||||
"issuer_name": {
|
"issuer_name": {
|
||||||
"$ref": "#/components/schemas/KlarnaRedirectIssuer"
|
"$ref": "#/components/schemas/KlarnaRedirectIssuer"
|
||||||
@ -1166,17 +1086,12 @@
|
|||||||
},
|
},
|
||||||
{
|
{
|
||||||
"type": "object",
|
"type": "object",
|
||||||
"required": [
|
"required": ["klarna_sdk"],
|
||||||
"klarna_sdk"
|
|
||||||
],
|
|
||||||
"properties": {
|
"properties": {
|
||||||
"klarna_sdk": {
|
"klarna_sdk": {
|
||||||
"type": "object",
|
"type": "object",
|
||||||
"description": "For Klarna Sdk as PayLater Option",
|
"description": "For Klarna Sdk as PayLater Option",
|
||||||
"required": [
|
"required": ["issuer_name", "token"],
|
||||||
"issuer_name",
|
|
||||||
"token"
|
|
||||||
],
|
|
||||||
"properties": {
|
"properties": {
|
||||||
"issuer_name": {
|
"issuer_name": {
|
||||||
"$ref": "#/components/schemas/KlarnaSdkIssuer"
|
"$ref": "#/components/schemas/KlarnaSdkIssuer"
|
||||||
@ -1191,16 +1106,12 @@
|
|||||||
},
|
},
|
||||||
{
|
{
|
||||||
"type": "object",
|
"type": "object",
|
||||||
"required": [
|
"required": ["affirm_redirect"],
|
||||||
"affirm_redirect"
|
|
||||||
],
|
|
||||||
"properties": {
|
"properties": {
|
||||||
"affirm_redirect": {
|
"affirm_redirect": {
|
||||||
"type": "object",
|
"type": "object",
|
||||||
"description": "For Affirm redirect flow",
|
"description": "For Affirm redirect flow",
|
||||||
"required": [
|
"required": ["billing_email"],
|
||||||
"billing_email"
|
|
||||||
],
|
|
||||||
"properties": {
|
"properties": {
|
||||||
"billing_email": {
|
"billing_email": {
|
||||||
"type": "string",
|
"type": "string",
|
||||||
@ -1215,10 +1126,7 @@
|
|||||||
"PaymentConnectorCreate": {
|
"PaymentConnectorCreate": {
|
||||||
"type": "object",
|
"type": "object",
|
||||||
"description": "Create a new Payment Connector for the merchant account. The connector could be a payment processor / facilitator / acquirer or specialized services like Fraud / Accounting etc.\"",
|
"description": "Create a new Payment Connector for the merchant account. The connector could be a payment processor / facilitator / acquirer or specialized services like Fraud / Accounting etc.\"",
|
||||||
"required": [
|
"required": ["connector_type", "connector_name"],
|
||||||
"connector_type",
|
|
||||||
"connector_name"
|
|
||||||
],
|
|
||||||
"properties": {
|
"properties": {
|
||||||
"connector_type": {
|
"connector_type": {
|
||||||
"$ref": "#/components/schemas/ConnectorType"
|
"$ref": "#/components/schemas/ConnectorType"
|
||||||
@ -1257,26 +1165,11 @@
|
|||||||
"example": [
|
"example": [
|
||||||
{
|
{
|
||||||
"payment_method": "wallet",
|
"payment_method": "wallet",
|
||||||
"payment_method_types": [
|
"payment_method_types": ["upi_collect", "upi_intent"],
|
||||||
"upi_collect",
|
"payment_method_issuers": ["labore magna ipsum", "aute"],
|
||||||
"upi_intent"
|
"payment_schemes": ["Discover", "Discover"],
|
||||||
],
|
"accepted_currencies": ["AED", "AED"],
|
||||||
"payment_method_issuers": [
|
"accepted_countries": ["in", "us"],
|
||||||
"labore magna ipsum",
|
|
||||||
"aute"
|
|
||||||
],
|
|
||||||
"payment_schemes": [
|
|
||||||
"Discover",
|
|
||||||
"Discover"
|
|
||||||
],
|
|
||||||
"accepted_currencies": [
|
|
||||||
"AED",
|
|
||||||
"AED"
|
|
||||||
],
|
|
||||||
"accepted_countries": [
|
|
||||||
"in",
|
|
||||||
"us"
|
|
||||||
],
|
|
||||||
"minimum_amount": 1,
|
"minimum_amount": 1,
|
||||||
"maximum_amount": 68607706,
|
"maximum_amount": 68607706,
|
||||||
"recurring_enabled": true,
|
"recurring_enabled": true,
|
||||||
@ -1304,9 +1197,7 @@
|
|||||||
"oneOf": [
|
"oneOf": [
|
||||||
{
|
{
|
||||||
"type": "object",
|
"type": "object",
|
||||||
"required": [
|
"required": ["PaymentIntentId"],
|
||||||
"PaymentIntentId"
|
|
||||||
],
|
|
||||||
"properties": {
|
"properties": {
|
||||||
"PaymentIntentId": {
|
"PaymentIntentId": {
|
||||||
"type": "string",
|
"type": "string",
|
||||||
@ -1316,9 +1207,7 @@
|
|||||||
},
|
},
|
||||||
{
|
{
|
||||||
"type": "object",
|
"type": "object",
|
||||||
"required": [
|
"required": ["ConnectorTransactionId"],
|
||||||
"ConnectorTransactionId"
|
|
||||||
],
|
|
||||||
"properties": {
|
"properties": {
|
||||||
"ConnectorTransactionId": {
|
"ConnectorTransactionId": {
|
||||||
"type": "string",
|
"type": "string",
|
||||||
@ -1328,9 +1217,7 @@
|
|||||||
},
|
},
|
||||||
{
|
{
|
||||||
"type": "object",
|
"type": "object",
|
||||||
"required": [
|
"required": ["PaymentAttemptId"],
|
||||||
"PaymentAttemptId"
|
|
||||||
],
|
|
||||||
"properties": {
|
"properties": {
|
||||||
"PaymentAttemptId": {
|
"PaymentAttemptId": {
|
||||||
"type": "string",
|
"type": "string",
|
||||||
@ -1389,10 +1276,7 @@
|
|||||||
},
|
},
|
||||||
"PaymentListResponse": {
|
"PaymentListResponse": {
|
||||||
"type": "object",
|
"type": "object",
|
||||||
"required": [
|
"required": ["size", "data"],
|
||||||
"size",
|
|
||||||
"data"
|
|
||||||
],
|
|
||||||
"properties": {
|
"properties": {
|
||||||
"size": {
|
"size": {
|
||||||
"type": "integer",
|
"type": "integer",
|
||||||
@ -1410,9 +1294,7 @@
|
|||||||
"oneOf": [
|
"oneOf": [
|
||||||
{
|
{
|
||||||
"type": "object",
|
"type": "object",
|
||||||
"required": [
|
"required": ["Card"],
|
||||||
"Card"
|
|
||||||
],
|
|
||||||
"properties": {
|
"properties": {
|
||||||
"Card": {
|
"Card": {
|
||||||
"$ref": "#/components/schemas/CCard"
|
"$ref": "#/components/schemas/CCard"
|
||||||
@ -1421,15 +1303,11 @@
|
|||||||
},
|
},
|
||||||
{
|
{
|
||||||
"type": "string",
|
"type": "string",
|
||||||
"enum": [
|
"enum": ["BankTransfer"]
|
||||||
"BankTransfer"
|
|
||||||
]
|
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
"type": "object",
|
"type": "object",
|
||||||
"required": [
|
"required": ["Wallet"],
|
||||||
"Wallet"
|
|
||||||
],
|
|
||||||
"properties": {
|
"properties": {
|
||||||
"Wallet": {
|
"Wallet": {
|
||||||
"$ref": "#/components/schemas/WalletData"
|
"$ref": "#/components/schemas/WalletData"
|
||||||
@ -1438,9 +1316,7 @@
|
|||||||
},
|
},
|
||||||
{
|
{
|
||||||
"type": "object",
|
"type": "object",
|
||||||
"required": [
|
"required": ["PayLater"],
|
||||||
"PayLater"
|
|
||||||
],
|
|
||||||
"properties": {
|
"properties": {
|
||||||
"PayLater": {
|
"PayLater": {
|
||||||
"$ref": "#/components/schemas/PayLaterData"
|
"$ref": "#/components/schemas/PayLaterData"
|
||||||
@ -1449,9 +1325,7 @@
|
|||||||
},
|
},
|
||||||
{
|
{
|
||||||
"type": "string",
|
"type": "string",
|
||||||
"enum": [
|
"enum": ["Paypal"]
|
||||||
"Paypal"
|
|
||||||
]
|
|
||||||
}
|
}
|
||||||
]
|
]
|
||||||
},
|
},
|
||||||
@ -1500,9 +1374,7 @@
|
|||||||
"items": {
|
"items": {
|
||||||
"$ref": "#/components/schemas/PaymentMethodSubType"
|
"$ref": "#/components/schemas/PaymentMethodSubType"
|
||||||
},
|
},
|
||||||
"example": [
|
"example": ["credit"]
|
||||||
"credit"
|
|
||||||
]
|
|
||||||
},
|
},
|
||||||
"payment_method_issuers": {
|
"payment_method_issuers": {
|
||||||
"type": "array",
|
"type": "array",
|
||||||
@ -1510,9 +1382,7 @@
|
|||||||
"type": "string",
|
"type": "string",
|
||||||
"description": "List of payment method issuers to be enabled for this payment method"
|
"description": "List of payment method issuers to be enabled for this payment method"
|
||||||
},
|
},
|
||||||
"example": [
|
"example": ["HDFC"]
|
||||||
"HDFC"
|
|
||||||
]
|
|
||||||
},
|
},
|
||||||
"payment_schemes": {
|
"payment_schemes": {
|
||||||
"type": "array",
|
"type": "array",
|
||||||
@ -1520,22 +1390,14 @@
|
|||||||
"type": "string",
|
"type": "string",
|
||||||
"description": "List of payment schemes accepted or has the processing capabilities of the processor"
|
"description": "List of payment schemes accepted or has the processing capabilities of the processor"
|
||||||
},
|
},
|
||||||
"example": [
|
"example": ["MASTER", "VISA", "DINERS"]
|
||||||
"MASTER",
|
|
||||||
"VISA",
|
|
||||||
"DINERS"
|
|
||||||
]
|
|
||||||
},
|
},
|
||||||
"accepted_currencies": {
|
"accepted_currencies": {
|
||||||
"type": "array",
|
"type": "array",
|
||||||
"items": {
|
"items": {
|
||||||
"$ref": "#/components/schemas/Currency"
|
"$ref": "#/components/schemas/Currency"
|
||||||
},
|
},
|
||||||
"example": [
|
"example": ["USD", "EUR", "AED"]
|
||||||
"USD",
|
|
||||||
"EUR",
|
|
||||||
"AED"
|
|
||||||
]
|
|
||||||
},
|
},
|
||||||
"accepted_countries": {
|
"accepted_countries": {
|
||||||
"type": "array",
|
"type": "array",
|
||||||
@ -1543,10 +1405,7 @@
|
|||||||
"type": "string",
|
"type": "string",
|
||||||
"description": "List of Countries accepted or has the processing capabilities of the processor"
|
"description": "List of Countries accepted or has the processing capabilities of the processor"
|
||||||
},
|
},
|
||||||
"example": [
|
"example": ["US", "IN"]
|
||||||
"US",
|
|
||||||
"IN"
|
|
||||||
]
|
|
||||||
},
|
},
|
||||||
"minimum_amount": {
|
"minimum_amount": {
|
||||||
"type": "integer",
|
"type": "integer",
|
||||||
@ -1577,9 +1436,7 @@
|
|||||||
"items": {
|
"items": {
|
||||||
"$ref": "#/components/schemas/PaymentExperience"
|
"$ref": "#/components/schemas/PaymentExperience"
|
||||||
},
|
},
|
||||||
"example": [
|
"example": ["redirect_to_url"]
|
||||||
"redirect_to_url"
|
|
||||||
]
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
@ -1791,12 +1648,7 @@
|
|||||||
},
|
},
|
||||||
"PaymentsResponse": {
|
"PaymentsResponse": {
|
||||||
"type": "object",
|
"type": "object",
|
||||||
"required": [
|
"required": ["status", "amount", "currency", "payment_method"],
|
||||||
"status",
|
|
||||||
"amount",
|
|
||||||
"currency",
|
|
||||||
"payment_method"
|
|
||||||
],
|
|
||||||
"properties": {
|
"properties": {
|
||||||
"payment_id": {
|
"payment_id": {
|
||||||
"type": "string",
|
"type": "string",
|
||||||
@ -1975,10 +1827,7 @@
|
|||||||
},
|
},
|
||||||
"PaymentsRetrieveRequest": {
|
"PaymentsRetrieveRequest": {
|
||||||
"type": "object",
|
"type": "object",
|
||||||
"required": [
|
"required": ["resource_id", "force_sync"],
|
||||||
"resource_id",
|
|
||||||
"force_sync"
|
|
||||||
],
|
|
||||||
"properties": {
|
"properties": {
|
||||||
"resource_id": {
|
"resource_id": {
|
||||||
"$ref": "#/components/schemas/PaymentIdType"
|
"$ref": "#/components/schemas/PaymentIdType"
|
||||||
@ -2003,11 +1852,7 @@
|
|||||||
},
|
},
|
||||||
"PaymentsSessionRequest": {
|
"PaymentsSessionRequest": {
|
||||||
"type": "object",
|
"type": "object",
|
||||||
"required": [
|
"required": ["payment_id", "client_secret", "wallets"],
|
||||||
"payment_id",
|
|
||||||
"client_secret",
|
|
||||||
"wallets"
|
|
||||||
],
|
|
||||||
"properties": {
|
"properties": {
|
||||||
"payment_id": {
|
"payment_id": {
|
||||||
"type": "string",
|
"type": "string",
|
||||||
@ -2027,11 +1872,7 @@
|
|||||||
},
|
},
|
||||||
"PaymentsSessionResponse": {
|
"PaymentsSessionResponse": {
|
||||||
"type": "object",
|
"type": "object",
|
||||||
"required": [
|
"required": ["payment_id", "client_secret", "session_token"],
|
||||||
"payment_id",
|
|
||||||
"client_secret",
|
|
||||||
"session_token"
|
|
||||||
],
|
|
||||||
"properties": {
|
"properties": {
|
||||||
"payment_id": {
|
"payment_id": {
|
||||||
"type": "string",
|
"type": "string",
|
||||||
@ -2051,11 +1892,7 @@
|
|||||||
},
|
},
|
||||||
"PaymentsStartRequest": {
|
"PaymentsStartRequest": {
|
||||||
"type": "object",
|
"type": "object",
|
||||||
"required": [
|
"required": ["payment_id", "merchant_id", "attempt_id"],
|
||||||
"payment_id",
|
|
||||||
"merchant_id",
|
|
||||||
"attempt_id"
|
|
||||||
],
|
|
||||||
"properties": {
|
"properties": {
|
||||||
"payment_id": {
|
"payment_id": {
|
||||||
"type": "string",
|
"type": "string",
|
||||||
@ -2127,9 +1964,7 @@
|
|||||||
},
|
},
|
||||||
"RefundRequest": {
|
"RefundRequest": {
|
||||||
"type": "object",
|
"type": "object",
|
||||||
"required": [
|
"required": ["payment_id"],
|
||||||
"payment_id"
|
|
||||||
],
|
|
||||||
"properties": {
|
"properties": {
|
||||||
"refund_id": {
|
"refund_id": {
|
||||||
"type": "string",
|
"type": "string",
|
||||||
@ -2174,13 +2009,7 @@
|
|||||||
},
|
},
|
||||||
"RefundResponse": {
|
"RefundResponse": {
|
||||||
"type": "object",
|
"type": "object",
|
||||||
"required": [
|
"required": ["refund_id", "payment_id", "amount", "currency", "status"],
|
||||||
"refund_id",
|
|
||||||
"payment_id",
|
|
||||||
"amount",
|
|
||||||
"currency",
|
|
||||||
"status"
|
|
||||||
],
|
|
||||||
"properties": {
|
"properties": {
|
||||||
"refund_id": {
|
"refund_id": {
|
||||||
"type": "string"
|
"type": "string"
|
||||||
@ -2219,19 +2048,11 @@
|
|||||||
},
|
},
|
||||||
"RefundStatus": {
|
"RefundStatus": {
|
||||||
"type": "string",
|
"type": "string",
|
||||||
"enum": [
|
"enum": ["succeeded", "failed", "pending", "review"]
|
||||||
"succeeded",
|
|
||||||
"failed",
|
|
||||||
"pending",
|
|
||||||
"review"
|
|
||||||
]
|
|
||||||
},
|
},
|
||||||
"RefundType": {
|
"RefundType": {
|
||||||
"type": "string",
|
"type": "string",
|
||||||
"enum": [
|
"enum": ["scheduled", "instant"]
|
||||||
"scheduled",
|
|
||||||
"instant"
|
|
||||||
]
|
|
||||||
},
|
},
|
||||||
"RefundUpdateRequest": {
|
"RefundUpdateRequest": {
|
||||||
"type": "object",
|
"type": "object",
|
||||||
@ -2250,12 +2071,7 @@
|
|||||||
"RoutingAlgorithm": {
|
"RoutingAlgorithm": {
|
||||||
"type": "string",
|
"type": "string",
|
||||||
"description": "The routing algorithm to be used to process the incoming request from merchant to outgoing payment processor or payment method. The default is 'Custom'",
|
"description": "The routing algorithm to be used to process the incoming request from merchant to outgoing payment processor or payment method. The default is 'Custom'",
|
||||||
"enum": [
|
"enum": ["round_robin", "max_conversion", "min_cost", "custom"],
|
||||||
"round_robin",
|
|
||||||
"max_conversion",
|
|
||||||
"min_cost",
|
|
||||||
"custom"
|
|
||||||
],
|
|
||||||
"example": "custom"
|
"example": "custom"
|
||||||
},
|
},
|
||||||
"SessionToken": {
|
"SessionToken": {
|
||||||
@ -2284,20 +2100,14 @@
|
|||||||
},
|
},
|
||||||
"wallet_name": {
|
"wallet_name": {
|
||||||
"type": "string",
|
"type": "string",
|
||||||
"enum": [
|
"enum": ["gpay"]
|
||||||
"gpay"
|
|
||||||
]
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
"type": "object",
|
"type": "object",
|
||||||
"description": "The session response structure for Klarna",
|
"description": "The session response structure for Klarna",
|
||||||
"required": [
|
"required": ["session_token", "session_id", "wallet_name"],
|
||||||
"session_token",
|
|
||||||
"session_id",
|
|
||||||
"wallet_name"
|
|
||||||
],
|
|
||||||
"properties": {
|
"properties": {
|
||||||
"session_token": {
|
"session_token": {
|
||||||
"type": "string",
|
"type": "string",
|
||||||
@ -2309,19 +2119,14 @@
|
|||||||
},
|
},
|
||||||
"wallet_name": {
|
"wallet_name": {
|
||||||
"type": "string",
|
"type": "string",
|
||||||
"enum": [
|
"enum": ["klarna"]
|
||||||
"klarna"
|
|
||||||
]
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
"type": "object",
|
"type": "object",
|
||||||
"description": "The session response structure for PayPal",
|
"description": "The session response structure for PayPal",
|
||||||
"required": [
|
"required": ["session_token", "wallet_name"],
|
||||||
"session_token",
|
|
||||||
"wallet_name"
|
|
||||||
],
|
|
||||||
"properties": {
|
"properties": {
|
||||||
"session_token": {
|
"session_token": {
|
||||||
"type": "string",
|
"type": "string",
|
||||||
@ -2329,9 +2134,7 @@
|
|||||||
},
|
},
|
||||||
"wallet_name": {
|
"wallet_name": {
|
||||||
"type": "string",
|
"type": "string",
|
||||||
"enum": [
|
"enum": ["paypal"]
|
||||||
"paypal"
|
|
||||||
]
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
@ -2402,9 +2205,7 @@
|
|||||||
},
|
},
|
||||||
"wallet_name": {
|
"wallet_name": {
|
||||||
"type": "string",
|
"type": "string",
|
||||||
"enum": [
|
"enum": ["applepay"]
|
||||||
"applepay"
|
|
||||||
]
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
@ -2416,18 +2217,11 @@
|
|||||||
"SupportedWallets": {
|
"SupportedWallets": {
|
||||||
"type": "string",
|
"type": "string",
|
||||||
"description": "Wallets which support obtaining session object",
|
"description": "Wallets which support obtaining session object",
|
||||||
"enum": [
|
"enum": ["paypal", "apple_pay", "klarna", "gpay"]
|
||||||
"paypal",
|
|
||||||
"apple_pay",
|
|
||||||
"klarna",
|
|
||||||
"gpay"
|
|
||||||
]
|
|
||||||
},
|
},
|
||||||
"WalletData": {
|
"WalletData": {
|
||||||
"type": "object",
|
"type": "object",
|
||||||
"required": [
|
"required": ["issuer_name"],
|
||||||
"issuer_name"
|
|
||||||
],
|
|
||||||
"properties": {
|
"properties": {
|
||||||
"issuer_name": {
|
"issuer_name": {
|
||||||
"$ref": "#/components/schemas/WalletIssuer"
|
"$ref": "#/components/schemas/WalletIssuer"
|
||||||
@ -2440,11 +2234,7 @@
|
|||||||
},
|
},
|
||||||
"WalletIssuer": {
|
"WalletIssuer": {
|
||||||
"type": "string",
|
"type": "string",
|
||||||
"enum": [
|
"enum": ["googlepay", "applepay", "paypal"]
|
||||||
"googlepay",
|
|
||||||
"applepay",
|
|
||||||
"paypal"
|
|
||||||
]
|
|
||||||
},
|
},
|
||||||
"WebhookDetails": {
|
"WebhookDetails": {
|
||||||
"type": "object",
|
"type": "object",
|
||||||
@ -2491,4 +2281,4 @@
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
@ -30,7 +30,7 @@ info:
|
|||||||
|
|
||||||
# Authentication
|
# Authentication
|
||||||
|
|
||||||
When you sign up on our [dashboard](https://dashboard-hyperswitch.netlify.app) and create a merchant account, you are given a secret key (also referred as api-key). You may authenticate all API requests with Juspay server by providing the appropriate key in the request Authorization header.
|
When you sign up on our [dashboard](https://app.hyperswitch.io) and create a merchant account, you are given a secret key (also referred as api-key). You may authenticate all API requests with Juspay server by providing the appropriate key in the request Authorization header.
|
||||||
|
|
||||||
Never share your secret api keys. Keep them guarded and secure.
|
Never share your secret api keys. Keep them guarded and secure.
|
||||||
|
|
||||||
|
|||||||
Reference in New Issue
Block a user