mirror of
https://github.com/juspay/hyperswitch.git
synced 2025-10-31 10:06:32 +08:00
doc: update openapi (#453)
Co-authored-by: Sangamesh <sangamesh.kulkarni@juspay.in> Co-authored-by: dracarys18 <karthikey.hegde@juspay.in> Co-authored-by: bernard eugine <bernard.eugine@bernard.eugine-MacBookPro> Co-authored-by: Abhishek Marrivagu <abhi.codes10@gmail.com>
This commit is contained in:
bernard-eugine
@ -1,51 +1,97 @@
|
||||
#[derive(utoipa::OpenApi)]
|
||||
#[openapi(
|
||||
info(
|
||||
title = "Juspay Router - API Documentation",
|
||||
title = "Hyperswitch - API Documentation",
|
||||
contact(
|
||||
name = "Juspay Support",
|
||||
url = "https://juspay.io",
|
||||
email = "support@juspay.in"
|
||||
name = "Hyperswitch Support",
|
||||
url = "https://hyperswitch.io",
|
||||
email = "hyperswitch@juspay.in"
|
||||
),
|
||||
// terms_of_service = "https://www.juspay.io/terms",
|
||||
description = r#"
|
||||
## Get started
|
||||
|
||||
Juspay Router provides a collection of APIs that enable you to process and manage payments.
|
||||
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.
|
||||
|
||||
We have a testing environment referred to "sandbox", which you can setup to test API calls without
|
||||
affecting production data.
|
||||
affecting production data. Currently, our sandbox environment is live while our production environment is under development and will be available soon. You can sign up on our Dashboard to get API keys to access Hyperswitch API.
|
||||
|
||||
### Base URLs
|
||||
### Environment
|
||||
|
||||
Use the following base URLs when making requests to the APIs:
|
||||
|
||||
| Environment | Base URL |
|
||||
|---------------|------------------------------------------------------|
|
||||
| Sandbox | <https://sandbox.hyperswitch.io> |
|
||||
| Production | <https://router.juspay.io> |
|
||||
| Environment | Base URL |
|
||||
|---------------|------------------------------------|
|
||||
| Sandbox | <https://sandbox.hyperswitch.io> |
|
||||
| Production | Coming Soon! |
|
||||
|
||||
## Authentication
|
||||
|
||||
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
|
||||
account, you are given a secret key (also referred as api-key) and a publishable key.
|
||||
You may authenticate all API requests with Hyperswitch server by providing the appropriate key in the
|
||||
request Authorization header.
|
||||
|
||||
| Key | Description |
|
||||
|---------------|-----------------------------------------------------------------------------------------------|
|
||||
| Sandbox | Private key. Used to authenticate all API requests from your merchant server |
|
||||
| Production | Unique identifier for your account. Used to authenticate API requests from your app’s client |
|
||||
|
||||
Never share your secret api keys. Keep them guarded and secure.
|
||||
"#,
|
||||
),
|
||||
servers(
|
||||
(url = "https://sandbox.hyperswitch.io", description = "Sandbox Environment"),
|
||||
(url = "https://router.juspay.io", description = "Production Environment")
|
||||
(url = "https://sandbox.hyperswitch.io", description = "Sandbox Environment")
|
||||
),
|
||||
tags(
|
||||
(name = "Merchant Account"),// , description = "Create and manage merchant accounts"),
|
||||
(name = "Merchant Connector Account"),// , description = "Create and manage merchant connector accounts"),
|
||||
(name = "Payments"),// , description = "Create and manage one-time payments, recurring payments and mandates"),
|
||||
(name = "Refunds"),// , description = "Create and manage refunds for successful payments"),
|
||||
(name = "Mandates"),// , description = "Manage mandates"),
|
||||
(name = "Customers"),// , description = "Create and manage customers"),
|
||||
(name = "Payment Methods")// , description = "Create and manage payment methods of customers")
|
||||
),
|
||||
paths(
|
||||
crate::routes::refunds::refunds_create,
|
||||
crate::routes::refunds::refunds_retrieve,
|
||||
crate::routes::refunds::refunds_update,
|
||||
crate::routes::refunds::refunds_list,
|
||||
crate::routes::refunds::refunds_create,
|
||||
crate::routes::admin::merchant_account_create,
|
||||
crate::routes::payments::payments_create
|
||||
crate::routes::admin::retrieve_merchant_account,
|
||||
crate::routes::admin::update_merchant_account,
|
||||
crate::routes::admin::delete_merchant_account,
|
||||
crate::routes::admin::payment_connector_create,
|
||||
crate::routes::admin::payment_connector_retrieve,
|
||||
crate::routes::admin::payment_connector_list,
|
||||
crate::routes::admin::payment_connector_update,
|
||||
crate::routes::admin::payment_connector_delete,
|
||||
crate::routes::mandates::get_mandate,
|
||||
crate::routes::mandates::revoke_mandate,
|
||||
crate::routes::payments::payments_create,
|
||||
// crate::routes::payments::payments_start,
|
||||
crate::routes::payments::payments_retrieve,
|
||||
crate::routes::payments::payments_update,
|
||||
crate::routes::payments::payments_confirm,
|
||||
crate::routes::payments::payments_capture,
|
||||
crate::routes::payments::payments_connector_session,
|
||||
// crate::routes::payments::payments_redirect_response,
|
||||
crate::routes::payments::payments_cancel,
|
||||
crate::routes::payments::payments_list,
|
||||
crate::routes::payment_methods::create_payment_method_api,
|
||||
crate::routes::payment_methods::list_payment_method_api,
|
||||
crate::routes::payment_methods::list_customer_payment_method_api,
|
||||
crate::routes::payment_methods::payment_method_retrieve_api,
|
||||
crate::routes::payment_methods::payment_method_update_api,
|
||||
crate::routes::payment_methods::payment_method_delete_api,
|
||||
crate::routes::customers::customers_create,
|
||||
crate::routes::customers::customers_retrieve,
|
||||
crate::routes::customers::customers_update,
|
||||
crate::routes::customers::customers_delete,
|
||||
),
|
||||
components(schemas(
|
||||
crate::types::api::refunds::RefundRequest,
|
||||
@ -54,10 +100,20 @@ Never share your secret api keys. Keep them guarded and secure.
|
||||
crate::types::api::refunds::RefundStatus,
|
||||
crate::types::api::refunds::RefundUpdateRequest,
|
||||
crate::types::api::admin::CreateMerchantAccount,
|
||||
crate::types::api::admin::DeleteResponse,
|
||||
crate::types::api::admin::DeleteMerchantAccountResponse,
|
||||
crate::types::api::admin::DeleteMcaResponse,
|
||||
crate::types::api::customers::CustomerRequest,
|
||||
crate::types::api::customers::CustomerDeleteResponse,
|
||||
crate::types::api::payment_methods::CreatePaymentMethod,
|
||||
crate::types::api::payment_methods::PaymentMethodResponse,
|
||||
crate::types::api::payment_methods::ListPaymentMethod,
|
||||
crate::types::api::payment_methods::CustomerPaymentMethod,
|
||||
crate::types::api::payment_methods::ListPaymentMethodResponse,
|
||||
crate::types::api::payment_methods::ListCustomerPaymentMethodsResponse,
|
||||
crate::types::api::payment_methods::DeletePaymentMethodResponse,
|
||||
crate::types::api::payment_methods::UpdatePaymentMethod,
|
||||
crate::types::api::payment_methods::CardDetailFromLocker,
|
||||
crate::types::api::payment_methods::CardDetail,
|
||||
api_models::customers::CustomerResponse,
|
||||
api_models::enums::RoutingAlgorithm,
|
||||
api_models::enums::PaymentMethodType,
|
||||
@ -72,6 +128,8 @@ Never share your secret api keys. Keep them guarded and secure.
|
||||
api_models::enums::Connector,
|
||||
api_models::enums::PaymentMethodType,
|
||||
api_models::enums::SupportedWallets,
|
||||
api_models::enums::PaymentMethodIssuerCode,
|
||||
api_models::enums::MandateStatus,
|
||||
api_models::admin::PaymentConnectorCreate,
|
||||
api_models::admin::PaymentMethods,
|
||||
api_models::payments::AddressDetails,
|
||||
@ -92,7 +150,7 @@ Never share your secret api keys. Keep them guarded and secure.
|
||||
api_models::payments::AcceptanceType,
|
||||
api_models::payments::MandateAmountData,
|
||||
api_models::payments::OnlineMandate,
|
||||
api_models::payments::CCard,
|
||||
api_models::payments::Card,
|
||||
api_models::payments::CustomerAcceptance,
|
||||
api_models::payments::PaymentsRequest,
|
||||
api_models::payments::PaymentsResponse,
|
||||
@ -115,6 +173,10 @@ Never share your secret api keys. Keep them guarded and secure.
|
||||
api_models::payments::PaymentListConstraints,
|
||||
api_models::payments::PaymentListResponse,
|
||||
api_models::refunds::RefundListRequest,
|
||||
api_models::refunds::RefundListResponse,
|
||||
api_models::mandates::MandateRevokedResponse,
|
||||
api_models::mandates::MandateResponse,
|
||||
api_models::mandates::MandateCardDetails,
|
||||
crate::types::api::admin::MerchantAccountResponse,
|
||||
crate::types::api::admin::MerchantConnectorId,
|
||||
crate::types::api::admin::MerchantDetails,
|
||||
|
||||
Reference in New Issue
Block a user