开始接入支付页面 API

在Coda后台配置后，您可以快速测试某个支付方式的支付流程。

本教程仅展示如何测试特定支付方式。如果您对我们的其他支付选择页面感兴趣，可以参考支付渠道接入方式

您将了解到的内容

发起支付请求
您的客户在发起支付请求时的体验
您的客户在成功支付通知时的体验

本教程假设您已设置开发环境并具备调用 API 的工具（如 Postman 等）。如果尚未设置，您也可以通过我们 Coda 后台的“沙盒测试”（集成->Codapay->Sandbox Testing)部分测试此流程。

步骤 1：发起支付请求

通过调用 /init 接口发起支付请求，以获取Coda订单 ID。使用以下参数并填写相应内容：

参数

Placeholder text

描述

country

[SELECTED_COUNTRY]

您想要测试的国家/地区。查看国家和货币代码

currency

[SELECTED_CURRENCY]

您想要使用的货币代码。查看国家和货币代码

payType

[SELECTED_PAYMENT_CHANNEL_ID]

您想要使用的支付方式。查看支付页面 API

apiKey

[API_KEY]

从 Coda 后台获取您的 API 密钥。

projectId

[PROJECT_ID]

*此字段仅适用于 v2.0 API 从 Coda 后台获取每个标题的 projectId。

确保价格在您选择的支付渠道的交易限额范围内，您可以在各渠道金额及限制查看交易限额。

以下参数已填写为测试用的虚拟数据，可以根据您的集成需求进行更改和正确填写。有关 /init 接口参数的更多详细信息，请参阅支付页面API集成。

Codapay 提供两个 API 版本 - v1.0 和 v2.0，v2.0 为升级版。如果您是新商户，请使用 v2.0。更多详情 - Codapay API 版本概览

curl --location 'https://sandbox.codapayments.com/airtime/api/restful/v2.0/Payment/init.json' \
--header 'Content-Type: application/json' \
--data '{
    "initRequest": {
        "country": [SELECTED_COUNTRY],
        "payType": [SELECTED_PAYMENT_CHANNEL_ID],
        "apiKey": [API_KEY],
        "projectId": [PROJECT_ID] //此字段仅适用于 v2.0 API
        "currency": [SELECTED_CURRENCY],
        "items": [
            {
                "code": "1",
                "price": 50.00,
                "name": "Test Item"
            }
        ],
        "profile": {
            "entry": [
                {
                    "key": "user_id",
                    "value": "105"
                }
            ]
        }
    }
}

curl --location 'https://sandbox.codapayments.com/airtime/api/restful/v1.0/Payment/init.json' \
--header 'Content-Type: application/json' \
--data '{
    "initRequest": {
        "country": [SELECTED_COUNTRY],
        "payType": [SELECTED_PAYMENT_CHANNEL_ID],
        "apiKey": [COUNTRY_API_KEY],
        "orderId": "12321312321314",
        "currency": [SELECTED_CURRENCY],
        "items": [
            {
                "code": "1",
                "price": 50.00,
                "name": "Test Item"
            }
        ],
        "profile": {
            "entry": [
                {
                    "key": "user_id",
                    "value": "105"
                }
            ]
        }
    }
}

以下示例使用新加坡沙盒 API 密钥，新加坡元 (SGD) 作为货币，支付方式为卡支付。

curl --location 'https://sandbox.codapayments.com/airtime/api/restful/v2.0/Payment/init.json' \
--header 'Content-Type: application/json' \
--data '{
    "initRequest": {
        "country": 702,
        "payType": 427,
        "apiKey": "test_32774abe1cd7d8bae650ea48265e",
        "projectId": 21 //此字段仅适用于 v2.0 API
        "orderId": "12321312321314",
        "currency": 702,
        "items": [
            {
                "code": "1",
                "price": 50.00,
                "name": "Test Item"
            }
        ],
        "profile": {
            "entry": [
                {
                    "key": "user_id",
                    "value": "105"
                }
            ]
        }
    }
}'

