结账 API
Ask AI
端点合约
创建一个托管结账会话,可以在一个 GLODIPAY 结账页面上显示卡、钱包、银行方式、二维码和加密货币。
POST /v2/checkoutapplication/json需要签名
环境: Sandbox: https://payment-sandbox.gpayprocessing.com. Production 基础 URL 来自商户后台的 API Keys 页面。
签名规则
- 在签名之前从有效载荷中移除
signature。 - 按自然升序对顶级键进行排序。
- 递归修剪字符串值,并按照规范示例预期的那样转换叶节点数字类型。
- 序列化为 JSON,并使用您的商户私钥通过
md5WithRSAEncryption进行签名。 - 对二进制签名进行 Base64 编码,并将其作为
signature字段发送。
每当您提供私钥时,控制台都会使用本地签名代理执行此流程。
请求参数
| 字段 | 类型 | 必填 | 描述 |
|---|---|---|---|
merchantId | String(1,50) | M | 商户 ID。 |
orderRef | String(1,250) | M | 每个商户唯一的交易引用。 |
amount | Float | M | 发票金额。最小 1,最多 2 位小数。 |
currency | String(3) | M | ISO 4217 货币代码。v2 结账规范目前记录为 USD。 |
paymentMethod | String | M | 要显示的支付方式。支持 ALL, APM, card, googlepay, applepay, paypal, ibanking_push, local_bank_transfer, wire_transfer, wallet, alipay, wechat, skrill, crypto。 |
cancelUrl | String(1,300) | M | 取消时的 HTTPS 重定向 URL。 |
callbackUrl | String(1,300) | M | 成功后的 HTTPS 重定向 URL。 |
notificationUrl | String(1,300) | M | HTTPS Webhook 端点。 |
errorUrl | String(1,300) | M | 出错时的 HTTPS 重定向 URL。 |
orderDescription | String(max:3000) | M | 显示在结账屏幕上的简短描述。 |
metadata | JSON | O | 在 IPN 和查询响应中返回的键值对。 |
transactionDocuments | JSON | O | 交易支持文件。 |
paymentFilter | JSON | O | 要排除的支付方式类型数组。 |
paymentSorter | JSON | O | 用于控制显示顺序的有顺序数组。有效值:card, paypal, ibanking_push, local_bank_transfer, wire_transfer, wallet, skrill, alipay, wechat, googlepay, applepay, crypto, apm。 |
feeBySeller | Number(0-100) | O | 由商户支付的处理费百分比。 |
billingFirstName | String(max:255) | O | 账单名字。 |
billingLastName | String(max:255) | O | 账单姓氏。 |
billingStreet1 | String(max:255) | O | 账单地址行 1。 |
billingStreet2 | String(max:255) | O | 账单地址行 2。 |
billingCity | String(max:255) | O | 账单城市。 |
billingEmail | String(max:255) | O | 买家电子邮件地址。 |
billingState | String(2,255) | O | 账单州或省。 |
billingCountry | String | O | ISO 3166-1 alpha-2 国家代码。 |
billingPostalCode | String(max:25) | O | 邮政编码。 |
billingPhoneCountryCode | String(max:10) | O | 电话国家代码。 |
billingPhoneNumber | String(max:20) | O | 电话号码。 |
brandName | String(1,255) | O | 覆盖托管结账屏幕上的品牌名称。 |
colorMode | String(1,255) | O | 最多 3 种颜色,用 --- 分隔。 |
logoSource | String(1,255) | O | 覆盖托管结账屏幕上的徽标。 |
customerIp | String | O | 客户的 IP 地址。 |
websiteUrl | String(max:300) | O | 商户网站 URL。 |
connectionMode | String | O | DIRECT_POST 或 API。参见下方的连接模式。 |
expiresAt | String | O | ISO 8601 会话过期时间。默认为 24 小时。 |
signature | String(max:750) | M | RSA-MD5 签 名。 |
连接模式
| 值 | 描述 |
|---|---|
DIRECT_POST | 浏览器立即重定向到托管结账页面。 |
API | 在 JSON 响应中返回 paymentLink URL。 |
响应与流程
API: 返回包含 status, transactionId, paymentLink, 和 message 的 JSON。
DIRECT_POST: 直接将买家重定向到托管结账页面,不向您的服务器返回 JSON。
付款后,GLODIPAY 将浏览器重定向到 callbackUrl,并带有 ?payload=base64-json。当交易达到终端状态时,您的 notificationUrl 也会收到 JSON Webhook。
您的 Webhook 处理程序应通过以下方式快速确认收到:
{
"returnCode": "100",
"description": "Received"
}来源
此页面派生自 结账 API。