mirror of
https://github.com/juspay/hyperswitch.git
synced 2025-11-02 04:04:43 +08:00
docs: api-reference changes for customers and admin list apis for v2 (#5936)
This commit is contained in:
committed by
GitHub
parent
99f5933894
commit
ed13146b80
@ -0,0 +1,3 @@
|
|||||||
|
---
|
||||||
|
openapi: get /v2/profiles/{profile_id}/connector_accounts
|
||||||
|
---
|
||||||
@ -0,0 +1,3 @@
|
|||||||
|
---
|
||||||
|
openapi: post /v2/customers
|
||||||
|
---
|
||||||
@ -0,0 +1,3 @@
|
|||||||
|
---
|
||||||
|
openapi: delete /v2/customers/{id}
|
||||||
|
---
|
||||||
@ -0,0 +1,3 @@
|
|||||||
|
---
|
||||||
|
openapi: get /v2/customers/list
|
||||||
|
---
|
||||||
@ -0,0 +1,3 @@
|
|||||||
|
---
|
||||||
|
openapi: get /v2/customers/{id}
|
||||||
|
---
|
||||||
@ -0,0 +1,3 @@
|
|||||||
|
---
|
||||||
|
openapi: post /v2/customers/{id}
|
||||||
|
---
|
||||||
@ -0,0 +1,3 @@
|
|||||||
|
---
|
||||||
|
openapi: get /v2/merchant_accounts/{account_id}/profiles
|
||||||
|
---
|
||||||
@ -1,3 +1,3 @@
|
|||||||
---
|
---
|
||||||
openapi: post /v2/accounts
|
openapi: post /v2/merchant_accounts
|
||||||
---
|
---
|
||||||
@ -1,3 +1,3 @@
|
|||||||
---
|
---
|
||||||
openapi: get /v2/accounts/{id}
|
openapi: get /v2/merchant_accounts/{id}
|
||||||
---
|
---
|
||||||
@ -1,3 +1,3 @@
|
|||||||
---
|
---
|
||||||
openapi: put /v2/accounts/{id}
|
openapi: put /v2/merchant_accounts/{id}
|
||||||
---
|
---
|
||||||
@ -0,0 +1,3 @@
|
|||||||
|
---
|
||||||
|
openapi: get /v2/organization/{organization_id}/merchant_accounts
|
||||||
|
---
|
||||||
@ -39,7 +39,8 @@
|
|||||||
"pages": [
|
"pages": [
|
||||||
"api-reference/organization/organization--create",
|
"api-reference/organization/organization--create",
|
||||||
"api-reference/organization/organization--retrieve",
|
"api-reference/organization/organization--retrieve",
|
||||||
"api-reference/organization/organization--update"
|
"api-reference/organization/organization--update",
|
||||||
|
"api-reference/organization/merchant-account--list"
|
||||||
]
|
]
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
@ -47,7 +48,8 @@
|
|||||||
"pages": [
|
"pages": [
|
||||||
"api-reference/merchant-account/merchant-account--create",
|
"api-reference/merchant-account/merchant-account--create",
|
||||||
"api-reference/merchant-account/merchant-account--retrieve",
|
"api-reference/merchant-account/merchant-account--retrieve",
|
||||||
"api-reference/merchant-account/merchant-account--update"
|
"api-reference/merchant-account/merchant-account--update",
|
||||||
|
"api-reference/merchant-account/business-profile--list"
|
||||||
]
|
]
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
@ -56,6 +58,7 @@
|
|||||||
"api-reference/business-profile/business-profile--create",
|
"api-reference/business-profile/business-profile--create",
|
||||||
"api-reference/business-profile/business-profile--update",
|
"api-reference/business-profile/business-profile--update",
|
||||||
"api-reference/business-profile/business-profile--retrieve",
|
"api-reference/business-profile/business-profile--retrieve",
|
||||||
|
"api-reference/business-profile/merchant-connector--list",
|
||||||
"api-reference/business-profile/business-profile--activate-routing-algorithm",
|
"api-reference/business-profile/business-profile--activate-routing-algorithm",
|
||||||
"api-reference/business-profile/business-profile--retrieve-active-routing-algorithm",
|
"api-reference/business-profile/business-profile--retrieve-active-routing-algorithm",
|
||||||
"api-reference/business-profile/business-profile--deactivate-routing-algorithm",
|
"api-reference/business-profile/business-profile--deactivate-routing-algorithm",
|
||||||
@ -86,6 +89,16 @@
|
|||||||
"api-reference/routing/routing--create",
|
"api-reference/routing/routing--create",
|
||||||
"api-reference/routing/routing--retrieve"
|
"api-reference/routing/routing--retrieve"
|
||||||
]
|
]
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"group": "Customers",
|
||||||
|
"pages": [
|
||||||
|
"api-reference/customers/customers--create",
|
||||||
|
"api-reference/customers/customers--retrieve",
|
||||||
|
"api-reference/customers/customers--update",
|
||||||
|
"api-reference/customers/customers--delete",
|
||||||
|
"api-reference/customers/customers--list"
|
||||||
|
]
|
||||||
}
|
}
|
||||||
],
|
],
|
||||||
"footerSocials": {
|
"footerSocials": {
|
||||||
|
|||||||
@ -1438,8 +1438,8 @@
|
|||||||
"tags": [
|
"tags": [
|
||||||
"Customers"
|
"Customers"
|
||||||
],
|
],
|
||||||
"summary": "Creates a customer object and stores the customer details to be reused for future payments.",
|
"summary": "Customers - Create",
|
||||||
"description": "Incase the customer already exists in the system, this API will respond with the customer details.",
|
"description": "Creates a customer object and stores the customer details to be reused for future payments.\nIncase the customer already exists in the system, this API will respond with the customer details.",
|
||||||
"operationId": "Create a Customer",
|
"operationId": "Create a Customer",
|
||||||
"requestBody": {
|
"requestBody": {
|
||||||
"content": {
|
"content": {
|
||||||
@ -1622,7 +1622,7 @@
|
|||||||
}
|
}
|
||||||
},
|
},
|
||||||
"/v2/customers/list": {
|
"/v2/customers/list": {
|
||||||
"post": {
|
"get": {
|
||||||
"tags": [
|
"tags": [
|
||||||
"Customers"
|
"Customers"
|
||||||
],
|
],
|
||||||
|
|||||||
@ -1,3 +1,3 @@
|
|||||||
---
|
---
|
||||||
openapi: openapi_spec post /customers/list
|
openapi: openapi_spec get /customers/list
|
||||||
---
|
---
|
||||||
@ -2304,7 +2304,7 @@
|
|||||||
}
|
}
|
||||||
},
|
},
|
||||||
"/customers/list": {
|
"/customers/list": {
|
||||||
"post": {
|
"get": {
|
||||||
"tags": [
|
"tags": [
|
||||||
"Customers"
|
"Customers"
|
||||||
],
|
],
|
||||||
|
|||||||
@ -93,7 +93,7 @@ pub async fn customers_delete() {}
|
|||||||
///
|
///
|
||||||
/// Lists all the customers for a particular merchant id.
|
/// Lists all the customers for a particular merchant id.
|
||||||
#[utoipa::path(
|
#[utoipa::path(
|
||||||
post,
|
get,
|
||||||
path = "/customers/list",
|
path = "/customers/list",
|
||||||
responses(
|
responses(
|
||||||
(status = 200, description = "Customers retrieved", body = Vec<CustomerResponse>),
|
(status = 200, description = "Customers retrieved", body = Vec<CustomerResponse>),
|
||||||
@ -106,6 +106,8 @@ pub async fn customers_delete() {}
|
|||||||
#[cfg(feature = "v1")]
|
#[cfg(feature = "v1")]
|
||||||
pub async fn customers_list() {}
|
pub async fn customers_list() {}
|
||||||
|
|
||||||
|
/// Customers - Create
|
||||||
|
///
|
||||||
/// Creates a customer object and stores the customer details to be reused for future payments.
|
/// Creates a customer object and stores the customer details to be reused for future payments.
|
||||||
/// Incase the customer already exists in the system, this API will respond with the customer details.
|
/// Incase the customer already exists in the system, this API will respond with the customer details.
|
||||||
#[utoipa::path(
|
#[utoipa::path(
|
||||||
@ -199,7 +201,7 @@ pub async fn customers_delete() {}
|
|||||||
///
|
///
|
||||||
/// Lists all the customers for a particular merchant id.
|
/// Lists all the customers for a particular merchant id.
|
||||||
#[utoipa::path(
|
#[utoipa::path(
|
||||||
post,
|
get,
|
||||||
path = "/v2/customers/list",
|
path = "/v2/customers/list",
|
||||||
responses(
|
responses(
|
||||||
(status = 200, description = "Customers retrieved", body = Vec<CustomerResponse>),
|
(status = 200, description = "Customers retrieved", body = Vec<CustomerResponse>),
|
||||||
|
|||||||
Reference in New Issue
Block a user