简介 👋

欢迎使用 Hyperswitch API 参考文档

Hyperswitch 提供了一组 API,使您能够处理和管理支付。我们的 API 在 HTTP 主体中接受和返回 JSON,并返回标准的 HTTP 响应代码。您可以直接使用您喜欢的 HTTP/REST 库使用这些 API。

环境

我们有一个称为“沙箱”的测试环境,您可以设置该环境以在不影响生产数据的情况下测试 API 调用。您可以在我们的控制面板上注册以获取访问 Hyperswitch API 的 API 密钥。

向 API 发出请求时,请使用以下基本 URL:

环境	基本 URL
沙箱环境	https://sandbox.hyperswitch.io
生产环境	https://api.hyperswitch.io

如果您没有 PCI 认证来收集和存储卡片数据到您的服务器上,我们建议使用 Unified Checkout 从用户那里接受卡片信息。

Hyperswitch 使用您的帐户 API 密钥来认证您的 API 请求。每个帐户都有两个用于认证的 API 密钥:

密钥	示例	何时使用
安全密钥(API 密钥)	`snd_c69***`	用于认证来自您的商家服务器的 API 请求。不要在网站上或在移动应用程序中嵌入此密钥
发布密钥	`pk_snd_3b3***`	用于认证来自您应用程序客户端的 API 请求。可以在您的 Web 或移动应用程序客户端端代码中公开访问。

获取您的API 密钥和发布密钥

Hyperswitch 的支付 API 是一个全面且健壮的 API,它可以处理各种复杂的全球支付场景。以下是我们的 API 端点和模式概述:

API	端点
支付	`/payments`、`/payments/{payment_id}/confirm`、`/payments/{payment_id}/capture`、`/payments/{payment_id}/update`
授权	`/mandates/{mandate_id}`、`/mandates/revoke/{mandate_id}`
退款	`/refunds`、`/refunds/{refund_id}`(检索)
客户	`/customers`、`/customers/{customer_id}`(检索、更新和删除)
支付方式	`/payment_methods`、`/payment_methods/{method_id}`(更新和删除)
争议	`/disputes/{dispute_id}`(检索)

支付 API 只需要两个步骤来通过 Hyperswitch 处理支付: