repo stringclasses 4
values | file_path stringlengths 6 193 | extension stringclasses 30
values | content stringlengths 0 5.21M | token_count int64 0 3.8M |
|---|---|---|---|---|
hyperswitch | api-reference-v2/api-reference/routing/routing--create.mdx | .mdx | ---
openapi: post /v2/routing-algorithm
--- | 14 |
hyperswitch | api-reference-v2/api-reference/merchant-account/merchant-account--update.mdx | .mdx | ---
openapi: put /v2/merchant-accounts/{id}
--- | 16 |
hyperswitch | api-reference-v2/api-reference/merchant-account/business-profile--list.mdx | .mdx | ---
openapi: get /v2/merchant-accounts/{id}/profiles
--- | 18 |
hyperswitch | api-reference-v2/api-reference/merchant-account/merchant-account--profile-list.mdx | .mdx | ---
openapi: get /v2/merchant-accounts/{id}/profiles
--- | 18 |
hyperswitch | api-reference-v2/api-reference/merchant-account/merchant-account--retrieve.mdx | .mdx | ---
openapi: get /v2/merchant-accounts/{id}
--- | 16 |
hyperswitch | api-reference-v2/api-reference/merchant-account/merchant-account--create.mdx | .mdx | ---
openapi: post /v2/merchant-accounts
--- | 14 |
hyperswitch | api-reference-v2/api-reference/organization/organization--update.mdx | .mdx | ---
openapi: put /v2/organization/{id}
--- | 14 |
hyperswitch | api-reference-v2/api-reference/organization/organization--merchant-account--list.mdx | .mdx | ---
openapi: get /v2/organization/{id}/merchant-accounts
--- | 18 |
hyperswitch | api-reference-v2/api-reference/organization/organization--create.mdx | .mdx | ---
openapi: post /v2/organization
--- | 12 |
hyperswitch | api-reference-v2/api-reference/organization/organization--retrieve.mdx | .mdx | ---
openapi: get /v2/organization/{id}
--- | 14 |
hyperswitch | api-reference-v2/api-reference/business-profile/merchant-connector--list.mdx | .mdx | ---
openapi: get /v2/profiles/{profile_id}/connector-accounts
--- | 19 |
hyperswitch | api-reference-v2/api-reference/business-profile/profile--connector-accounts-list.mdx | .mdx | ---
openapi: get /v2/profiles/{id}/connector-accounts
--- | 18 |
hyperswitch | api-reference-v2/api-reference/customers/customers--list.mdx | .mdx | ---
openapi: get /v2/customers/list
---
| 13 |
hyperswitch | api-reference-v2/api-reference/customers/customers--update.mdx | .mdx | ---
openapi: put /v2/customers/{id}
---
| 14 |
hyperswitch | api-reference-v2/api-reference/customers/customers--retrieve.mdx | .mdx | ---
openapi: get /v2/customers/{id}
---
| 14 |
hyperswitch | api-reference-v2/api-reference/customers/customers--delete.mdx | .mdx | ---
openapi: delete /v2/customers/{id}
---
| 14 |
hyperswitch | api-reference-v2/api-reference/customers/customers--create.mdx | .mdx | ---
openapi: post /v2/customers
---
| 12 |
hyperswitch | api-reference-v2/api-reference/customers/customers--list-saved-payment-methods.mdx | .mdx | ---
openapi: get /v2/customers/{id}/saved-payment-methods
--- | 19 |
hyperswitch | api-reference/hyperswitch_intelligent_router_open_api_spec.yml | .yml | openapi: 3.0.0
info:
title: Dynamic routing - OpenAPI 3.0
description: This the the open API 3.0 specification for the dynamic routing.
version: 1.0.0
paths:
/success_rate.SuccessRateCalculator/FetchSuccessRate:
post:
summary: Fetch success rate for an entity
operationId: fetchSuccessRate
... | 4,111 |
hyperswitch | api-reference/introduction.mdx | .mdx | ---
tags: [Getting Started]
title: "👋 Welcome to Hyperswitch API Reference"
sidebarTitle: "Introduction"
stoplight-id: 3lmsk7ocvq21v
icon: "rectangle-code"
iconType: "solid"
---
Hyperswitch provides a collection of APIs that enable you to process and manage payments. Our APIs accept and return JSON in the HTTP body a... | 1,366 |
hyperswitch | api-reference/rust_locker_open_api_spec.yml | .yml | 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 ... | 2,352 |
hyperswitch | api-reference/mint.json | .json | {
"$schema": "https://mintlify.com/schema.json",
"name": "Hyperswitch",
"logo": {
"dark": "/logo/dark.svg",
"light": "/logo/light.svg"
},
"topbarLinks": [
{
"name": "Contact Us",
"url": "https://join.slack.com/t/hyperswitch-io/shared_invite/zt-2jqxmpsbm-WXUENx022HjNEy~Ark7Orw"
}
... | 2,549 |
hyperswitch | api-reference/openapi_spec.json | .json | {
"openapi": "3.0.3",
"info": {
"title": "Hyperswitch - API Documentation",
"description": "\n## Get started\n\nHyperswitch provides a collection of APIs that enable you to process and manage payments.\nOur APIs accept and return JSON in the HTTP body, and return standard HTTP response codes.\n\nYou can con... | 178,518 |
hyperswitch | api-reference/README.md | .md | # 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 ... | 341 |
hyperswitch | api-reference/_snippets/snippet-example.mdx | .mdx | ## My Snippet
<Info>This is an example of a reusable snippet</Info>
| 18 |
hyperswitch | api-reference/intelligent-router-api-reference/overview.mdx | .mdx | # Dynamo - Dynamic Routing System
## Overview
Dynamo is an open-source dynamic routing system designed for payment processing. It intelligently routes payments to different processors based on real-time metrics, helping to optimize payment flows and increase transaction success rates.
## Why Dynamo?
- 💸 **Increase... | 1,025 |
hyperswitch | api-reference/intelligent-router-api-reference/success-rate/update-success-rate-window.mdx | .mdx | ---
openapi: post /success_rate.SuccessRateCalculator/UpdateSuccessRateWindow
--- | 18 |
hyperswitch | api-reference/intelligent-router-api-reference/success-rate/invalidate-windows.mdx | .mdx | ---
openapi: post /success_rate.SuccessRateCalculator/InvalidateWindows
--- | 17 |
hyperswitch | api-reference/intelligent-router-api-reference/success-rate/fetch-success-rate-for-an-entity.mdx | .mdx | ---
openapi: post /success_rate.SuccessRateCalculator/FetchSuccessRate
--- | 17 |
hyperswitch | api-reference/intelligent-router-api-reference/success-rate/fetch-entity-and-global-success-rates.mdx | .mdx | ---
openapi: post /success_rate.SuccessRateCalculator/FetchEntityAndGlobalSuccessRate
--- | 20 |
hyperswitch | api-reference/intelligent-router-api-reference/elimination/invalidate-elimination-bucket.mdx | .mdx | ---
openapi: post /elimination.EliminationAnalyser/InvalidateBucket
--- | 19 |
hyperswitch | api-reference/intelligent-router-api-reference/elimination/fetch-eliminated-processor-list.mdx | .mdx | ---
openapi: post /elimination.EliminationAnalyser/GetEliminationStatus
--- | 20 |
hyperswitch | api-reference/intelligent-router-api-reference/elimination/update-elimination-bucket.mdx | .mdx | ---
openapi: post /elimination.EliminationAnalyser/UpdateEliminationBucket
--- | 20 |
hyperswitch | api-reference/locker-api-reference/overview.mdx | .mdx | The Hyperswitch Card Vault is a highly performant and a secure vault to save sensitive data such as payment card details, bank account details etc.
It is designed in an polymorphic manner to handle and store any type of sensitive information making it highly scalable with extensive coverage of payment methods and proc... | 470 |
hyperswitch | api-reference/locker-api-reference/locker-health/get-health.mdx | .mdx | ---
openapi: rust_locker_open_api_spec get /health
--- | 15 |
hyperswitch | api-reference/locker-api-reference/key-custodian/provide-key-1.mdx | .mdx | ---
openapi: rust_locker_open_api_spec post /custodian/key1
--- | 18 |
hyperswitch | api-reference/locker-api-reference/key-custodian/provide-key-2.mdx | .mdx | ---
openapi: rust_locker_open_api_spec post /custodian/key2
--- | 18 |
hyperswitch | api-reference/locker-api-reference/key-custodian/unlock-the-locker.mdx | .mdx | ---
openapi: rust_locker_open_api_spec post /custodian/decrypt
--- | 18 |
hyperswitch | api-reference/locker-api-reference/cards/add-data-in-locker.mdx | .mdx | ---
openapi: rust_locker_open_api_spec post /data/add
--- | 16 |
hyperswitch | api-reference/locker-api-reference/cards/retrieve-data-from-locker.mdx | .mdx | ---
openapi: rust_locker_open_api_spec post /data/retrieve
--- | 17 |
hyperswitch | api-reference/locker-api-reference/cards/delete-data-from-locker.mdx | .mdx | ---
openapi: rust_locker_open_api_spec post /data/delete
--- | 16 |
hyperswitch | api-reference/locker-api-reference/cards/get-or-insert-the-card-fingerprint.mdx | .mdx | ---
openapi: post /data/fingerprint
--- | 11 |
hyperswitch | api-reference/logo/dark.svg | .svg | <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.1... | 14,233 |
hyperswitch | api-reference/logo/light.svg | .svg | <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.... | 14,267 |
hyperswitch | api-reference/essentials/go-live.mdx | .mdx | ---
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
- [ ]... | 632 |
hyperswitch | api-reference/essentials/error_codes.mdx | .mdx | ---
title: Error Codes
---
Hyperswitch uses error codes, types, and messages to communicate errors during API calls. There are two main types of error codes: Error Codes and Unified Error Codes.
1. **Error Codes** refer to the error code sent by the connector.
2. **Unified Error Codes** refer to the generic error code... | 3,279 |
hyperswitch | api-reference/essentials/rate_limit.mdx | .mdx | ---
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 ... | 373 |
hyperswitch | api-reference/api-reference/refunds/refunds--update.mdx | .mdx | ---
openapi: openapi_spec post /refunds/{refund_id}
--- | 16 |
hyperswitch | api-reference/api-reference/refunds/refunds--list.mdx | .mdx | ---
openapi: openapi_spec post /refunds/list
--- | 14 |
hyperswitch | api-reference/api-reference/refunds/refunds--create.mdx | .mdx | ---
openapi: openapi_spec post /refunds
--- | 13 |
hyperswitch | api-reference/api-reference/refunds/refunds--retrieve.mdx | .mdx | ---
openapi: openapi_spec get /refunds/{refund_id}
--- | 16 |
hyperswitch | api-reference/api-reference/payments/payments--incremental-authorization.mdx | .mdx | ---
openapi: post /payments/{payment_id}/incremental_authorization
--- | 17 |
hyperswitch | api-reference/api-reference/payments/payments--cancel.mdx | .mdx | ---
openapi: openapi_spec post /payments/{payment_id}/cancel
--- | 17 |
hyperswitch | api-reference/api-reference/payments/payments--confirm.mdx | .mdx | ---
openapi: openapi_spec post /payments/{payment_id}/confirm
--- | 17 |
hyperswitch | api-reference/api-reference/payments/payments--create.mdx | .mdx | ---
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> | 37 |
hyperswitch | api-reference/api-reference/payments/payments--capture.mdx | .mdx | ---
openapi: openapi_spec post /payments/{payment_id}/capture
--- | 17 |
hyperswitch | api-reference/api-reference/payments/payments--post-session-tokens.mdx | .mdx | ---
openapi: post /payments/{payment_id}/post_session_tokens
--- | 16 |
hyperswitch | api-reference/api-reference/payments/payments--session-token.mdx | .mdx | ---
openapi: openapi_spec post /payments/session_tokens
--- | 14 |
hyperswitch | api-reference/api-reference/payments/payments--update.mdx | .mdx | ---
openapi: openapi_spec post /payments/{payment_id}
--- | 15 |
hyperswitch | api-reference/api-reference/payments/payments-link--retrieve.mdx | .mdx | ---
openapi: openapi_spec get /payment_link/{payment_link_id}
--- | 17 |
hyperswitch | api-reference/api-reference/payments/payments--external-3ds-authentication.mdx | .mdx | ---
openapi: post /payments/{payment_id}/3ds/authentication
--- | 16 |
hyperswitch | api-reference/api-reference/payments/Introduction--to--payments.mdx | .mdx | ---
tags: [Payments]
sidebarTitle: "Getting Started with Payments"
icon: "circle-play"
iconType: "solid"
color: "Green"
---
The **Hyperswitch Payments API** enables businesses to **accept, process, and manage payments seamlessly**. It supports the entire **payment lifecycle**—from creation to capture, refunds, and dis... | 882 |
hyperswitch | api-reference/api-reference/payments/payments--complete-authorize.mdx | .mdx | ---
openapi: post /{payment_id}/complete_authorize
--- | 15 |
hyperswitch | api-reference/api-reference/payments/payments--list.mdx | .mdx | ---
openapi: openapi_spec get /payments/list
--- | 13 |
hyperswitch | api-reference/api-reference/payments/payments--retrieve.mdx | .mdx | ---
openapi: openapi_spec get /payments/{payment_id}
--- | 15 |
hyperswitch | api-reference/api-reference/merchant-connector-account/merchant-connector--list.mdx | .mdx | ---
openapi: get /accounts/{account_id}/connectors
--- | 15 |
hyperswitch | api-reference/api-reference/merchant-connector-account/merchant-connector--retrieve.mdx | .mdx | ---
openapi: get /accounts/{account_id}/connectors/{connector_id}
--- | 18 |
hyperswitch | api-reference/api-reference/merchant-connector-account/merchant-connector--update.mdx | .mdx | ---
openapi: post /accounts/{account_id}/connectors/{connector_id}
--- | 18 |
hyperswitch | api-reference/api-reference/merchant-connector-account/merchant-connector--delete.mdx | .mdx | ---
openapi: delete /accounts/{account_id}/connectors/{connector_id}
--- | 18 |
hyperswitch | api-reference/api-reference/merchant-connector-account/merchant-connector--create.mdx | .mdx | ---
openapi: post /accounts/{account_id}/connectors
--- | 15 |
hyperswitch | api-reference/api-reference/api-key/api-key--retrieve.mdx | .mdx | ---
openapi: get /api_keys/{merchant_id}/{key_id}
--- | 16 |
hyperswitch | api-reference/api-reference/api-key/api-key--create.mdx | .mdx | ---
openapi: post /api_keys/{merchant_id}
--- | 13 |
hyperswitch | api-reference/api-reference/api-key/api-key--revoke.mdx | .mdx | ---
openapi: delete /api_keys/{merchant_id}/{key_id}
--- | 16 |
hyperswitch | api-reference/api-reference/api-key/api-key--update.mdx | .mdx | ---
openapi: post /api_keys/{merchant_id}/{key_id}
--- | 16 |
hyperswitch | api-reference/api-reference/api-key/api-key--list.mdx | .mdx | ---
openapi: get /api_keys/{merchant_id}/list
---
| 15 |
hyperswitch | api-reference/api-reference/relay/relay.mdx | .mdx | ---
openapi: openapi_spec post /relay
--- | 12 |
hyperswitch | api-reference/api-reference/relay/relay--retrieve.mdx | .mdx | ---
openapi: openapi_spec get /relay/{relay_id}
--- | 15 |
hyperswitch | api-reference/api-reference/poll/poll--retrieve-poll-status.mdx | .mdx | ---
openapi: get /poll/status/{poll_id}
--- | 13 |
hyperswitch | api-reference/api-reference/gsm/gsm--update.mdx | .mdx | ---
openapi: openapi_spec post /gsm/update
--- | 14 |
hyperswitch | api-reference/api-reference/gsm/gsm--get.mdx | .mdx | ---
openapi: openapi_spec post /gsm/get
--- | 14 |
hyperswitch | api-reference/api-reference/gsm/gsm--delete.mdx | .mdx | ---
openapi: openapi_spec post /gsm/delete
--- | 14 |
hyperswitch | api-reference/api-reference/gsm/gsm--create.mdx | .mdx | ---
openapi: openapi_spec post /gsm
--- | 13 |
hyperswitch | api-reference/api-reference/disputes/disputes--list.mdx | .mdx | ---
openapi: openapi_spec get /disputes/list
--- | 15 |
hyperswitch | api-reference/api-reference/disputes/disputes--retrieve.mdx | .mdx | ---
openapi: openapi_spec get /disputes/{dispute_id}
--- | 18 |
hyperswitch | api-reference/api-reference/payment-methods/payment-method--set-default-payment-method-for-customer.mdx | .mdx | ---
openapi: get /{customer_id}/payment_methods/{payment_method_id}/default
--- | 20 |
hyperswitch | api-reference/api-reference/payment-methods/paymentmethods--create.mdx | .mdx | ---
openapi: openapi_spec post /payment_methods
--- | 13 |
hyperswitch | api-reference/api-reference/payment-methods/list-payment-methods-for-a-customer.mdx | .mdx | ---
openapi: openapi_spec get /customers/{customer_id}/payment_methods
--- | 18 |
hyperswitch | api-reference/api-reference/payment-methods/payment-method--retrieve.mdx | .mdx | ---
openapi: openapi_spec get /payment_methods/{method_id}
--- | 16 |
hyperswitch | api-reference/api-reference/payment-methods/list-payment-methods-for-a-merchant.mdx | .mdx | ---
openapi: openapi_spec get /account/payment_methods
--- | 14 |
hyperswitch | api-reference/api-reference/payment-methods/payment-method--update.mdx | .mdx | ---
openapi: openapi_spec post /payment_methods/{method_id}/update
--- | 18 |
hyperswitch | api-reference/api-reference/payment-methods/list-customer-saved-payment-methods-for-a-payment.mdx | .mdx | ---
openapi: get /customers/payment_methods
--- | 11 |
hyperswitch | api-reference/api-reference/payment-methods/payment-method--delete.mdx | .mdx | ---
openapi: openapi_spec delete /payment_methods/{method_id}
--- | 16 |
hyperswitch | api-reference/api-reference/event/events--delivery-attempt-list.mdx | .mdx | ---
openapi: get /events/{merchant_id}/{event_id}/attempts
--- | 18 |
hyperswitch | api-reference/api-reference/event/events--manual-retry.mdx | .mdx | ---
openapi: post /events/{merchant_id}/{event_id}/retry
--- | 17 |
hyperswitch | api-reference/api-reference/event/events--list.mdx | .mdx | ---
openapi: get /events/{merchant_id}
--- | 12 |
hyperswitch | api-reference/api-reference/routing/routing--update-default-config.mdx | .mdx | ---
openapi: post /routing/default
--- | 10 |
hyperswitch | api-reference/api-reference/routing/routing--retrieve.mdx | .mdx | ---
openapi: get /routing/{routing_algorithm_id}
--- | 13 |
hyperswitch | api-reference/api-reference/routing/routing--deactivate.mdx | .mdx | ---
openapi: post /routing/deactivate
--- | 11 |
hyperswitch | api-reference/api-reference/routing/routing--retrieve-default-for-profile.mdx | .mdx | ---
openapi: get /routing/default/profile
--- | 11 |
hyperswitch | api-reference/api-reference/routing/routing--retrieve-config.mdx | .mdx | ---
openapi: get /routing/active
--- | 11 |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.