rust/hyperswitch
1
0
Fork 0
mirror of https://github.com/juspay/hyperswitch.git synced 2025-11-01 02:57:02 +08:00
Code Issues Packages Projects Releases Wiki Activity

docs(openapi): Show API version selection dropdown in Mintlify (#8333)

Browse Source
This commit is contained in:
Anurag Thakur
2025-06-13 14:00:38 +05:30
committed by GitHub
parent 535a927e42
commit ce85b838f4
224 changed files with 472 additions and 1163 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
.github/workflows/validate-openapi-spec.yml vendored
View File

@ -64,21 +64,21 @@ jobs:
- name: Validate the JSON file
shell: bash
run: swagger-cli validate ./api-reference/openapi_spec.json
run: swagger-cli validate ./api-reference/v1/openapi_spec_v1.json
- name: Validate the JSON file for V2
shell: bash
run: swagger-cli validate ./api-reference-v2/openapi_spec.json
run: swagger-cli validate ./api-reference/v2/openapi_spec_v2.json
- name: Commit the JSON file if it is not up-to-date
# PR originated from same repository
if: ${{ (github.event_name == 'pull_request') && (github.event.pull_request.head.repo.full_name == github.event.pull_request.base.repo.full_name) }}
shell: bash
run: |
if ! git diff --quiet --exit-code -- api-reference/openapi_spec.json api-reference-v2/openapi_spec.json ; then
if ! git diff --quiet --exit-code -- api-reference/v1/openapi_spec_v1.json api-reference/v2/openapi_spec_v2.json ; then
git config --local user.name 'hyperswitch-bot[bot]'
git config --local user.email '148525504+hyperswitch-bot[bot]@users.noreply.github.com'
git add api-reference/openapi_spec.json api-reference-v2/openapi_spec.json
git add api-reference/v1/openapi_spec_v1.json api-reference/v2/openapi_spec_v2.json
git commit --message 'docs(openapi): re-generate OpenAPI specification'
git push
fi
@ -87,7 +87,7 @@ jobs:
if: ${{ (github.event_name == 'merge_group') || ((github.event_name == 'pull_request') && (github.event.pull_request.head.repo.full_name != github.event.pull_request.base.repo.full_name)) }}
shell: bash
run: |
if ! git diff --quiet --exit-code -- api-reference/openapi_spec.json ; then
if ! git diff --quiet --exit-code -- api-reference/v1/openapi_spec_v1.json ; then
echo '::error::The OpenAPI spec file is not up-to-date. Please re-generate the OpenAPI spec file using `cargo run -p openapi --features v1 && cargo run -p openapi --features v2` and commit it.'
exit 1
fi

45
api-reference-v2/README.md
View File

@ -1,45 +0,0 @@
# Api Reference
We use the [openapi specification](https://swagger.io/specification) for the api reference. The openapi file is generated from the code base [openapi_spec.json](openapi_spec.json).
## How to generate the file
This file is automatically generated from our CI pipeline when the PR is raised. However if you want to generate it manually, the following command can be used
```bash
cargo r -p openapi --features v2
```
## Render the generated openapi spec file
In order to render the openapi spec file, we use a tool called [mintlify](https://mintlify.com/). Local setup instructions can be found [here](https://mintlify.com/docs/development#development). Once the cli is installed, Run the following command to render the openapi spec
- Navigate to the directory where `mint.json` exists
```bash
cd api-reference-v2
```
- Run the cli
```bash
mintlify dev
```
## Add new routes to openapi
If you have added new routes to the openapi. Then in order for them to be displayed on the mintlify, run the following commands
- Switch to the directory where api reference ( mint.json ) exists
```bash
cd api-reference-v2
```
- Run the following command to generate the route files
```bash
npx @mintlify/scraping@latest openapi-file openapi_spec.json -o api-reference
```
This will generate files in [api-reference](api-reference) folder. These routes should be added to the [mint.json](mint.json) file under navigation, under respective group.

BIN
api-reference-v2/assets/images/image.png
View File

Binary file not shown.
Side by Side

Before

Width:  |  Height:  |  Size: 202 KiB

77
api-reference-v2/essentials/error_codes.mdx
View File

@ -1,77 +0,0 @@
---
title: Error Codes
---
Hyperswitch uses Error codes, types, and messages to communicate errors during API calls. There are three types of error codes:
| Error Code | Type | Description |
| ---------- | --------------------- | ------------------------------------------------------------ |
| IR | Invalid Request Error | Error caused due to invalid fields and values in API request |
| CE | Connector Error | Errors originating from connector’s end |
| HE | Hyperswitch Error | Errors originating from Hyperswitch’s end |
| WE | Webhook Error | Errors related to Webhooks |
| Error Codes | HTTP Status codes | Error Type | Error message | Error Handling |
| ----------- | ------------------------------------- | --------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| IR_00 | 501 | server_not_available | This API is under development and will be made available soon | No action required. If you require this feature, please reach out to Hyperswitch support |
| IR_01 | 401 | invalid_request_error | API key not provided or invalid API key used. Provide the API key in the Authorization header using api-key (e.g api-key: API_KEY) or create a new API key from the dashboard | Provide the API key in the Authorization header using api-key (e.g api-key: API_KEY) or create a new API key from the dashboard |
| IR_02 | 404 | invalid_request_error | Unrecognized request URL | Please recheck and enter the correct request URL. Refer to our API documentation |
| IR_03 | 405 | invalid_request_error | The HTTP method is not applicable for this API | Please recheck the HTTP method used in the request. Refer to our API documentation |
| IR_04 | 400 | invalid_request_error | Missing required param: “field_name” | Please pass the missing required parameter. Refer to our API documentation |
| IR_05 | 422 | invalid_request_error | “field_name” contains invalid data. Expected format is “expected_format” | Please pass the data in the expected format. Refer to our API documentation |
| IR_06 | 400 | invalid_request_error | “message” | Refer to our API documentation for required fields and format |
| IR_07 | 400 | invalid_request_error | Invalid value provided: “field_name” | Provide a valid value for the required fields in the expected format. Refer to our API documentation |
| IR_08 | 400 | invalid_request_error | Client secret was not provided | Provide the client secret received in payments/create API response |
| IR_09 | 400 | invalid_request_error | The client_secret provided does not match the client_secret associated with the Payment | Provide the same client secret received in payments/create API response for the corresponding payment |
| IR_10 | 400 | invalid_request_error | Customer has an existing mandate/subscription | Cancel the active mandates/subscriptions for the customer before proceeding to delete the customer data |
| IR_11 | 400 | invalid_request_error | Customer has already been redacted | Customer has already been redacted. No action required |
| IR_12 | 400 | invalid_request_error | Reached the maximum refund attempts | Maximum refund attempts reached for this payment. Please contact Hyperswitch support for attempting more refunds for the same payment |
| IR_13 | 400 | invalid_request_error | Refund amount exceeds the payment amount | Please verify and pass a refund amount equal to or less than the payment amount |
| IR_14 | 400 | invalid_request_error | This Payment could not be “current_flow” because it has a “field_name” of “current_value”. The expected state is “states” | Please verify the status of the payment and make sure that you are performing an action that is allowed for the current status of the payment |
| IR_15 | 400 | invalid_request_error | Invalid Ephemeral Key for the customer | Please pass the right Ephemeral key for the customer |
| IR_16 | 400 | invalid_request_error | “message” | Typically used when information involving multiple fields or previously provided information doesn’t satisfy a condition. Refer to our API documentation for required fields and format |
| IR_17 | 401 | invalid_request_error | Access forbidden, an invalid JWT token was used | Provide a valid JWT token to access the APIs |
| IR_18 | 401 | invalid_request_error | "message" | The user is not authorised to update the customer, Contact Org. Admin for the appropriate access. |
| IR_19 | 400 | invalid_request_error | "message" | Please check and retry with correct details. Refer to our API documentation |
| IR_20 | 400 | invalid_request_error | "flow" not supported by the "connector" | Requested flow is not supported for this Connector. |
| IR_21 | 400 | invalid_request_error | Missing required params | Please add the required params in the request. Refer to our API documentation |
| IR_22 | 403 | invalid_request_error | Access forbidden. Not authorized to access this "resource" | Contact Org. Admin for the appropriate access. |
| IR_23 | 400 | invalid_request_error | "message" | Use a supported file provider. Refer to our API documentation |
| IR_24 | 422 | processing_error | Invalid "wallet_name" wallet token | Share the correct wallet token. |
| IR_25 | 400 | invalid_request_error | Cannot delete the default payment method | Check if the Payment method is activated. Refer to Control centre to check this. |
| IR_26 | 400 | invalid_request_error | Invalid Cookie | Recheck the site setting for the cookies. |
| IR_27 | 404 | invalid_request_error | Extended card info does not exist | Recheck the card info shared in the request. |
| IR_28 | 400 | invalid_request_error | "message" | Use a valid currency. Refer to our API documentation |
| IR_29 | 422 | invalid_request_error | "message" | The data format is invalid for this request. Refer to our API documentation |
| IR_30 | 400 | invalid_request_error | Merchant connector account is configured with invalid config | Correct the config for merchant connector account |
| IR_31 | 400 | invalid_request_error | Card with the provided iin does not exist | Check the IIN (Issuer Identification Number) and ensure it is correct. |
| IR_32 | 400 | invalid_request_error | The provided card IIN length is invalid, please provide an iin with 6 or 8 digits | Provide a valid IIN with either 6 or 8 digits. |
| IR_33 | 400 | invalid_request_error | File not found / valid in the request | Ensure the required file is included in the request and is valid. Refer to our API documentation |
| IR_34 | 400 | invalid_request_error | Dispute id not found in the request | Ensure that a valid dispute ID is included in the request. |
| IR_35 | 400 | invalid_request_error | File purpose not found in the request or is invalid | Specify a valid file purpose in the request. |
| IR_36 | 400 | invalid_request_error | File content type not found / valid | Ensure the file content type is specified and is valid. |
| IR_37 | 404 | invalid_request_error | "message" | Check the request for the resource being accessed and ensure it exists. |
| IR_38 | 400 | invalid_request_error | "message" | Check for any duplicate entries in the request and correct them. |
| IR_39 | 400 | invalid_request_error | required payment method is not configured or configured incorrectly for all configured connectors | Verify that the required payment method is correctly configured for all connectors in use. |
| CE_00 | Status codes shared by the connectors | connector_error | “message” | The error code and message passed from the connectors. Refer to the respective connector’s documentation for more information on the error |
| CE_01 | 400 | processing_error | Payment failed during authorization with the connector. Retry payment | Retry the payment again as payment failed at the connector during authorization |
| CE_02 | 400 | processing_error | Payment failed during authentication with the connector. Retry payment | Retry the payment again as payment failed at the connector during authentication |
| CE_03 | 400 | processing_error | Capture attempt failed while processing with the connector | Capture failed for the payment at the connector. Please retry the payment |
| CE_04 | 400 | processing_error | The card data is invalid | Invalid card data passed. Please pass valid card data |
| CE_05 | 400 | processing_error | The card has expired | Card expired. Please pass valid card data |
| CE_06 | 400 | processing_error | Refund failed while processing with the connector. Retry refund | Refund failed to process at the connector. Please retry refund |
| CE_07 | 400 | processing_error | Verification failed while processing with the connector. Retry operation | Retry the operation again as verification failed at the connector |
| CE_08 | 400 | processing_error | Dispute operation failed while processing with connector. Retry operation | Retry the operation again as dispute failed at the connector |
| CE_09 | 400 | invalid_request_error | Payout validation failed | Retry the operation again with correct Payout details. |
| HE_00 | 422,500 | server_not_available | Resource not available right now, Please try again later. | Please Wait for a few moments and try again. If the error still persists, please reach out to Hyperswitch support |
| HE_01 | 400,422 | duplicate_request | Requested operation(Customer, Payments, Merchants, Refunds etc.) for these identifier already exists. | Please verify the Details(Customer, Payments, Merchants, Refunds, as applicable on the basis of request) and enter valid details. |
| HE_02 | 404 | object_not_found | Requested object(Customer, Payments, Merchants, Refunds etc.) does not exist in our records | Please verify the Details(Customer, Payments, Merchants, Refunds, as applicable on the basis of request) and enter valid details. |
| HE_03 | 500 | validation_error | Validation Failed for the requested operation with the given details. | Please verify the details again and enter valid details |
| HE_04 | 404 | object_not_found | Requested object(Customer, Payments, Merchants, Refunds etc.) does not exist in our records | Please verify the Details(Customer, Payments, Merchants, Refunds, as applicable on the basis of request) and enter valid details. |
| HE_05 | 500 | processing_error | Missing or invalid tenant details. | Please verify the tenant Details and try again. |
| WE_01 | 400 | invalid_request_error | Failed to authenticate the webhook | Please verify the authentication credentials and try again. |
| WE_02 | 400 | invalid_request_error | Bad request received in webhook | Check the request parameters and format, then try again. |
| WE_03 | 500 | router_error | There was some issue processing the webhook | Please try again later. If the issue persists, contact Hyperswitch support. |
| WE_04 | 404 | object_not_found | Webhook resource not found | Ensure the webhook URL is correct and the resource exists. |
| WE_05 | 400 | invalid_request_error | Unable to process the webhook body | Ensure the webhook body is correctly formatted and try again. |
| WE_06 | 400 | invalid_request_error | Merchant Secret set by merchant for webhook source verification is invalid | Verify the Merchant Secret, then try again. |

50
api-reference-v2/essentials/go-live.mdx
View File

@ -1,50 +0,0 @@
---
title: Go-live Checklist
---
Refer to this checklist for a seamless transition as you prepare to go live with your integration.
<Warning>
The connector configurations set up in the sandbox need to be replicated on the Hyperswitch production account.
</Warning>
### Signing of Hyperswitch services agreement
- [ ] Ensure that the Hyperswitch services agreement is signed and shared with the Hyperswitch team. In case you need any help, please drop an email to biz@hyperswitch.io.
<Warning>
The Hyperswitch team will share your production Hyperswitch credentials once the above process is completed.
</Warning>
### Connector Configurations
- [ ] Configure all the required connectors using production credentials on the Hyperswitch production dashboard and enable the required payment methods.
- [ ] Ensure that the payment methods are enabled on the connector (payment processor) dashboard.
- [ ] Enable raw card processing for each connector. Some connectors offer this as a dashboard toggle feature. Some processors might need you to share a PCI Attestation of Compliance over email to enable this. Drop an email to biz@hyperswitch.io if you need any support with PCI AOC.
### Secure your api-keys
- [ ] Make sure your secret key (api-key) is not exposed on the front-end (website/mobile app).
- [ ] Ensure that your workflow avoids the duplication or storage of your API keys in multiple locations.
### Set up Webhooks
- [ ] [Configure your webhook endpoint](https://juspay-78.mintlify.app/essentials/webhooks#configuring-webhooks) on our dashboard to receive notifications for different events.
- [ ] Update Hyperswitch's webhook endpoints on your connector's Dashboard. [Refer here](https://juspay-78.mintlify.app/essentials/webhooks#configuring-webhooks) for detailed instructions.
- [ ] Update the connector secret key in our dashboard for us to authenticate webhooks sent by your connector.
### Secure your Payments
- [ ] Make sure you decrypt and verify the signed payload sent along with the payment status in your return URL.
- [ ] Always verify the payment amount and payment status before fulfilling your customer's shopping cart/service request.
### Error Handling
- [ ] Make sure your API integration is set up to handle all the possible error scenarios (refer this [link](https://juspay-78.mintlify.app/essentials/error_codes)).
- [ ] Ensure your Unified Checkout (SDK) integration is set up to handle all the possible error scenarios (refer this [link](https://hyperswitch.io/docs/sdkIntegrations/unifiedCheckoutWeb/errorCodes)).
- [ ] Ensure that your integration can handle the entire payments lifecycle and test various scenarios using actual payment details.
### Customize and sanity check the payment experience
- [ ] Ensure the pay button is properly highlighted to the customer.
- [ ] Ensure a blended look and feel of the payment experience using the [styling APIs](https://hyperswitch.io/docs/sdkIntegrations/unifiedCheckoutWeb/customization) of Unified Checkout.

30
api-reference-v2/essentials/rate_limit.mdx
View File

@ -1,30 +0,0 @@
---
title: Rate Limits
---
The Hyperswitch API has multiple checks in place to enhance its stability when faced with sudden surges of incoming traffic. Merchants who send numerous requests in rapid succession could encounter error responses indicated by the status code 429.
<Warning>
The default rate limit for all Hyperswitch APIs is **80 requests per second**.
Reach out to biz@hyperswitch.io if you have a requirement for higher limits.
</Warning>
## How to handle rate limits
Effectively handling rate limit 429 errors is crucial for maintaining a seamless user experience.
- Implement retry mechanisms with progressively increasing intervals to avoid overwhelming the system with repeated requests.
- To proactively manage these errors, monitoring tools can help track usage patterns and provide insights for adjusting rate limits as necessary.
- Ultimately, a well-orchestrated strategy for managing 429 errors not only prevents disruption but also fosters positive user engagement by transparently addressing limitations and promoting responsible API usage.
## Understanding API locking
If you see a 429 error with the following error message, it is due to API locking and not due to rate limiting:
```text
At this moment, access to this object is restricted due to ongoing utilization by another API request or an ongoing Hyperswitch process. Retry after some time if this error persists.
```
API locking is a robust feature that empowers us to proactively secure and optimize access to our APIs. Our API locks objects on some operations to prevent the disruption caused by concurrent workloads that could potentially lead to inconsistent outcomes.
This proactive measure not only ensures the continued integrity and performance of our APIs but also guarantees a high standard of security for our users. Once triggered, the API lock initiates a controlled pause in access, preventing any potential threats from compromising the system.

BIN
api-reference-v2/favicon.png
View File

Binary file not shown.
Side by Side

Before

Width:  |  Height:  |  Size: 9.8 KiB

51
api-reference-v2/introduction.mdx
View File

@ -1,51 +0,0 @@
---
tags: [Getting Started]
stoplight-id: 3lmsk7ocvq21v
---
# 👋 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.
## 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.
Use the following base URLs when making requests to the APIs:
| Environment | Base URL |
| ----------- | ------------------------------ |
| Sandbox | https://sandbox.hyperswitch.io |
| Production | https://api.hyperswitch.io |
<Note> If you **do not hold a PCI certification** to collect and store card data on your servers, we recommend using [**Unified Checkout**](https://hyperswitch.io/docs/sdkIntegrations/unifiedCheckoutWeb/#unified-checkout) to accept card information from users. </Note>
## Authentication and API keys
Hyperswitch authenticates your API requests using your account’s API keys. Each account has two API keys for authentication:
| Key | Example | When to Use |
| -------------------- | --------------- | ---------------------------------------------------------------------------------------------------------------------------------------- |
| Secret key (API-key) | `snd_c69***` | Used to authenticate API requests from your merchant server. **Don’t expose this key** on a website or embed it in a mobile application. |
| Publishable key | `pk_snd_3b3***` | Used to authenticate API requests from your app’s client. Can be publicly-accessible in your web or mobile app’s client-side code. |
<Check>
Get your [API key](https://app.hyperswitch.io/developers?tabIndex=1) and [Publishable Key](https://app.hyperswitch.io/home)
</Check>
<Check>
[Postman Collection](https://www.postman.com/hyperswitch/workspace/hyperswitch-development/collection/25176162-630b5353-7002-44d1-8ba1-ead6c230f2e3)
</Check>
## Payment Status Lifecycle
Hyperswitch handles the complex functionality of a comprehensive payments flow through the Payments object that transitions through multiple states during its payments lifecycle. Given below are the various statuses a payment can have:
| Payment Status | Description |
| ------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| requires_payment_method | Once you create a payment through payments/create endpoint with no payment method attached to it, the payments object transitions to ‘requires_payment_method’. |
| requires_confirmation | After attaching a payment method through payments/update endpoint, the payments object requires you to confirm the payment. |
| requires_customer_action | Once the payment is confirmed through payments/confirm endpoint, if additional authentication is required, the payments object transitions to this state. |
| requires_capture | If you want to do separate authorize and capture, setting capture field to ‘manual’ during payments/create or confirm call will transition the payment object to this state after customer action succeeds. |
| processing | In case of automatic capture, the payments object transitions to processing state post confirm call and subsequent customer authentication if available. |
| succeeded | The payments object reaches success state post confirmation of successful processing from the payment processor. |
| failed | The payments object transitions to a failed state when the payment processor confirms the processing failure. |
| expired | You can expire the payments object while it is in any state except when it is under ‘processing’ or ‘succeeded’ state. |
<img src="assets/images/image.png" />

21
api-reference-v2/logo/dark.svg
View File

@ -1,21 +0,0 @@
<svg width="545" height="58" viewBox="0 0 545 58" fill="none" xmlns="http://www.w3.org/2000/svg">
<path fill-rule="evenodd" clip-rule="evenodd" d="M27.2375 54.3079C25.9366 54.3441 24.6718 54.2355 23.3708 54.0545C19.8655 53.5477 16.577 52.4255 13.5414 50.5792C6.81987 46.5246 2.51952 40.6238 0.748782 32.8766C0.35127 31.139 0.170583 29.3651 0.170583 27.5912C0.134446 20.4957 2.44724 14.2691 7.1451 8.98363C11.2286 4.42224 16.2879 1.63472 22.2505 0.476271C23.9129 0.150457 25.5752 -0.0305508 27.2375 0.0418522C27.2375 2.75697 27.2375 5.43588 27.2375 8.15099C27.1652 8.18719 27.093 8.2234 27.0207 8.2958C26.045 8.98363 25.0693 9.70766 24.1297 10.4679C21.9976 12.2056 19.9739 14.0518 18.2754 16.2601C15.9988 19.1925 14.481 22.4144 14.2642 26.2156C14.1558 28.0256 14.3726 29.7995 14.9508 31.501C16.3601 35.7366 20.7328 40.1169 26.8761 40.2255C27.2375 40.2255 27.3098 40.298 27.3098 40.6962C27.2736 42.5424 27.2736 46.235 27.2736 46.235C27.2736 46.235 27.2736 46.4522 27.2736 46.5608C27.2375 49.1311 27.2375 51.7014 27.2375 54.3079Z" fill="#0099FF"/>
<path fill-rule="evenodd" clip-rule="evenodd" d="M27.2368 8.11469C27.2368 8.11469 27.2368 2.72066 27.2368 0.00554404C28.7184 -0.0306575 30.1639 0.114149 31.6094 0.331358C34.3197 0.765776 36.9216 1.56221 39.379 2.82926C44.4743 5.47197 48.4856 9.23693 51.1959 14.3775C52.7498 17.3461 53.7617 20.4956 54.1592 23.7899C54.6289 27.6635 54.2676 31.5009 53.1112 35.2296C51.7741 39.4652 49.5336 43.194 46.3896 46.3435C42.5591 50.1447 38.0057 52.6064 32.7297 53.7286C30.9228 54.0906 29.0798 54.3078 27.2368 54.2716C27.2368 51.6651 27.2368 49.0948 27.2368 46.4883C27.2368 46.3797 27.2368 46.1987 27.2368 46.1987C27.2368 46.1987 27.3452 46.1263 27.3813 46.0901C30.2001 44.099 32.8742 41.9269 35.187 39.3204C36.7048 37.6189 38.0057 35.8088 38.9092 33.7092C40.174 30.7406 40.6799 27.6997 40.0294 24.4778C38.873 18.6131 33.6331 14.2327 27.5982 14.0879C27.2007 14.0879 27.2368 13.7621 27.2368 13.7621V8.11469Z" fill="#0561E2"/>
<path d="M89.2508 35.5966C89.2508 37.0921 89.0055 38.5164 88.55 39.9051C88.0944 41.2937 87.3586 42.5044 86.4475 43.5726C85.5013 44.6408 84.3449 45.4598 82.9432 46.1007C81.5415 46.7061 79.8945 47.0265 78.0723 47.0265C75.1288 47.0265 72.7109 46.3144 70.8536 44.9257C68.9614 43.537 67.7349 41.3293 67.1392 38.3027L73.3416 36.8072C73.5519 38.0535 74.0425 39.0505 74.8485 39.7982C75.6194 40.546 76.6006 40.9021 77.757 40.9021C79.6492 40.9021 80.9458 40.2611 81.6116 38.9437C82.2774 37.6618 82.6278 35.8458 82.6278 33.5669V8.25005H89.2508V35.5966Z" fill="white"/>
<path d="M125.764 32.1782C125.764 34.4571 125.378 36.5223 124.607 38.3383C123.836 40.1899 122.785 41.721 121.453 43.0029C120.122 44.2848 118.545 45.2818 116.723 45.9583C114.901 46.6705 112.903 46.9909 110.766 46.9909C108.628 46.9909 106.631 46.6349 104.843 45.9583C103.021 45.2818 101.444 44.2848 100.078 43.0029C98.711 41.721 97.6597 40.1543 96.9238 38.3383C96.1529 36.5223 95.8025 34.4571 95.8025 32.1782V8.25005H102.425V31.9646C102.425 32.8904 102.566 33.8518 102.846 34.8844C103.126 35.8814 103.582 36.8428 104.248 37.6974C104.878 38.552 105.754 39.2641 106.841 39.7982C107.892 40.3679 109.224 40.6172 110.801 40.6172C112.377 40.6172 113.709 40.3323 114.76 39.7982C115.812 39.2641 116.688 38.552 117.353 37.6974C117.984 36.8428 118.475 35.917 118.755 34.8844C119.036 33.8518 119.176 32.8904 119.176 31.9646V8.25005H125.799V32.1782H125.764Z" fill="white"/>
<path d="M150.854 16.3685C150.153 15.3358 149.207 14.5881 148.051 14.0896C146.859 13.5911 145.633 13.3774 144.336 13.3774C143.565 13.3774 142.83 13.4843 142.094 13.6623C141.358 13.8403 140.727 14.1252 140.166 14.5169C139.571 14.9086 139.115 15.4071 138.765 16.048C138.414 16.6889 138.239 17.4011 138.239 18.2557C138.239 19.5375 138.66 20.5345 139.571 21.1755C140.447 21.852 141.533 22.4573 142.83 22.9202C144.126 23.4187 145.528 23.9172 147.07 24.3801C148.612 24.843 150.013 25.484 151.345 26.3029C152.641 27.1219 153.728 28.2257 154.604 29.5432C155.48 30.8963 155.935 32.7123 155.935 34.9199C155.935 36.9496 155.585 38.7299 154.849 40.2254C154.113 41.7566 153.132 43.0028 151.871 43.9998C150.609 44.9968 149.172 45.7446 147.525 46.2431C145.878 46.7416 144.126 46.9908 142.339 46.9908C140.026 46.9908 137.784 46.5992 135.681 45.8158C133.543 45.0324 131.686 43.715 130.144 41.8634L135.155 36.9496C135.961 38.1958 137.013 39.1572 138.344 39.8694C139.676 40.5815 141.042 40.902 142.514 40.902C143.285 40.902 144.056 40.7952 144.827 40.5815C145.598 40.3679 146.299 40.0474 146.93 39.6201C147.56 39.1928 148.051 38.6587 148.436 37.9822C148.822 37.3412 149.032 36.5579 149.032 35.7033C149.032 34.3146 148.577 33.2464 147.7 32.4986C146.824 31.7509 145.738 31.1099 144.442 30.6114C143.145 30.1129 141.708 29.6144 140.166 29.1515C138.625 28.6886 137.188 28.0477 135.926 27.2643C134.63 26.481 133.543 25.4127 132.667 24.0597C131.791 22.7066 131.336 20.9262 131.336 18.6829C131.336 16.7245 131.721 15.051 132.527 13.6267C133.298 12.2024 134.349 11.0273 135.646 10.0659C136.907 9.14016 138.379 8.42801 140.026 7.96511C141.673 7.50222 143.355 7.28857 145.072 7.28857C147.035 7.28857 148.927 7.60904 150.784 8.17876C152.606 8.78408 154.288 9.78109 155.76 11.1698L150.854 16.3685Z" fill="white"/>
<path d="M173.983 8.25005C175.77 8.25005 177.487 8.42809 179.169 8.78416C180.816 9.14024 182.288 9.74556 183.549 10.5645C184.811 11.4191 185.827 12.5229 186.563 13.9116C187.299 15.3359 187.684 17.0807 187.684 19.1815C187.684 21.5672 187.264 23.49 186.458 24.9499C185.652 26.4098 184.566 27.5493 183.199 28.3326C181.832 29.116 180.255 29.6857 178.433 29.9706C176.611 30.2554 174.754 30.3979 172.791 30.3979H168.061V46.0651H161.438V8.25005H173.983ZM172.091 24.6651C173.037 24.6651 174.018 24.6295 175.034 24.5583C176.05 24.487 176.997 24.2734 177.838 23.9173C178.679 23.5612 179.379 23.0271 179.94 22.315C180.466 21.6028 180.746 20.6058 180.746 19.324C180.746 18.1489 180.501 17.2231 180.01 16.511C179.52 15.7988 178.889 15.2647 178.118 14.9086C177.347 14.517 176.471 14.3033 175.525 14.1965C174.579 14.0897 173.668 14.0185 172.791 14.0185H168.061V24.6651H172.091Z" fill="white"/>
<path d="M200.404 8.25005H206.116L222.166 46.0651H214.596L211.127 37.4125H195.008L191.644 46.0651H184.215L200.404 8.25005ZM208.814 31.6441L203.068 16.2617L197.251 31.6441H208.814Z" fill="white"/>
<path d="M230.225 29.8994L216.243 8.25005H224.548L233.694 23.312L242.945 8.25005H250.83L236.848 29.8994V46.1007H230.225V29.8994Z" fill="white"/>
<path d="M266.826 46.6572V8.06836H271.566V24.5336L270.7 24.0748C271.379 22.3417 272.467 20.9993 273.962 20.0477C275.492 19.0622 277.276 18.5694 279.315 18.5694C281.286 18.5694 283.036 19.0112 284.565 19.8948C286.129 20.7784 287.352 22.0018 288.236 23.5651C289.153 25.1283 289.612 26.8955 289.612 28.8666V46.6572H284.82V30.3959C284.82 28.8666 284.531 27.5752 283.954 26.5217C283.41 25.4682 282.645 24.6526 281.66 24.0748C280.674 23.4631 279.536 23.1573 278.244 23.1573C276.987 23.1573 275.848 23.4631 274.829 24.0748C273.809 24.6526 273.011 25.4852 272.433 26.5727C271.855 27.6262 271.566 28.9006 271.566 30.3959V46.6572H266.826Z" fill="#B1B0B6"/>
<path d="M295.847 57.872C295.235 57.872 294.624 57.821 294.012 57.719C293.4 57.6171 292.822 57.4472 292.279 57.2093V52.9783C292.652 53.0462 293.111 53.1142 293.655 53.1822C294.233 53.2841 294.793 53.3351 295.337 53.3351C296.934 53.3351 298.141 52.9783 298.956 52.2646C299.806 51.5849 300.605 50.3955 301.352 48.6963L303.086 44.5672L302.984 48.6963L291.259 19.1811H296.408L305.532 42.6301H304.003L313.077 19.1811H318.327L305.94 49.9197C305.362 51.381 304.615 52.7064 303.697 53.8958C302.814 55.1193 301.726 56.0878 300.435 56.8015C299.143 57.5151 297.614 57.872 295.847 57.872Z" fill="#B1B0B6"/>
<path d="M321.016 56.8525V19.1811H325.654V25.0944L325.043 23.9219C326.062 22.2907 327.456 20.9993 329.223 20.0477C330.99 19.0622 333.012 18.5694 335.289 18.5694C337.872 18.5694 340.183 19.1981 342.222 20.4555C344.295 21.713 345.926 23.4291 347.115 25.6041C348.305 27.7451 348.899 30.192 348.899 32.9447C348.899 35.6294 348.305 38.0593 347.115 40.2343C345.926 42.4092 344.295 44.1254 342.222 45.3828C340.183 46.6402 337.855 47.269 335.238 47.269C333.029 47.269 331.007 46.7762 329.172 45.7906C327.371 44.8051 325.977 43.4118 324.992 41.6106L325.756 40.795V56.8525H321.016ZM334.881 42.6811C336.614 42.6811 338.161 42.2563 339.52 41.4067C340.879 40.5571 341.933 39.4016 342.68 37.9403C343.462 36.445 343.853 34.7798 343.853 32.9447C343.853 31.0416 343.462 29.3764 342.68 27.949C341.933 26.4877 340.879 25.3323 339.52 24.4827C338.161 23.5991 336.614 23.1573 334.881 23.1573C333.148 23.1573 331.585 23.5821 330.191 24.4317C328.832 25.2813 327.744 26.4537 326.929 27.949C326.147 29.4103 325.756 31.0756 325.756 32.9447C325.756 34.7798 326.147 36.445 326.929 37.9403C327.744 39.4016 328.832 40.5571 330.191 41.4067C331.585 42.2563 333.148 42.6811 334.881 42.6811Z" fill="#B1B0B6"/>
<path d="M366.229 47.269C363.578 47.269 361.216 46.6402 359.143 45.3828C357.07 44.1254 355.439 42.4092 354.249 40.2343C353.06 38.0253 352.465 35.5614 352.465 32.8427C352.465 30.09 353.043 27.6432 354.198 25.5022C355.388 23.3612 356.985 21.679 358.99 20.4555C361.029 19.1981 363.306 18.5694 365.821 18.5694C367.86 18.5694 369.661 18.9433 371.224 19.6909C372.821 20.4046 374.164 21.3901 375.251 22.6475C376.373 23.8709 377.222 25.2813 377.8 26.8785C378.412 28.4418 378.718 30.073 378.718 31.7722C378.718 32.1461 378.684 32.5709 378.616 33.0466C378.582 33.4884 378.531 33.9132 378.463 34.321H355.931V30.2429H375.71L373.467 32.0781C373.773 30.3109 373.603 28.7307 372.957 27.3373C372.312 25.944 371.36 24.8395 370.103 24.0239C368.845 23.2082 367.418 22.8004 365.821 22.8004C364.223 22.8004 362.762 23.2082 361.437 24.0239C360.111 24.8395 359.075 26.0119 358.327 27.5412C357.614 29.0365 357.325 30.8207 357.461 32.8937C357.325 34.8988 357.631 36.6659 358.378 38.1952C359.16 39.6905 360.247 40.863 361.641 41.7126C363.068 42.5282 364.614 42.936 366.28 42.936C368.115 42.936 369.661 42.5112 370.918 41.6616C372.176 40.812 373.195 39.7245 373.977 38.3991L377.953 40.4382C377.409 41.6956 376.56 42.851 375.404 43.9045C374.283 44.924 372.94 45.7397 371.377 46.3514C369.848 46.9631 368.132 47.269 366.229 47.269Z" fill="#B1B0B6"/>
<path d="M383.37 46.6572V19.1811H388.008V24.2278L387.499 23.5141C388.144 21.9508 389.13 20.7954 390.455 20.0477C391.781 19.2661 393.395 18.8753 395.298 18.8753H396.98V23.3612H394.584C392.647 23.3612 391.084 23.9729 389.895 25.1963C388.705 26.3858 388.11 28.085 388.11 30.2939V46.6572H383.37Z" fill="#B1B0B6"/>
<path d="M409.5 47.269C406.748 47.269 404.352 46.5893 402.313 45.2299C400.274 43.8705 398.829 42.0354 397.98 39.7245L401.752 37.8894C402.534 39.5206 403.604 40.812 404.964 41.7635C406.323 42.7151 407.835 43.1909 409.5 43.1909C410.996 43.1909 412.236 42.834 413.222 42.1204C414.207 41.4067 414.7 40.4721 414.7 39.3167C414.7 38.5011 414.462 37.8554 413.986 37.3796C413.545 36.8698 413.001 36.479 412.355 36.2071C411.709 35.9013 411.115 35.6804 410.571 35.5445L406.442 34.372C403.961 33.6583 402.143 32.6388 400.987 31.3134C399.866 29.9881 399.305 28.4418 399.305 26.6746C399.305 25.0434 399.713 23.633 400.529 22.4436C401.378 21.2202 402.517 20.2686 403.944 19.5889C405.405 18.9093 407.037 18.5694 408.838 18.5694C411.251 18.5694 413.409 19.1811 415.312 20.4046C417.249 21.628 418.625 23.3442 419.441 25.5531L415.567 27.3373C414.955 25.91 414.037 24.7885 412.814 23.9729C411.59 23.1233 410.214 22.6985 408.685 22.6985C407.291 22.6985 406.187 23.0553 405.371 23.769C404.556 24.4487 404.148 25.3153 404.148 26.3688C404.148 27.1504 404.352 27.7961 404.76 28.3059C405.167 28.7816 405.66 29.1555 406.238 29.4273C406.816 29.6652 407.376 29.8691 407.92 30.039L412.406 31.3644C414.649 32.0101 416.382 33.0126 417.606 34.372C418.863 35.7314 419.492 37.3626 419.492 39.2657C419.492 40.795 419.067 42.1713 418.217 43.3948C417.368 44.6182 416.195 45.5697 414.7 46.2494C413.205 46.9291 411.472 47.269 409.5 47.269Z" fill="#B1B0B6"/>
<path d="M429.992 46.6572L420.561 19.1811H425.812L433.305 42.1713L431.47 42.1204L438.81 19.1811H443.296L450.637 42.1204L448.802 42.1713L456.346 19.1811H461.546L452.115 46.6572H447.578L440.34 23.718H441.767L434.528 46.6572H429.992Z" fill="#B1B0B6"/>
<path d="M464.256 46.6572V19.1811H468.997V46.6572H464.256ZM464.256 14.7972V8.68007H468.997V14.7972H464.256Z" fill="#B1B0B6"/>
<path d="M485.988 46.9631C483.303 46.9631 481.23 46.1985 479.769 44.6692C478.341 43.1399 477.628 40.9819 477.628 38.1952V23.718H472.632V19.1811H473.651C474.875 19.1811 475.843 18.8073 476.557 18.0597C477.271 17.312 477.628 16.3265 477.628 15.1031V12.8601H482.368V19.1811H488.536V23.718H482.368V38.0423C482.368 38.9599 482.504 39.7585 482.776 40.4382C483.082 41.1178 483.575 41.6616 484.254 42.0694C484.934 42.4432 485.835 42.6301 486.956 42.6301C487.194 42.6301 487.483 42.6131 487.823 42.5792C488.197 42.5452 488.536 42.5112 488.842 42.4772V46.6572C488.401 46.7592 487.908 46.8272 487.364 46.8611C486.82 46.9291 486.361 46.9631 485.988 46.9631Z" fill="#B1B0B6"/>
<path d="M505.503 47.269C502.818 47.269 500.422 46.6402 498.315 45.3828C496.242 44.1254 494.611 42.4092 493.422 40.2343C492.232 38.0593 491.638 35.6124 491.638 32.8937C491.638 30.141 492.232 27.6941 493.422 25.5531C494.611 23.4122 496.242 21.713 498.315 20.4555C500.422 19.1981 502.818 18.5694 505.503 18.5694C507.304 18.5694 508.986 18.8923 510.55 19.538C512.113 20.1837 513.489 21.0503 514.679 22.1378C515.868 23.2252 516.735 24.4996 517.279 25.961L513.048 28C512.402 26.5727 511.416 25.4172 510.091 24.5336C508.766 23.6161 507.236 23.1573 505.503 23.1573C503.838 23.1573 502.326 23.5821 500.966 24.4317C499.641 25.2813 498.587 26.4367 497.806 27.898C497.024 29.3594 496.633 31.0416 496.633 32.9447C496.633 34.7798 497.024 36.445 497.806 37.9403C498.587 39.4016 499.641 40.5571 500.966 41.4067C502.326 42.2563 503.838 42.6811 505.503 42.6811C507.236 42.6811 508.766 42.2393 510.091 41.3557C511.416 40.4382 512.402 39.2317 513.048 37.7364L517.279 39.8774C516.735 41.3048 515.868 42.5792 514.679 43.7006C513.489 44.7881 512.113 45.6547 510.55 46.3004C508.986 46.9461 507.304 47.269 505.503 47.269Z" fill="#B1B0B6"/>
<path d="M521.945 46.6572V8.06836H526.686V24.5336L525.819 24.0748C526.499 22.3417 527.586 20.9993 529.082 20.0477C530.611 19.0622 532.395 18.5694 534.434 18.5694C536.405 18.5694 538.155 19.0112 539.685 19.8948C541.248 20.7784 542.471 22.0018 543.355 23.5651C544.272 25.1283 544.731 26.8955 544.731 28.8666V46.6572H539.939V30.3959C539.939 28.8666 539.651 27.5752 539.073 26.5217C538.529 25.4682 537.764 24.6526 536.779 24.0748C535.793 23.4631 534.655 23.1573 533.363 23.1573C532.106 23.1573 530.968 23.4631 529.948 24.0748C528.929 24.6526 528.13 25.4852 527.552 26.5727C526.975 27.6262 526.686 28.9006 526.686 30.3959V46.6572H521.945Z" fill="#B1B0B6"/>
</svg>
Side by Side

Before

Width:  |  Height:  |  Size: 14 KiB

21
api-reference-v2/logo/light.svg
View File

@ -1,21 +0,0 @@
<svg width="545" height="58" viewBox="0 0 545 58" fill="none" xmlns="http://www.w3.org/2000/svg">
<path fill-rule="evenodd" clip-rule="evenodd" d="M27.0673 54.3079C25.7664 54.3441 24.5016 54.2355 23.2006 54.0545C19.6953 53.5477 16.4068 52.4255 13.3713 50.5792C6.6497 46.5246 2.34935 40.6238 0.578616 32.8766C0.181104 31.139 0.000416954 29.3651 0.000416954 27.5912C-0.0357205 20.4957 2.27707 14.2691 6.97494 8.98363C11.0585 4.42224 16.1177 1.63472 22.0804 0.476271C23.7427 0.150457 25.405 -0.0305508 27.0673 0.0418522C27.0673 2.75697 27.0673 5.43588 27.0673 8.15099C26.9951 8.18719 26.9228 8.2234 26.8505 8.2958C25.8748 8.98363 24.8991 9.70766 23.9595 10.4679C21.8274 12.2056 19.8037 14.0518 18.1053 16.2601C15.8286 19.1925 14.3108 22.4144 14.094 26.2156C13.9856 28.0256 14.2024 29.7995 14.7806 31.501C16.19 35.7366 20.5626 40.1169 26.706 40.2255C27.0673 40.2255 27.1396 40.298 27.1396 40.6962C27.1035 42.5424 27.1035 46.235 27.1035 46.235C27.1035 46.235 27.1035 46.4522 27.1035 46.5608C27.0673 49.1311 27.0673 51.7014 27.0673 54.3079Z" fill="#0099FF"/>
<path fill-rule="evenodd" clip-rule="evenodd" d="M27.0666 8.11469C27.0666 8.11469 27.0666 2.72066 27.0666 0.00554404C28.5483 -0.0306575 29.9938 0.114149 31.4393 0.331358C34.1496 0.765776 36.7515 1.56221 39.2088 2.82926C44.3042 5.47197 48.3154 9.23693 51.0257 14.3775C52.5796 17.3461 53.5915 20.4956 53.989 23.7899C54.4588 27.6635 54.0974 31.5009 52.941 35.2296C51.6039 39.4652 49.3634 43.194 46.2195 46.3435C42.3889 50.1447 37.8356 52.6064 32.5595 53.7286C30.7526 54.0906 28.9096 54.3078 27.0666 54.2716C27.0666 51.6651 27.0666 49.0948 27.0666 46.4883C27.0666 46.3797 27.0666 46.1987 27.0666 46.1987C27.0666 46.1987 27.175 46.1263 27.2112 46.0901C30.0299 44.099 32.7041 41.9269 35.0169 39.3204C36.5346 37.6189 37.8356 35.8088 38.739 33.7092C40.0038 30.7406 40.5097 27.6997 39.8593 24.4778C38.7029 18.6131 33.463 14.2327 27.428 14.0879C27.0305 14.0879 27.0666 13.7621 27.0666 13.7621V8.11469Z" fill="#0561E2"/>
<path d="M89.0807 35.5966C89.0807 37.0921 88.8354 38.5164 88.3798 39.9051C87.9243 41.2937 87.1884 42.5044 86.2773 43.5726C85.3311 44.6408 84.1748 45.4598 82.7731 46.1007C81.3714 46.7061 79.7244 47.0265 77.9022 47.0265C74.9586 47.0265 72.5407 46.3144 70.6835 44.9257C68.7912 43.537 67.5647 41.3293 66.969 38.3027L73.1715 36.8072C73.3817 38.0535 73.8723 39.0505 74.6783 39.7982C75.4492 40.546 76.4304 40.9021 77.5868 40.9021C79.4791 40.9021 80.7757 40.2611 81.4415 38.9437C82.1073 37.6618 82.4577 35.8458 82.4577 33.5669V8.25005H89.0807V35.5966Z" fill="#1C1C1C"/>
<path d="M125.593 32.1782C125.593 34.4571 125.208 36.5223 124.437 38.3383C123.666 40.1899 122.615 41.721 121.283 43.0029C119.952 44.2848 118.375 45.2818 116.553 45.9583C114.73 46.6705 112.733 46.9909 110.595 46.9909C108.458 46.9909 106.46 46.6349 104.673 45.9583C102.851 45.2818 101.274 44.2848 99.9075 43.0029C98.5408 41.721 97.4895 40.1543 96.7536 38.3383C95.9827 36.5223 95.6323 34.4571 95.6323 32.1782V8.25005H102.255V31.9646C102.255 32.8904 102.395 33.8518 102.676 34.8844C102.956 35.8814 103.412 36.8428 104.077 37.6974C104.708 38.552 105.584 39.2641 106.671 39.7982C107.722 40.3679 109.053 40.6172 110.63 40.6172C112.207 40.6172 113.539 40.3323 114.59 39.7982C115.641 39.2641 116.518 38.552 117.183 37.6974C117.814 36.8428 118.305 35.917 118.585 34.8844C118.865 33.8518 119.006 32.8904 119.006 31.9646V8.25005H125.629V32.1782H125.593Z" fill="#1C1C1C"/>
<path d="M150.684 16.3685C149.983 15.3358 149.037 14.5881 147.881 14.0896C146.689 13.5911 145.463 13.3774 144.166 13.3774C143.395 13.3774 142.659 13.4843 141.924 13.6623C141.188 13.8403 140.557 14.1252 139.996 14.5169C139.4 14.9086 138.945 15.4071 138.595 16.048C138.244 16.6889 138.069 17.4011 138.069 18.2557C138.069 19.5375 138.489 20.5345 139.4 21.1755C140.277 21.852 141.363 22.4573 142.659 22.9202C143.956 23.4187 145.358 23.9172 146.9 24.3801C148.441 24.843 149.843 25.484 151.175 26.3029C152.471 27.1219 153.558 28.2257 154.434 29.5432C155.31 30.8963 155.765 32.7123 155.765 34.9199C155.765 36.9496 155.415 38.7299 154.679 40.2254C153.943 41.7566 152.962 43.0028 151.7 43.9998C150.439 44.9968 149.002 45.7446 147.355 46.2431C145.708 46.7416 143.956 46.9908 142.169 46.9908C139.856 46.9908 137.613 46.5992 135.511 45.8158C133.373 45.0324 131.516 43.715 129.974 41.8634L134.985 36.9496C135.791 38.1958 136.842 39.1572 138.174 39.8694C139.506 40.5815 140.872 40.902 142.344 40.902C143.115 40.902 143.886 40.7952 144.657 40.5815C145.428 40.3679 146.129 40.0474 146.759 39.6201C147.39 39.1928 147.881 38.6587 148.266 37.9822C148.652 37.3412 148.862 36.5579 148.862 35.7033C148.862 34.3146 148.406 33.2464 147.53 32.4986C146.654 31.7509 145.568 31.1099 144.271 30.6114C142.975 30.1129 141.538 29.6144 139.996 29.1515C138.454 28.6886 137.018 28.0477 135.756 27.2643C134.46 26.481 133.373 25.4127 132.497 24.0597C131.621 22.7066 131.166 20.9262 131.166 18.6829C131.166 16.7245 131.551 15.051 132.357 13.6267C133.128 12.2024 134.179 11.0273 135.476 10.0659C136.737 9.14016 138.209 8.42801 139.856 7.96511C141.503 7.50222 143.185 7.28857 144.902 7.28857C146.865 7.28857 148.757 7.60904 150.614 8.17876C152.436 8.78408 154.118 9.78109 155.59 11.1698L150.684 16.3685Z" fill="#1C1C1C"/>
<path d="M173.813 8.25005C175.6 8.25005 177.317 8.42809 178.999 8.78416C180.646 9.14024 182.118 9.74556 183.379 10.5645C184.641 11.4191 185.657 12.5229 186.393 13.9116C187.129 15.3359 187.514 17.0807 187.514 19.1815C187.514 21.5672 187.094 23.49 186.288 24.9499C185.482 26.4098 184.396 27.5493 183.029 28.3326C181.662 29.116 180.085 29.6857 178.263 29.9706C176.441 30.2554 174.584 30.3979 172.621 30.3979H167.891V46.0651H161.268V8.25005H173.813ZM171.92 24.6651C172.867 24.6651 173.848 24.6295 174.864 24.5583C175.88 24.487 176.826 24.2734 177.667 23.9173C178.508 23.5612 179.209 23.0271 179.77 22.315C180.296 21.6028 180.576 20.6058 180.576 19.324C180.576 18.1489 180.331 17.2231 179.84 16.511C179.349 15.7988 178.719 15.2647 177.948 14.9086C177.177 14.517 176.301 14.3033 175.355 14.1965C174.408 14.0897 173.497 14.0185 172.621 14.0185H167.891V24.6651H171.92Z" fill="#1C1C1C"/>
<path d="M200.234 8.25005H205.946L221.995 46.0651H214.426L210.957 37.4125H194.838L191.474 46.0651H184.045L200.234 8.25005ZM208.644 31.6441L202.897 16.2617L197.08 31.6441H208.644Z" fill="#1C1C1C"/>
<path d="M230.055 29.8994L216.073 8.25005H224.378L233.524 23.312L242.775 8.25005H250.66L236.678 29.8994V46.1007H230.055V29.8994Z" fill="#1C1C1C"/>
<path d="M266.655 46.6572V8.06836H271.396V24.5336L270.53 24.0748C271.209 22.3417 272.297 20.9993 273.792 20.0477C275.321 19.0622 277.106 18.5694 279.145 18.5694C281.116 18.5694 282.866 19.0112 284.395 19.8948C285.958 20.7784 287.182 22.0018 288.065 23.5651C288.983 25.1283 289.442 26.8955 289.442 28.8666V46.6572H284.65V30.3959C284.65 28.8666 284.361 27.5752 283.783 26.5217C283.24 25.4682 282.475 24.6526 281.489 24.0748C280.504 23.4631 279.365 23.1573 278.074 23.1573C276.817 23.1573 275.678 23.4631 274.659 24.0748C273.639 24.6526 272.841 25.4852 272.263 26.5727C271.685 27.6262 271.396 28.9006 271.396 30.3959V46.6572H266.655Z" fill="#7D7B86"/>
<path d="M295.677 57.872C295.065 57.872 294.453 57.821 293.842 57.719C293.23 57.6171 292.652 57.4472 292.108 57.2093V52.9783C292.482 53.0462 292.941 53.1142 293.485 53.1822C294.063 53.2841 294.623 53.3351 295.167 53.3351C296.764 53.3351 297.971 52.9783 298.786 52.2646C299.636 51.5849 300.435 50.3955 301.182 48.6963L302.915 44.5672L302.813 48.6963L291.089 19.1811H296.237L305.362 42.6301H303.833L312.907 19.1811H318.157L305.77 49.9197C305.192 51.381 304.445 52.7064 303.527 53.8958C302.643 55.1193 301.556 56.0878 300.265 56.8015C298.973 57.5151 297.444 57.872 295.677 57.872Z" fill="#7D7B86"/>
<path d="M320.845 56.8525V19.1811H325.484V25.0944L324.873 23.9219C325.892 22.2907 327.285 20.9993 329.053 20.0477C330.82 19.0622 332.842 18.5694 335.119 18.5694C337.701 18.5694 340.012 19.1981 342.051 20.4555C344.124 21.713 345.756 23.4291 346.945 25.6041C348.135 27.7451 348.729 30.192 348.729 32.9447C348.729 35.6294 348.135 38.0593 346.945 40.2343C345.756 42.4092 344.124 44.1254 342.051 45.3828C340.012 46.6402 337.684 47.269 335.068 47.269C332.859 47.269 330.837 46.7762 329.002 45.7906C327.2 44.8051 325.807 43.4118 324.822 41.6106L325.586 40.795V56.8525H320.845ZM334.711 42.6811C336.444 42.6811 337.99 42.2563 339.35 41.4067C340.709 40.5571 341.763 39.4016 342.51 37.9403C343.292 36.445 343.683 34.7798 343.683 32.9447C343.683 31.0416 343.292 29.3764 342.51 27.949C341.763 26.4877 340.709 25.3323 339.35 24.4827C337.99 23.5991 336.444 23.1573 334.711 23.1573C332.978 23.1573 331.414 23.5821 330.021 24.4317C328.662 25.2813 327.574 26.4537 326.759 27.949C325.977 29.4103 325.586 31.0756 325.586 32.9447C325.586 34.7798 325.977 36.445 326.759 37.9403C327.574 39.4016 328.662 40.5571 330.021 41.4067C331.414 42.2563 332.978 42.6811 334.711 42.6811Z" fill="#7D7B86"/>
<path d="M366.058 47.269C363.408 47.269 361.046 46.6402 358.973 45.3828C356.9 44.1254 355.268 42.4092 354.079 40.2343C352.89 38.0253 352.295 35.5614 352.295 32.8427C352.295 30.09 352.873 27.6432 354.028 25.5022C355.217 23.3612 356.815 21.679 358.82 20.4555C360.859 19.1981 363.136 18.5694 365.651 18.5694C367.69 18.5694 369.491 18.9433 371.054 19.6909C372.651 20.4046 373.994 21.3901 375.081 22.6475C376.203 23.8709 377.052 25.2813 377.63 26.8785C378.242 28.4418 378.548 30.073 378.548 31.7722C378.548 32.1461 378.514 32.5709 378.446 33.0466C378.412 33.4884 378.361 33.9132 378.293 34.321H355.761V30.2429H375.54L373.297 32.0781C373.603 30.3109 373.433 28.7307 372.787 27.3373C372.142 25.944 371.19 24.8395 369.933 24.0239C368.675 23.2082 367.248 22.8004 365.651 22.8004C364.053 22.8004 362.592 23.2082 361.267 24.0239C359.941 24.8395 358.905 26.0119 358.157 27.5412C357.443 29.0365 357.155 30.8207 357.29 32.8937C357.155 34.8988 357.46 36.6659 358.208 38.1952C358.99 39.6905 360.077 40.863 361.471 41.7126C362.898 42.5282 364.444 42.936 366.109 42.936C367.944 42.936 369.491 42.5112 370.748 41.6616C372.006 40.812 373.025 39.7245 373.807 38.3991L377.783 40.4382C377.239 41.6956 376.39 42.851 375.234 43.9045C374.113 44.924 372.77 45.7397 371.207 46.3514C369.678 46.9631 367.961 47.269 366.058 47.269Z" fill="#7D7B86"/>
<path d="M383.199 46.6572V19.1811H387.838V24.2278L387.329 23.5141C387.974 21.9508 388.96 20.7954 390.285 20.0477C391.611 19.2661 393.225 18.8753 395.128 18.8753H396.81V23.3612H394.414C392.477 23.3612 390.914 23.9729 389.724 25.1963C388.535 26.3858 387.94 28.085 387.94 30.2939V46.6572H383.199Z" fill="#7D7B86"/>
<path d="M409.33 47.269C406.578 47.269 404.182 46.5893 402.143 45.2299C400.104 43.8705 398.659 42.0354 397.81 39.7245L401.582 37.8894C402.364 39.5206 403.434 40.812 404.793 41.7635C406.153 42.7151 407.665 43.1909 409.33 43.1909C410.826 43.1909 412.066 42.834 413.052 42.1204C414.037 41.4067 414.53 40.4721 414.53 39.3167C414.53 38.5011 414.292 37.8554 413.816 37.3796C413.374 36.8698 412.831 36.479 412.185 36.2071C411.539 35.9013 410.945 35.6804 410.401 35.5445L406.272 34.372C403.791 33.6583 401.973 32.6388 400.817 31.3134C399.696 29.9881 399.135 28.4418 399.135 26.6746C399.135 25.0434 399.543 23.633 400.358 22.4436C401.208 21.2202 402.347 20.2686 403.774 19.5889C405.235 18.9093 406.866 18.5694 408.668 18.5694C411.08 18.5694 413.238 19.1811 415.142 20.4046C417.079 21.628 418.455 23.3442 419.271 25.5531L415.396 27.3373C414.785 25.91 413.867 24.7885 412.644 23.9729C411.42 23.1233 410.044 22.6985 408.515 22.6985C407.121 22.6985 406.017 23.0553 405.201 23.769C404.386 24.4487 403.978 25.3153 403.978 26.3688C403.978 27.1504 404.182 27.7961 404.59 28.3059C404.997 28.7816 405.49 29.1555 406.068 29.4273C406.646 29.6652 407.206 29.8691 407.75 30.039L412.236 31.3644C414.479 32.0101 416.212 33.0126 417.435 34.372C418.693 35.7314 419.322 37.3626 419.322 39.2657C419.322 40.795 418.897 42.1713 418.047 43.3948C417.198 44.6182 416.025 45.5697 414.53 46.2494C413.035 46.9291 411.301 47.269 409.33 47.269Z" fill="#7D7B86"/>
<path d="M429.821 46.6572L420.391 19.1811H425.641L433.135 42.1713L431.3 42.1204L438.64 19.1811H443.126L450.467 42.1204L448.632 42.1713L456.176 19.1811H461.376L451.945 46.6572H447.408L440.17 23.718H441.597L434.358 46.6572H429.821Z" fill="#7D7B86"/>
<path d="M464.086 46.6572V19.1811H468.827V46.6572H464.086ZM464.086 14.7972V8.68007H468.827V14.7972H464.086Z" fill="#7D7B86"/>
<path d="M485.817 46.9631C483.133 46.9631 481.06 46.1985 479.598 44.6692C478.171 43.1399 477.457 40.9819 477.457 38.1952V23.718H472.462V19.1811H473.481C474.705 19.1811 475.673 18.8073 476.387 18.0597C477.101 17.312 477.457 16.3265 477.457 15.1031V12.8601H482.198V19.1811H488.366V23.718H482.198V38.0423C482.198 38.9599 482.334 39.7585 482.606 40.4382C482.912 41.1178 483.405 41.6616 484.084 42.0694C484.764 42.4432 485.665 42.6301 486.786 42.6301C487.024 42.6301 487.313 42.6131 487.653 42.5792C488.026 42.5452 488.366 42.5112 488.672 42.4772V46.6572C488.23 46.7592 487.738 46.8272 487.194 46.8611C486.65 46.9291 486.191 46.9631 485.817 46.9631Z" fill="#7D7B86"/>
<path d="M505.333 47.269C502.648 47.269 500.252 46.6402 498.145 45.3828C496.072 44.1254 494.441 42.4092 493.252 40.2343C492.062 38.0593 491.467 35.6124 491.467 32.8937C491.467 30.141 492.062 27.6941 493.252 25.5531C494.441 23.4122 496.072 21.713 498.145 20.4555C500.252 19.1981 502.648 18.5694 505.333 18.5694C507.134 18.5694 508.816 18.8923 510.38 19.538C511.943 20.1837 513.319 21.0503 514.509 22.1378C515.698 23.2252 516.565 24.4996 517.108 25.961L512.877 28C512.232 26.5727 511.246 25.4172 509.921 24.5336C508.595 23.6161 507.066 23.1573 505.333 23.1573C503.668 23.1573 502.155 23.5821 500.796 24.4317C499.471 25.2813 498.417 26.4367 497.636 27.898C496.854 29.3594 496.463 31.0416 496.463 32.9447C496.463 34.7798 496.854 36.445 497.636 37.9403C498.417 39.4016 499.471 40.5571 500.796 41.4067C502.155 42.2563 503.668 42.6811 505.333 42.6811C507.066 42.6811 508.595 42.2393 509.921 41.3557C511.246 40.4382 512.232 39.2317 512.877 37.7364L517.108 39.8774C516.565 41.3048 515.698 42.5792 514.509 43.7006C513.319 44.7881 511.943 45.6547 510.38 46.3004C508.816 46.9461 507.134 47.269 505.333 47.269Z" fill="#7D7B86"/>
<path d="M521.775 46.6572V8.06836H526.515V24.5336L525.649 24.0748C526.329 22.3417 527.416 20.9993 528.911 20.0477C530.441 19.0622 532.225 18.5694 534.264 18.5694C536.235 18.5694 537.985 19.0112 539.514 19.8948C541.078 20.7784 542.301 22.0018 543.185 23.5651C544.102 25.1283 544.561 26.8955 544.561 28.8666V46.6572H539.769V30.3959C539.769 28.8666 539.48 27.5752 538.903 26.5217C538.359 25.4682 537.594 24.6526 536.609 24.0748C535.623 23.4631 534.485 23.1573 533.193 23.1573C531.936 23.1573 530.797 23.4631 529.778 24.0748C528.758 24.6526 527.96 25.4852 527.382 26.5727C526.804 27.6262 526.515 28.9006 526.515 30.3959V46.6572H521.775Z" fill="#7D7B86"/>
</svg>
Side by Side

Before

Width:  |  Height:  |  Size: 14 KiB

163
api-reference-v2/mint.json
View File

@ -1,163 +0,0 @@
{
"$schema": "https://mintlify.com/schema.json",
"name": "Hyperswitch",
"logo": {
"dark": "/logo/dark.svg",
"light": "/logo/light.svg"
},
"favicon": "/favicon.png",
"colors": {
"primary": "#006DF9",
"light": "#006DF9",
"dark": "#006DF9",
"background": {
"dark": "#242F48"
}
},
"tabs": [
{
"name": "API Reference",
"url": "api-reference"
}
],
"navigation": [
{
"group": "Get Started",
"pages": ["introduction"]
},
{
"group": "Essentials",
"pages": [
"essentials/error_codes",
"essentials/rate_limit",
"essentials/go-live"
]
},
{
"group": "Payments",
"pages": [
"api-reference/payments/payments--create-intent",
"api-reference/payments/payments--get-intent",
"api-reference/payments/payments--update-intent",
"api-reference/payments/payments--session-token",
"api-reference/payments/payments--payment-methods-list",
"api-reference/payments/payments--confirm-intent",
"api-reference/payments/payments--get",
"api-reference/payments/payments--create-and-confirm-intent",
"api-reference/payments/payments--list"
]
},
{
"group": "Payment Methods",
"pages": [
"api-reference/payment-methods/payment-method--create",
"api-reference/payment-methods/payment-method--create-intent",
"api-reference/payment-methods/payment-method--payment-methods-list",
"api-reference/payment-methods/payment-method--confirm-intent",
"api-reference/payment-methods/payment-method--update",
"api-reference/payment-methods/payment-method--retrieve",
"api-reference/payment-methods/payment-method--delete",
"api-reference/payment-methods/list-saved-payment-methods-for-a-customer"
]
},
{
"group": "Payment Method Session",
"pages": [
"api-reference/payment-method-session/payment-method-session--create",
"api-reference/payment-method-session/payment-method-session--retrieve",
"api-reference/payment-method-session/payment-method-session--list-payment-methods",
"api-reference/payment-method-session/payment-method-session--update-a-saved-payment-method",
"api-reference/payment-method-session/payment-method-session--confirm-a-payment-method-session",
"api-reference/payment-method-session/payment-method-session--delete-a-saved-payment-method"
]
},
{
"group": "Organization",
"pages": [
"api-reference/organization/organization--create",
"api-reference/organization/organization--retrieve",
"api-reference/organization/organization--update",
"api-reference/organization/organization--merchant-account--list"
]
},
{
"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/business-profile--list"
]
},
{
"group": "Profile",
"pages": [
"api-reference/profile/profile--create",
"api-reference/profile/profile--update",
"api-reference/profile/profile--activate-routing-algorithm",
"api-reference/profile/profile--update-default-fallback-routing-algorithm",
"api-reference/profile/profile--deactivate-routing-algorithm",
"api-reference/profile/profile--retrieve",
"api-reference/profile/merchant-connector--list",
"api-reference/profile/profile--retrieve-active-routing-algorithm",
"api-reference/profile/profile--retrieve-default-fallback-routing-algorithm"
]
},
{
"group": "Connector Account",
"pages": [
"api-reference/connector-account/connector-account--create",
"api-reference/connector-account/connector-account--retrieve",
"api-reference/connector-account/connector-account--update"
]
},
{
"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": "Routing",
"pages": [
"api-reference/routing/routing--create",
"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",
"api-reference/customers/customers--list-saved-payment-methods"
]
},
{
"group": "Refunds",
"pages": ["api-reference/refunds/refunds--create"]
},
{
"group": "Proxy",
"pages": ["api-reference/proxy/proxy"]
},
{
"group": "Tokenization",
"pages": ["api-reference/tokenization/tokenization--create"]
}
],
"footerSocials": {
"github": "https://github.com/juspay/hyperswitch",
"linkedin": "https://www.linkedin.com/company/hyperswitch"
},
"openapi": ["openapi_spec.json"],
"api": {
"maintainOrder": true
}
}

372
api-reference-v2/rust_locker_open_api_spec.yml
View File

@ -1,372 +0,0 @@
openapi: "3.0.2"
info:
title: Tartarus - OpenAPI 3.0
description: |-
This is the OpenAPI 3.0 specification for the card locker.
This is used by the [hyperswitch](https://github.com/juspay/hyperswitch) for storing card information securely.
version: "1.0"
tags:
- name: Key Custodian
description: API used to initialize the locker after deployment.
- name: Data
description: CRUD APIs for working with data to be stored in the locker
- name: Cards
description: CRUD APIs for working with cards data to be stored in the locker (deprecated)
paths:
/custodian/key1:
post:
tags:
- Key Custodian
summary: Provide Key 1
description: Provide the first key to unlock the locker
operationId: setKey1
requestBody:
description: Provide key 1 to unlock the locker
content:
application/json:
schema:
$ref: "#/components/schemas/Key"
required: true
responses:
"200":
description: Key 1 provided
content:
text/plain:
schema:
$ref: "#/components/schemas/Key1Set"
/custodian/key2:
post:
tags:
- Key Custodian
summary: Provide Key 2
description: Provide the second key to unlock the locker
operationId: setKey2
requestBody:
description: Provide key 2 to unlock the locker
content:
application/json:
schema:
$ref: "#/components/schemas/Key"
required: true
responses:
"200":
description: Key 2 provided
content:
text/plain:
schema:
$ref: "#/components/schemas/Key2Set"
/custodian/decrypt:
post:
tags:
- Key Custodian
summary: Unlock the locker
description: Unlock the locker with the key1 and key2 provided
responses:
"200":
description: Successfully Unlocked
content:
text/plain:
schema:
$ref: "#/components/schemas/Decrypt200"
/health:
get:
summary: Get Health
description: To check whether the application is up
responses:
"200":
description: Health is good
content:
text/plain:
schema:
$ref: "#/components/schemas/Health"
/data/add:
post:
tags:
- Cards
- Data
summary: Add Data in Locker
description: Add sensitive data in the locker
requestBody:
description: The request body might be JWE + JWS encrypted when using middleware
content:
application/json:
schema:
oneOf:
- $ref: "#/components/schemas/StoreDataReq"
- $ref: "#/components/schemas/JWEReq"
required: true
responses:
"200":
description: Store Data Response
content:
application/json:
schema:
oneOf:
- $ref: "#/components/schemas/StoreDataRes"
- $ref: "#/components/schemas/JWERes"
/data/delete:
post:
tags:
- Cards
- Data
summary: Delete Data from Locker
description: Delete sensitive data from the locker
requestBody:
description: The request body might be JWE + JWS encrypted when using middleware
content:
application/json:
schema:
oneOf:
- $ref: "#/components/schemas/DeleteDataReq"
- $ref: "#/components/schemas/JWEReq"
required: true
responses:
"200":
description: Delete Data Response
content:
application/json:
schema:
oneOf:
- $ref: "#/components/schemas/DeleteDataRes"
- $ref: "#/components/schemas/JWERes"
/data/retrieve:
post:
tags:
- Cards
- Data
summary: Retrieve Data from Locker
description: Retrieve sensitive data from the locker
requestBody:
description: The request body might be JWE + JWS encrypted when using middleware
content:
application/json:
schema:
oneOf:
- $ref: "#/components/schemas/RetrieveDataReq"
- $ref: "#/components/schemas/JWEReq"
required: true
responses:
"200":
description: Retrieve Data Response
content:
application/json:
schema:
oneOf:
- $ref: "#/components/schemas/RetrieveDataRes"
- $ref: "#/components/schemas/JWERes"
/data/fingerprint:
post:
tags:
- Cards
- Data
summary: Get or insert the card fingerprint
description: Get or insert the card fingerprint
requestBody:
description: Provide card number and hash key
content:
application/json:
schema:
$ref: "#/components/schemas/FingerprintReq"
required: true
responses:
"200":
description: Fingerprint Response
content:
application/json:
schema:
$ref: "#/components/schemas/FingerprintRes"
components:
schemas:
Key:
type: object
properties:
key:
type: string
example: 801bb63c1bd51820acbc8ac20c674675
required:
- key
StoreDataReq:
title: StoreDataReq
type: object
properties:
merchant_id:
type: string
example: m0100
merchant_customer_id:
type: string
example: HsCustomer1
requester_card_reference:
type: string
example: 3ffdf1e5-7f38-4f26-936f-c66a6f4296fa
card:
$ref: "#/components/schemas/Card"
enc_card_data:
type: string
example: "qwe4tyusdfg"
RetrieveDataReq:
title: RetrieveDataReq
type: object
properties:
merchant_id:
type: string
example: m0100
merchant_customer_id:
type: string
example: HsCustomer1
card_reference:
type: string
example: 3ffdf1e5-7f38-4f26-936f-c66a6f4296fa
DeleteDataReq:
title: DeleteDataReq
type: object
properties:
merchant_id:
type: string
example: m0100
merchant_customer_id:
type: string
example: HsCustomer1
card_reference:
type: string
example: 3ffdf1e5-7f38-4f26-936f-c66a6f4296fa
FingerprintReq:
type: object
properties:
card:
$ref: "#/components/schemas/FingerprintCardData"
hash_key:
type: string
example: Hash1
JWEReq:
title: JWEReq
type: object
properties:
header:
type: string
iv:
type: string
encrypted_payload:
type: string
tag:
type: string
encrypted_key:
type: string
RetrieveRes:
title: RetrieveRes
oneOf:
- type: object
properties:
card:
$ref: "#/components/schemas/Card"
- type: object
properties:
enc_card_data:
type: string
Card:
title: Card
type: object
required:
- card_number
properties:
card_number:
type: string
name_on_card:
type: string
card_exp_month:
type: string
card_exp_year:
type: string
card_brand:
type: string
card_isin:
type: string
nick_name:
type: string
FingerprintCardData:
type: object
properties:
card_number:
type: string
example: 4242424242424242
Key1Set:
title: Key1Set
type: string
# summary: Response after setting key1
description: Received Key1
example: Received Key1
Key2Set:
title: Key2Set
type: string
# description: Response after setting key2
description: Received Key2
example: Received Key2
Decrypt200:
title: Decrypt200
type: string
# description: Response if the locker key custodian decryption was successful
description: Decryption successful
example: Decryption successful
Health:
title: Health
type: string
# description: Response when the health is good
description: health is good
example: health is good
StoreDataRes:
title: StoreDataRes
type: object
description: Response received if the data was stored successfully
properties:
status:
type: string
enum: [Ok]
payload:
type: object
properties:
card_reference:
type: string
RetrieveDataRes:
title: RetrieveDataRes
type: object
description: Response received with the sensitive data, associated to the card reference
properties:
status:
type: string
enum: [Ok]
payload:
$ref: "#/components/schemas/RetrieveRes"
DeleteDataRes:
title: DeleteDataRes
type: object
description: Response received if the data deletion was successful
properties:
status:
type: string
enum: [Ok]
FingerprintRes:
type: object
description: Response received if the fingerprint insertion or retrieval was successful
properties:
status:
type: string
enum: [Ok]
payload:
type: object
properties:
fingerprint:
type: string
JWERes:
title: JWERes
type: object
description: JWE encrypted response equivalent
properties:
header:
type: string
iv:
type: string
encrypted_payload:
type: string
tag:
type: string
encrypted_key:
type: string

13
api-reference/README.md
View File

@ -1,6 +1,6 @@
# Api Reference
We use the [openapi specification](https://swagger.io/specification) for the api reference. The openapi file is generated from the code base [openapi_spec.json](openapi_spec.json).
We use the [openapi specification](https://swagger.io/specification) for the api reference. The openapi file is generated from the code base [openapi_spec_v1.json](v1/openapi_spec_v1.json).
## How to generate the file
@ -14,7 +14,7 @@ cargo r -p openapi --features v1
In order to render the openapi spec file, we use a tool called [mintlify](https://mintlify.com/). Local setup instructions can be found [here](https://mintlify.com/docs/development#development). Once the cli is installed, Run the following command to render the openapi spec
- Navigate to the directory where `mint.json` exists
- Navigate to the directory where `docs.json` exists
```bash
cd api-reference
@ -23,14 +23,14 @@ cd api-reference
- Run the cli
```bash
mintlify dev
mint dev
```
## Add new routes to openapi
If you have added new routes to the openapi. Then in order for them to be displayed on the mintlify, run the following commands
- Switch to the directory where api reference ( mint.json ) exists
- Switch to the directory where api reference ( docs.json ) exists
```bash
cd api-reference
@ -39,7 +39,10 @@ cd api-reference
- Run the following command to generate the route files
```bash
npx @mintlify/scraping@latest openapi-file openapi_spec.json -o api-reference
npx @mintlify/scraping@latest openapi-file v1/openapi_spec_v1.json -o v1
```
This will generate files in [api-reference](api-reference) folder. These routes should be added to the [mint.json](mint.json) file under navigation, under respective group.
NOTE: For working with V2 API reference, replace every occurence of `v1` with `v2` in above commands

3
api-reference/api-reference/customers/customers--create.mdx
View File

@ -1,3 +0,0 @@
---
openapi: openapi_spec post /customers
---

3
api-reference/api-reference/customers/customers--delete.mdx
View File

@ -1,3 +0,0 @@
---
openapi: openapi_spec delete /customers/{customer_id}
---

3
api-reference/api-reference/customers/customers--list.mdx
View File

@ -1,3 +0,0 @@
---
openapi: openapi_spec get /customers/list
---

3
api-reference/api-reference/customers/customers--retrieve.mdx
View File

@ -1,3 +0,0 @@
---
openapi: openapi_spec get /customers/{customer_id}
---

3
api-reference/api-reference/customers/customers--update.mdx
View File

@ -1,3 +0,0 @@
---
openapi: openapi_spec post /customers/{customer_id}
---

3
api-reference/api-reference/disputes/disputes--list.mdx
View File

@ -1,3 +0,0 @@
---
openapi: openapi_spec get /disputes/list
---

3
api-reference/api-reference/disputes/disputes--retrieve.mdx
View File

@ -1,3 +0,0 @@
---
openapi: openapi_spec get /disputes/{dispute_id}
---

3
api-reference/api-reference/gsm/gsm--create.mdx
View File

@ -1,3 +0,0 @@
---
openapi: openapi_spec post /gsm
---

3
api-reference/api-reference/gsm/gsm--delete.mdx
View File

@ -1,3 +0,0 @@
---
openapi: openapi_spec post /gsm/delete
---

3
api-reference/api-reference/gsm/gsm--get.mdx
View File

@ -1,3 +0,0 @@
---
openapi: openapi_spec post /gsm/get
---

3
api-reference/api-reference/gsm/gsm--update.mdx
View File

@ -1,3 +0,0 @@
---
openapi: openapi_spec post /gsm/update
---

3
api-reference/api-reference/mandates/mandates--retrieve-mandate.mdx
View File

@ -1,3 +0,0 @@
---
openapi: openapi_spec get /mandates/{mandate_id}
---

3
api-reference/api-reference/mandates/mandates--revoke-mandate.mdx
View File

@ -1,3 +0,0 @@
---
openapi: openapi_spec post /mandates/revoke/{mandate_id}
---

3
api-reference/api-reference/payment-methods/list-payment-methods-for-a-customer.mdx
View File

@ -1,3 +0,0 @@
---
openapi: openapi_spec get /customers/{customer_id}/payment_methods
---

3
api-reference/api-reference/payment-methods/list-payment-methods-for-a-merchant.mdx
View File

@ -1,3 +0,0 @@
---
openapi: openapi_spec get /account/payment_methods
---

3
api-reference/api-reference/payment-methods/payment-method--delete.mdx
View File

@ -1,3 +0,0 @@
---
openapi: openapi_spec delete /payment_methods/{method_id}
---

3
api-reference/api-reference/payment-methods/payment-method--retrieve.mdx
View File

@ -1,3 +0,0 @@
---
openapi: openapi_spec get /payment_methods/{method_id}
---

3
api-reference/api-reference/payment-methods/payment-method--update.mdx
View File

@ -1,3 +0,0 @@
---
openapi: openapi_spec post /payment_methods/{method_id}/update
---

3
api-reference/api-reference/payment-methods/paymentmethods--create.mdx
View File

@ -1,3 +0,0 @@
---
openapi: openapi_spec post /payment_methods
---

3
api-reference/api-reference/payments/payments--cancel.mdx
View File

@ -1,3 +0,0 @@
---
openapi: openapi_spec post /payments/{payment_id}/cancel
---

3
api-reference/api-reference/payments/payments--capture.mdx
View File

@ -1,3 +0,0 @@
---
openapi: openapi_spec post /payments/{payment_id}/capture
---

3
api-reference/api-reference/payments/payments--confirm.mdx
View File

@ -1,3 +0,0 @@
---
openapi: openapi_spec post /payments/{payment_id}/confirm
---

4
api-reference/api-reference/payments/payments--create.mdx
View File

@ -1,4 +0,0 @@
---
openapi: openapi_spec post /payments
---
<Tip> Use the dropdown on the top right corner of the code snippet to try out different payment scenarios. </Tip>

3
api-reference/api-reference/payments/payments--list.mdx
View File

@ -1,3 +0,0 @@
---
openapi: openapi_spec get /payments/list
---

3
api-reference/api-reference/payments/payments--retrieve.mdx
View File

@ -1,3 +0,0 @@
---
openapi: openapi_spec get /payments/{payment_id}
---

3
api-reference/api-reference/payments/payments--session-token.mdx
View File

@ -1,3 +0,0 @@
---
openapi: openapi_spec post /payments/session_tokens
---

3
api-reference/api-reference/payments/payments--update.mdx
View File

@ -1,3 +0,0 @@
---
openapi: openapi_spec post /payments/{payment_id}
---

3
api-reference/api-reference/payments/payments-link--retrieve.mdx
View File

@ -1,3 +0,0 @@
---
openapi: openapi_spec get /payment_link/{payment_link_id}
---

3
api-reference/api-reference/payouts/payouts--cancel.mdx
View File

@ -1,3 +0,0 @@
---
openapi: openapi_spec post /payouts/{payout_id}/cancel
---

3
api-reference/api-reference/payouts/payouts--confirm.mdx
View File

@ -1,3 +0,0 @@
---
openapi: openapi_spec post /payouts/{payout_id}/confirm
---

3
api-reference/api-reference/payouts/payouts--create.mdx
View File

@ -1,3 +0,0 @@
---
openapi: openapi_spec post /payouts/create
---

3
api-reference/api-reference/payouts/payouts--fulfill.mdx
View File

@ -1,3 +0,0 @@
---
openapi: openapi_spec post /payouts/{payout_id}/fulfill
---

3
api-reference/api-reference/payouts/payouts--retrieve.mdx
View File

@ -1,3 +0,0 @@
---
openapi: openapi_spec get /payouts/{payout_id}
---

3
api-reference/api-reference/payouts/payouts--update.mdx
View File

@ -1,3 +0,0 @@
---
openapi: openapi_spec post /payouts/{payout_id}
---

3
api-reference/api-reference/refunds/refunds--create.mdx
View File

@ -1,3 +0,0 @@
---
openapi: openapi_spec post /refunds
---

3
api-reference/api-reference/refunds/refunds--list.mdx
View File

@ -1,3 +0,0 @@
---
openapi: openapi_spec post /refunds/list
---

3
api-reference/api-reference/refunds/refunds--retrieve.mdx
View File

@ -1,3 +0,0 @@
---
openapi: openapi_spec get /refunds/{refund_id}
---

3
api-reference/api-reference/refunds/refunds--update.mdx
View File

@ -1,3 +0,0 @@
---
openapi: openapi_spec post /refunds/{refund_id}
---

3
api-reference/api-reference/relay/relay--retrieve.mdx
View File

@ -1,3 +0,0 @@
---
openapi: openapi_spec get /relay/{relay_id}
---

3
api-reference/api-reference/relay/relay.mdx
View File

@ -1,3 +0,0 @@
---
openapi: openapi_spec post /relay
---

534
api-reference/docs.json
View File

@ -12,222 +12,368 @@
"tabs": [
{
"tab": "Documentation",
"groups": [
"versions": [
{
"group": "Get Started",
"pages": [
"introduction"
]
},
{
"group": "Essentials",
"pages": [
"essentials/error_codes",
"essentials/rate_limit",
"essentials/go-live"
]
},
{
"group": "Payments Core APIs",
"pages": [
"api-reference/payments/setup--instructions",
"api-reference/payments/payment--flows",
"version": "1.0.0",
"groups": [
{
"group": "Payments",
"group": "Get Started",
"pages": ["introduction"]
},
{
"group": "Essentials",
"pages": [
"api-reference/payments/payments--create",
"api-reference/payments/payments--update",
"api-reference/payments/payments--confirm",
"api-reference/payments/payments--retrieve",
"api-reference/payments/payments--cancel",
"api-reference/payments/payments--capture",
"api-reference/payments/payments--incremental-authorization",
"api-reference/payments/payments--session-token",
"api-reference/payments/payments-link--retrieve",
"api-reference/payments/payments--list",
"api-reference/payments/payments--external-3ds-authentication",
"api-reference/payments/payments--complete-authorize",
"api-reference/payments/payments--update-metadata"
"essentials/error_codes",
"essentials/rate_limit",
"essentials/go-live"
]
},
{
"group": "Payment Methods",
"group": "Payments Core APIs",
"pages": [
"api-reference/payment-methods/paymentmethods--create",
"api-reference/payment-methods/payment-method--retrieve",
"api-reference/payment-methods/payment-method--update",
"api-reference/payment-methods/payment-method--delete",
"api-reference/payment-methods/payment-method--set-default-payment-method-for-customer",
"api-reference/payment-methods/list-payment-methods-for-a-merchant",
"api-reference/payment-methods/list-customer-saved-payment-methods-for-a-payment",
"api-reference/payment-methods/list-payment-methods-for-a-customer",
"api-reference/customer-set-default-payment-method/customers--set-default-payment-method"
"v1/payments/setup--instructions",
"v1/payments/payment--flows",
{
"group": "Payments",
"pages": [
"v1/payments/payments--create",
"v1/payments/payments--update",
"v1/payments/payments--confirm",
"v1/payments/payments--retrieve",
"v1/payments/payments--cancel",
"v1/payments/payments--capture",
"v1/payments/payments--incremental-authorization",
"v1/payments/payments--session-token",
"v1/payments/payments-link--retrieve",
"v1/payments/payments--list",
"v1/payments/payments--external-3ds-authentication",
"v1/payments/payments--complete-authorize",
"v1/payments/payments--update-metadata"
]
},
{
"group": "Payment Methods",
"pages": [
"v1/payment-methods/paymentmethods--create",
"v1/payment-methods/payment-method--retrieve",
"v1/payment-methods/payment-method--update",
"v1/payment-methods/payment-method--delete",
"v1/payment-methods/payment-method--set-default-payment-method-for-customer",
"v1/payment-methods/list-payment-methods-for-a-merchant",
"v1/payment-methods/list-customer-saved-payment-methods-for-a-payment",
"v1/payment-methods/list-payment-methods-for-a-customer",
"v1/customer-set-default-payment-method/customers--set-default-payment-method"
]
},
{
"group": "Customers",
"pages": [
"v1/customers/customers--create",
"v1/customers/customers--retrieve",
"v1/customers/customers--update",
"v1/customers/customers--delete",
"v1/customers/customers--list"
]
},
{
"group": "Mandates",
"pages": [
"v1/mandates/mandates--revoke-mandate",
"v1/mandates/mandates--retrieve-mandate",
"v1/mandates/mandates--customer-mandates-list"
]
},
{
"group": "Refunds",
"pages": [
"v1/refunds/refunds--create",
"v1/refunds/refunds--update",
"v1/refunds/refunds--retrieve",
"v1/refunds/refunds--list"
]
},
{
"group": "Disputes",
"pages": [
"v1/disputes/disputes--retrieve",
"v1/disputes/disputes--list"
]
},
{
"group": "Payouts",
"pages": [
"v1/payouts/payouts--create",
"v1/payouts/payouts--update",
"v1/payouts/payouts--cancel",
"v1/payouts/payouts--fulfill",
"v1/payouts/payouts--confirm",
"v1/payouts/payouts--retrieve",
"v1/payouts/payouts--list",
"v1/payouts/payouts--list-filters",
"v1/payouts/payouts--filter"
]
}
]
},
{
"group": "Customers",
"group": "Account management APIs",
"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"
{
"group": "Organization",
"pages": [
"v1/organization/organization--create",
"v1/organization/organization--retrieve",
"v1/organization/organization--update"
]
},
{
"group": "Merchant Account",
"pages": [
"v1/merchant-account/merchant-account--create",
"v1/merchant-account/merchant-account--retrieve",
"v1/merchant-account/merchant-account--update",
"v1/merchant-account/merchant-account--delete",
"v1/merchant-account/merchant-account--kv-status"
]
},
{
"group": "Business Profile",
"pages": [
"v1/business-profile/business-profile--create",
"v1/business-profile/business-profile--update",
"v1/business-profile/business-profile--retrieve",
"v1/business-profile/business-profile--delete",
"v1/business-profile/business-profile--list"
]
},
{
"group": "API Key",
"pages": [
"v1/api-key/api-key--create",
"v1/api-key/api-key--retrieve",
"v1/api-key/api-key--update",
"v1/api-key/api-key--revoke",
"v1/api-key/api-key--list"
]
},
{
"group": "Merchant Connector Account",
"pages": [
"v1/merchant-connector-account/merchant-connector--create",
"v1/merchant-connector-account/merchant-connector--retrieve",
"v1/merchant-connector-account/merchant-connector--update",
"v1/merchant-connector-account/merchant-connector--delete",
"v1/merchant-connector-account/merchant-connector--list"
]
},
{
"group": "GSM (Global Status Mapping)",
"pages": [
"v1/gsm/gsm--create",
"v1/gsm/gsm--get",
"v1/gsm/gsm--update",
"v1/gsm/gsm--delete"
]
}
]
},
{
"group": "Mandates",
"group": "Other APIs",
"pages": [
"api-reference/mandates/mandates--revoke-mandate",
"api-reference/mandates/mandates--retrieve-mandate",
"api-reference/mandates/mandates--customer-mandates-list"
]
},
{
"group": "Refunds",
"pages": [
"api-reference/refunds/refunds--create",
"api-reference/refunds/refunds--update",
"api-reference/refunds/refunds--retrieve",
"api-reference/refunds/refunds--list"
]
},
{
"group": "Disputes",
"pages": [
"api-reference/disputes/disputes--retrieve",
"api-reference/disputes/disputes--list"
]
},
{
"group": "Payouts",
"pages": [
"api-reference/payouts/payouts--create",
"api-reference/payouts/payouts--update",
"api-reference/payouts/payouts--cancel",
"api-reference/payouts/payouts--fulfill",
"api-reference/payouts/payouts--confirm",
"api-reference/payouts/payouts--retrieve",
"api-reference/payouts/payouts--list",
"api-reference/payouts/payouts--list-filters",
"api-reference/payouts/payouts--filter"
{
"group": "Event",
"pages": [
"v1/event/events--list",
"v1/event/events--delivery-attempt-list",
"v1/event/events--manual-retry"
]
},
{
"group": "Poll",
"pages": ["v1/poll/poll--retrieve-poll-status"]
},
{
"group": "Blocklist",
"pages": [
"v1/blocklist/get-blocklist",
"v1/blocklist/post-blocklist",
"v1/blocklist/delete-blocklist",
"v1/blocklist/post-blocklisttoggle"
]
},
{
"group": "Routing",
"pages": [
"v1/routing/routing--list",
"v1/routing/routing--create",
"v1/routing/routing--retrieve-config",
"v1/routing/routing--deactivate",
"v1/routing/routing--retrieve-default-config",
"v1/routing/routing--update-default-config",
"v1/routing/routing--retrieve-default-for-profile",
"v1/routing/routing--update-default-for-profile",
"v1/routing/routing--retrieve",
"v1/routing/routing--activate-config"
]
},
{
"group": "Relay",
"pages": ["v1/relay/relay", "v1/relay/relay--retrieve"]
},
{
"group": "Schemas",
"pages": ["v1/schemas/outgoing--webhook"]
}
]
}
]
},
{
"group": "Account management APIs",
"pages": [
"version": "2.0.0 [BETA]",
"groups": [
{
"group": "Organization",
"group": "Get Started [BETA]",
"pages": ["introduction"]
},
{
"group": "Essentials [BETA]",
"pages": [
"api-reference/organization/organization--create",
"api-reference/organization/organization--retrieve",
"api-reference/organization/organization--update"
"essentials/error_codes",
"essentials/rate_limit",
"essentials/go-live"
]
},
{
"group": "Merchant Account",
"group": "Payments Core APIs [BETA]",
"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": "Payments",
"pages": [
"v2/payments/payments--create-intent",
"v2/payments/payments--get-intent",
"v2/payments/payments--update-intent",
"v2/payments/payments--session-token",
"v2/payments/payments--payment-methods-list",
"v2/payments/payments--confirm-intent",
"v2/payments/payments--get",
"v2/payments/payments--create-and-confirm-intent",
"v2/payments/payments--list"
]
},
{
"group": "Payment Methods",
"pages": [
"v2/payment-methods/payment-method--create",
"v2/payment-methods/payment-method--create-intent",
"v2/payment-methods/payment-method--payment-methods-list",
"v2/payment-methods/payment-method--confirm-intent",
"v2/payment-methods/payment-method--update",
"v2/payment-methods/payment-method--retrieve",
"v2/payment-methods/payment-method--delete",
"v2/payment-methods/list-saved-payment-methods-for-a-customer"
]
},
{
"group": "Payment Method Session",
"pages": [
"v2/payment-method-session/payment-method-session--create",
"v2/payment-method-session/payment-method-session--retrieve",
"v2/payment-method-session/payment-method-session--list-payment-methods",
"v2/payment-method-session/payment-method-session--update-a-saved-payment-method",
"v2/payment-method-session/payment-method-session--confirm-a-payment-method-session",
"v2/payment-method-session/payment-method-session--delete-a-saved-payment-method"
]
},
{
"group": "Customers",
"pages": [
"v2/customers/customers--create",
"v2/customers/customers--retrieve",
"v2/customers/customers--update",
"v2/customers/customers--delete",
"v2/customers/customers--list",
"v2/customers/customers--list-saved-payment-methods"
]
},
{
"group": "Refunds",
"pages": ["v2/refunds/refunds--create"]
}
]
},
{
"group": "Business Profile",
"group": "Account management APIs [BETA]",
"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": "Organization",
"pages": [
"v2/organization/organization--create",
"v2/organization/organization--retrieve",
"v2/organization/organization--update",
"v2/organization/organization--merchant-account--list"
]
},
{
"group": "Merchant Account",
"pages": [
"v2/merchant-account/merchant-account--create",
"v2/merchant-account/merchant-account--retrieve",
"v2/merchant-account/merchant-account--update",
"v2/merchant-account/business-profile--list"
]
},
{
"group": "Profile",
"pages": [
"v2/profile/profile--create",
"v2/profile/profile--update",
"v2/profile/profile--activate-routing-algorithm",
"v2/profile/profile--update-default-fallback-routing-algorithm",
"v2/profile/profile--deactivate-routing-algorithm",
"v2/profile/profile--retrieve",
"v2/profile/merchant-connector--list",
"v2/profile/profile--retrieve-active-routing-algorithm",
"v2/profile/profile--retrieve-default-fallback-routing-algorithm"
]
},
{
"group": "Connector Account",
"pages": [
"v2/connector-account/connector-account--create",
"v2/connector-account/connector-account--retrieve",
"v2/connector-account/connector-account--update"
]
},
{
"group": "API Key",
"pages": [
"v2/api-key/api-key--create",
"v2/api-key/api-key--retrieve",
"v2/api-key/api-key--update",
"v2/api-key/api-key--revoke",
"v2/api-key/api-key--list"
]
},
{
"group": "Routing",
"pages": [
"v2/routing/routing--create",
"v2/routing/routing--retrieve"
]
}
]
},
{
"group": "API Key",
"group": "Other APIs [BETA]",
"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": "Other APIs",
"pages": [
{
"group": "Event",
"pages": [
"api-reference/event/events--list",
"api-reference/event/events--delivery-attempt-list",
"api-reference/event/events--manual-retry"
]
},
{
"group": "Poll",
"pages": [
"api-reference/poll/poll--retrieve-poll-status"
]
},
{
"group": "Blocklist",
"pages": [
"api-reference/blocklist/get-blocklist",
"api-reference/blocklist/post-blocklist",
"api-reference/blocklist/delete-blocklist",
"api-reference/blocklist/post-blocklisttoggle"
]
},
{
"group": "Routing",
"pages": [
"api-reference/routing/routing--list",
"api-reference/routing/routing--create",
"api-reference/routing/routing--retrieve-config",
"api-reference/routing/routing--deactivate",
"api-reference/routing/routing--retrieve-default-config",
"api-reference/routing/routing--update-default-config",
"api-reference/routing/routing--retrieve-default-for-profile",
"api-reference/routing/routing--update-default-for-profile",
"api-reference/routing/routing--retrieve",
"api-reference/routing/routing--activate-config"
]
},
{
"group": "Relay",
"pages": [
"api-reference/relay/relay",
"api-reference/relay/relay--retrieve"
]
},
{
"group": "Schemas",
"pages": [
"api-reference/schemas/outgoing--webhook"
{
"group": "Proxy",
"pages": ["v2/proxy/proxy"]
},
{
"group": "Tokenization",
"pages": ["v2/tokenization/tokenization--create"]
}
]
}
]
@ -239,18 +385,14 @@
"groups": [
{
"group": "Hyperswitch Card Vault",
"pages": [
"locker-api-reference/overview"
]
"pages": ["locker-api-reference/overview"]
},
{
"group": "API Reference",
"pages": [
{
"group": "Locker - Health",
"pages": [
"locker-api-reference/locker-health/get-health"
]
"pages": ["locker-api-reference/locker-health/get-health"]
},
{
"group": "Locker - Key Custodian",
@ -278,9 +420,7 @@
"groups": [
{
"group": "Hyperswitch Intelligent Router",
"pages": [
"intelligent-router-api-reference/overview"
]
"pages": ["intelligent-router-api-reference/overview"]
},
{
"group": "API Reference",
@ -329,7 +469,8 @@
},
"api": {
"openapi": [
"openapi_spec.json",
"v1/openapi_spec_v1.json",
"v2/openapi_spec_v2.json",
"rust_locker_open_api_spec.yml"
]
},
@ -371,11 +512,6 @@
}
},
"contextual": {
"options": [
"copy",
"claude",
"chatgpt",
"view"
]
}
"options": ["copy", "claude", "chatgpt", "view"]
}
}

0
api-reference/api-reference/3ds-decision-rule/execute-a-3ds-decision-rule-based-on-the-provided-input.mdx → api-reference/v1/3ds-decision-rule/execute-a-3ds-decision-rule-based-on-the-provided-input.mdx
View File

0
api-reference/api-reference/api-key/api-key--create.mdx → api-reference/v1/api-key/api-key--create.mdx
View File

0
api-reference/api-reference/api-key/api-key--list.mdx → api-reference/v1/api-key/api-key--list.mdx
View File

0
api-reference/api-reference/api-key/api-key--retrieve.mdx → api-reference/v1/api-key/api-key--retrieve.mdx
View File

0
api-reference/api-reference/api-key/api-key--revoke.mdx → api-reference/v1/api-key/api-key--revoke.mdx
View File

0
api-reference/api-reference/api-key/api-key--update.mdx → api-reference/v1/api-key/api-key--update.mdx
View File

0
api-reference/api-reference/blocklist/delete-blocklist.mdx → api-reference/v1/blocklist/delete-blocklist.mdx
View File

0
api-reference/api-reference/blocklist/get-blocklist.mdx → api-reference/v1/blocklist/get-blocklist.mdx
View File

0
api-reference/api-reference/blocklist/post-blocklist.mdx → api-reference/v1/blocklist/post-blocklist.mdx
View File

0
api-reference/api-reference/blocklist/post-blocklisttoggle.mdx → api-reference/v1/blocklist/post-blocklisttoggle.mdx
View File

0
api-reference/api-reference/business-profile/business-profile--create.mdx → api-reference/v1/business-profile/business-profile--create.mdx
View File

0
api-reference/api-reference/business-profile/business-profile--delete.mdx → api-reference/v1/business-profile/business-profile--delete.mdx
View File

0
api-reference/api-reference/business-profile/business-profile--list.mdx → api-reference/v1/business-profile/business-profile--list.mdx
View File

0
api-reference/api-reference/business-profile/business-profile--retrieve.mdx → api-reference/v1/business-profile/business-profile--retrieve.mdx
View File

0
api-reference/api-reference/business-profile/business-profile--update.mdx → api-reference/v1/business-profile/business-profile--update.mdx
View File

0
api-reference/api-reference/customer-set-default-payment-method/customers--set-default-payment-method.mdx → api-reference/v1/customer-set-default-payment-method/customers--set-default-payment-method.mdx
View File

3
api-reference/v1/customers/customers--create.mdx Normal file
View File

@ -0,0 +1,3 @@
---
openapi: post /customers
---

3
api-reference/v1/customers/customers--delete.mdx Normal file
View File

@ -0,0 +1,3 @@
---
openapi: delete /customers/{customer_id}
---

3
api-reference/v1/customers/customers--list.mdx Normal file
View File

@ -0,0 +1,3 @@
---
openapi: get /customers/list
---

3
api-reference/v1/customers/customers--retrieve.mdx Normal file
View File

@ -0,0 +1,3 @@
---
openapi: get /customers/{customer_id}
---

3
api-reference/v1/customers/customers--update.mdx Normal file
View File

@ -0,0 +1,3 @@
---
openapi: post /customers/{customer_id}
---

3
api-reference/v1/disputes/disputes--list.mdx Normal file
View File

@ -0,0 +1,3 @@
---
openapi: get /disputes/list
---

3
api-reference/v1/disputes/disputes--retrieve.mdx Normal file
View File

@ -0,0 +1,3 @@
---
openapi: get /disputes/{dispute_id}
---

0
api-reference/api-reference/event/events--delivery-attempt-list.mdx → api-reference/v1/event/events--delivery-attempt-list.mdx
View File

0
api-reference/api-reference/event/events--list.mdx → api-reference/v1/event/events--list.mdx
View File

0
api-reference/api-reference/event/events--manual-retry.mdx → api-reference/v1/event/events--manual-retry.mdx
View File

3
api-reference/v1/gsm/gsm--create.mdx Normal file
View File

@ -0,0 +1,3 @@
---
openapi: post /gsm
---

3
api-reference/v1/gsm/gsm--delete.mdx Normal file
View File

@ -0,0 +1,3 @@
---
openapi: post /gsm/delete
---

3
api-reference/v1/gsm/gsm--get.mdx Normal file
View File

@ -0,0 +1,3 @@
---
openapi: post /gsm/get
---

3
api-reference/v1/gsm/gsm--update.mdx Normal file
View File

@ -0,0 +1,3 @@
---
openapi: post /gsm/update
---

0
api-reference/api-reference/mandates/mandates--customer-mandates-list.mdx → api-reference/v1/mandates/mandates--customer-mandates-list.mdx
View File

3
api-reference/v1/mandates/mandates--retrieve-mandate.mdx Normal file
View File

@ -0,0 +1,3 @@
---
openapi: get /mandates/{mandate_id}
---

3
api-reference/v1/mandates/mandates--revoke-mandate.mdx Normal file
View File

@ -0,0 +1,3 @@
---
openapi: post /mandates/revoke/{mandate_id}
---

0
api-reference/api-reference/merchant-account/merchant-account--create.mdx → api-reference/v1/merchant-account/merchant-account--create.mdx
View File

0
api-reference/api-reference/merchant-account/merchant-account--delete.mdx → api-reference/v1/merchant-account/merchant-account--delete.mdx
View File

0
api-reference/api-reference/merchant-account/merchant-account--kv-status.mdx → api-reference/v1/merchant-account/merchant-account--kv-status.mdx
View File

0
api-reference/api-reference/merchant-account/merchant-account--retrieve.mdx → api-reference/v1/merchant-account/merchant-account--retrieve.mdx
View File

0
api-reference/api-reference/merchant-account/merchant-account--update.mdx → api-reference/v1/merchant-account/merchant-account--update.mdx
View File

0
api-reference/api-reference/merchant-connector-account/merchant-connector--create.mdx → api-reference/v1/merchant-connector-account/merchant-connector--create.mdx
View File

0
api-reference/api-reference/merchant-connector-account/merchant-connector--delete.mdx → api-reference/v1/merchant-connector-account/merchant-connector--delete.mdx
View File

0
api-reference/api-reference/merchant-connector-account/merchant-connector--list.mdx → api-reference/v1/merchant-connector-account/merchant-connector--list.mdx
View File

0
api-reference/api-reference/merchant-connector-account/merchant-connector--retrieve.mdx → api-reference/v1/merchant-connector-account/merchant-connector--retrieve.mdx
View File

0
api-reference/api-reference/merchant-connector-account/merchant-connector--update.mdx → api-reference/v1/merchant-connector-account/merchant-connector--update.mdx
View File

0
api-reference/openapi_spec.json → api-reference/v1/openapi_spec_v1.json
View File

0
api-reference/api-reference/organization/organization--create.mdx → api-reference/v1/organization/organization--create.mdx
View File

0
api-reference/api-reference/organization/organization--retrieve.mdx → api-reference/v1/organization/organization--retrieve.mdx
View File

Some files were not shown because too many files have changed in this diff Show More