curl --location 'https://sandbox.codapayments.com/airtime/api/restful/v1.0/Payment/init.json' \
--header 'Content-Type: application/json' \
--data '{
    "initRequest": {
        "country": 702,
        "payType": 427,
        "apiKey": "32774abe1cd7d8bae650ea48265e",
        "orderId": "12321312321314",
        "currency": 702,
        "items": [
            {
                "code": "1",
                "price": 50.00,
                "name": "Test Item"
            }
        ],
        "profile": {
            "entry": [
                {
                    "key": "user_id",
                    "value": "105"
                }
            ]
        }
    }
}'

{
   "initResult": {
       "resultCode": 0,
       "txnId": 7122167282516076304
   }
}

步骤 2：将用户重定向至支付页面完成支付

使用步骤 1 中获得的 txnId，将用户重定向至以下 URL：

点击此处查看 URL 中可传递的所有参数。

https://sandbox.codapayments.com/airtime/begin?type=3&txn_id=[txnId]

https://sandbox.codapayments.com/airtime/begin?type=3&txn_id=[txnId]&browser_type=mobile-web

以下是上述在新加坡使用卡支付发起的交易示例：

在沙盒环境中，您可以按照支付渠道测试说明提供的测试说明完成支付。

完成一笔新加坡的卡支付测试交易订单，可以使用以下测试卡信息

卡号

有效期

CVC

4242 4242 4242 4242

01/35

备注：在沙盒环境中，支付可能需要几分钟才能完成。

步骤 3：接收订单成功付款通知

您会在配置的回调 URL 上收到Coda的回调通知，通知中将包含以下字段作为查询参数：

参数

描述

TxnId

Coda 订单 ID

OrderId

您在 init 请求中传递的 OrderId

ResultCode

支付状态（例如：success = 0）

TotalPrice

用户为该订单交易支付的总金额

PaymentType

用户选择的支付渠道 ID

Checksum

用于验证消息未被篡改的校验和

❗️商家收到Coda订单回调成功支付通知，成功发货后需回复字符串 ResultCode=0

例： NotifyURL="商家回调地址TxnId=Coda订单号&OrderId=商家orderID&TotalPrice=金额&PaymentType=渠道号&ResultCode=0&Checksum=xxxxx", MResp="ResultCode=0"

❗️若 Coda 未收到 ResultCode=0 的回复，将启动重试机制：

系统会每隔 5 分钟重试一次，总共重试 3 次。
若重试机制失败，将通过邮件通知商家。

步骤 4：调用 InquiryPaymentResult API 确认订单的支付状态

我们强烈建议商家使用此接口做双重确认 (回调通知 + 订单状态结果成功), 以确保订单成功后才发货

使用以下 InquiryPaymentResult API 调用查询您的订单支付状态。

点击此处查看所有可用参数。

curl --location 'https://sandbox.codapayments.com/airtime/api/restful/v2.0/Payment/inquiryPaymentResult.json' \
--header 'Content-Type: application/json' \
--data '{
    "inquiryPaymentRequest":
    {
        "apiKey" : "test_32774abe1cd7d8bae650ea48265e",
        "country": 702 //此字段仅适用于 v2.0 API
        "projectId" : 21 //此字段仅适用于 v2.0 API
        "txnId" : "7144594637002072212",
        "needStatusFinal": "true"
    }
}'

curl --location 'https://sandbox.codapayments.com/airtime/api/restful/v1.0/Payment/inquiryPaymentResult.json' \
--header 'Content-Type: application/json' \
--data '{
    "inquiryPaymentRequest":
    {
        "apiKey" : "32774abe1cd7d8bae650ea48265e",
        "txnId" : "7144594637002072212",
        "needStatusFinal": "true"
    }
}'

{
    "paymentResult": {
        "orderId": 12321312321314,
        "profile": {
            "entry": [
                {
                    "key": "PaymentType",
                    "value": 427
                },
                {
                    "key": "isStatusFinal",
                    "value": true
                },
                {
                    "key": "status",
                    "value": "success"
                }
            ]
        },
        "resultCode": 0,
        "resultDesc": "",
        "totalPrice": 50,
        "txnId": 7144594637002072212
    }
}

接下来的步骤

深入了解支付页面 API，了解更多关于支付页面和支付渠道选择页面的内容。
进一步探索我们的后端API 功能。

上一页开始支付渠道设置

下一页集成指南

最后更新于 1年前

这有帮助吗？