Antom 接口文档

Antom 接口

设计清晰、简洁且易于集成，Antom 接口致力于降低高可用性应用的复杂度并缩短开发时间。Antom 接口基于 HTTP 协议，是 POST 类型的接口，使用 SHA256 和 RSA 算法创建数字签名，接收 JSON 格式的请求体并返回 JSON 格式的响应。接口请求包括路径中的接口链接、请求头中的身份和签名信息以及请求体中的请求参数。

接口调用

要与 Antom 集成，您首先需要在 Antom Dashboard 进行准备并获取您的客户端 ID。然后通过使用 Antom 接口的测试模式来改进集成，这种方式不会影响您的实时数据。我们鼓励在项目上线前，在沙箱环境中测试接口调用。

您可以使用 Antom 提供的开放 SDK 来与 Antom 集成。如果您使用的编程语言是 Java、PHP 或 Python，您可以通过 Antom 提供的 SDK 完成 HTTP 请求的组装、签名、调用及结果检查的过程。Alipay SDK 封装了集成过程，包括调用 Antom 接口时的签名添加和验证。

CLIENT LIBRARIES

针对不同的支付场景，提供了 Java、PHP 和 Python 的特定 SDK。根据您的需求选择合适的 SDK。请参考 README.md 部分了解更多关于如何使用 SDK 的信息。

生产环境和沙箱环境的请求地址仅在请求路径部分有所不同。您可以首先在沙箱环境中测试 Antom 接口，这不会影响您生产环境中的数据。完成测试后，通过更改请求链接和其他配置迁移到生产环境。

Environment	Request URL
Sandbox	https://<domain_name>/ams/sandbox/api/<endpoint> (Online payments) https://<domain_name>/ams/api/<endpoint> (In-store payments)
Production	https://<domain_name>/ams/api/<endpoint> (Online payments) https://<domain_name>/ams/api/<endpoint> (In-store payments)

域名可以从 Antom 获取，您可以根据所在地区选择下面列出的支持域名之一。如果您不确定使用哪个域名，请联系技术支持邮箱 overseas_support@service.alibaba.com 获取帮助。

Location	Domain Name
North America	https://open-na-global.alipay.com (recommended) or https://open-na.alipay.com
Asia	https://open-sea-global.alipay.com (recommended) or https://open-sea.alipay.com
Europe	https://open-de-global.alipay.com (recommended) or https://open-eu.alipay.com (only for in-store payments）

以下部分是典型 Antom 接口的请求和响应的示例：

REQUEST

copy

POST /ams/api/v1/payments/inquiryPayment HTTP/1.1
Accept: application/json, text/plain, */*
Content-Type: application/json; charset=UTF-8
Request-Time: 1685599933871
client-id: 5J5XSU7Y2Y182W01981
Signature: algorithm=RSA256,keyVersion=1,signature=***

{"paymentId":"20200429114010800100188850266791455"}

RESPONSE

copy

{
    "actualPaymentAmount": {
        "currency": "PHP",
        "value": "1314"
    },
    "paymentAmount": {
        "currency": "PHP",
        "value": "1314"
    },
    "paymentId": "20200513114010800100188770269589293",
    "paymentRequestId": "REQUEST_20200513161204",
    "paymentResultCode": "SUCCESS",
    "paymentResultMessage": "success",
    "paymentStatus": "SUCCESS",
    "paymentTime": "2020-05-13T01:12:52-07:00",
    "result": {
        "resultCode": "SUCCESS",
        "resultMessage": "success.",
        "resultStatus": "S"
    }
}

Antom 提供开发者工具和资源来帮助您快速高效地集成。利用这些工具来简化您的开发流程。

Antom 支付产品的接口和通知

不同的接口是为不同的支付场景设计的。根据您的收款情况使用特定的接口。Antom 还提供通知，以便在支付处理达到成功或失败的最终状态时向商户发送支付结果。

在线支付

收银台支付

代扣

注意：在线支付产品的通知包括：支付通知，授权结果通知，退款通知，请款通知（收银台）,和争议通知。

线下支付

反扫支付

订单码支付

入口码支付