• 新平台

本文对Hosted Payment Page使用的主要接口进行介绍：

#API# Create Hosted Payment Page

官方说明地址：https://api-reference.checkout.com/preview/crusoe/#operation/createAHostedPaymentsSession
HTTP调用方式为POST
sandbox地址：https://api.sandbox.checkout.com/hosted-payments
生产地址：https://api.checkout.com/hosted-payments

主要请求参数

其中蓝色标注的是重点关注参数：

Body 参数名 是否必填 说明
amount
- [ ]

| 支付金额，为最小金额单位。如币种为美金USD时，amount = 1 表示1美分。具体可以参考文档《币种计算规则》 | | currency |
- [x]

| 支付金额，标准的ISO 3位币种，如USD。具体可参考 | | reference |
- [ ]

| 商户订单号 | | customer.email |
- [ ]

| 用户邮箱，用来唯一对应Checkout.com内部一个用户 | | customer.name |
- [ ]

| 用户名，格式为 First name + 空格 + last name，如“Bruce Wayne” | | shipping.address.address_line1 |
- [ ]

| | | shipping.address.address_line2 |
- [ ]

| | | shipping.address.city |
- [ ]

| | | shipping.address.state |
- [ ]

| | | shipping.address.zip |
- [ ]

| | | shipping.address.country |
- [ ]

| 若shipping出现，则为必填项。国家代码可参考 | | shipping.phone.number |
- [ ]

| 若shipping.phone出现，则为必填。 | | shipping.phone.country_code |
- [ ]

| 呼叫国家代码可参考 | | billing.address.address_line1 |
- [ ]

| | | billing.address.address_line2 |
- [ ]

| | | billing.address.city |
- [ ]

| | | billing.address.state |
- [ ]

| | | billing.address.zip |
- [ ]

| | | billing.address.country |
- [x]

| 国家代码可参考 | | billing.phone.number |
- [ ]

| 若billing.phone出现，则为必填。 | | billing.phone.country_code |
- [ ]

| 呼叫国家代码可参考 | | allow_payment_methods |
- [ ]

| 允许展示的支付方式数组。枚举值：
“card” “sofort” “klarna” “paypal” “ideal” “sepa” “knet” “giropay” “bancontact” “eps” “p24” “multibanco” | | products.name |
- [ ]

| products为数组形式，[1-1000]最多可办好1000项。
产品名 | | products.quantity |
- [ ]

| 产品数量 | | products.price |
- [ ]

| 产品单价 | | success_url |
- [x]

| 用户支付成功后回调的商户页面 | | cancel_url |
- [x]

| 用户取消后回调的商户页面 | | failure_url |
- [x]

| 用户支付失败后回调的商户页面 | | locale |
- [ ]

| 展示的语言。枚举值：
“de-CH” “de-DE” “en-AT” “en-CH” “en-DE” “en-DK” “en-GB” “en-FI” “en-NL” “en-NO” “en-SE” “es-ES” “fil-PH” “fr-CH” “fr-FR” “hi-IN” “id-ID” “it-CH” “it-IT” “ja-JP” “ms-MY” “nl-NL” “ms-MY” “th-TH” “vi-VN” “zh-CN” “zh-HK” “zh-TW” | | 3ds.enabled |
- [ ]

| 是否启用3DS |

主要返回参数

  • 成功返回，HTTP Code = 201 | 参数名 | 说明 | | —- | —- | | id | Hosted Payment Page的唯一Id | | reference | 请求中发送的商户侧Id | | _links.self.href | 查询该Hosted Payment Page的Url | | _links.redirect.href | Checkout.com的支付页面Url，用于后续用户跳转 |
  • 失败返回，HTTP = 401，密钥使用错误
  • 失败返回，HTTP = 422，输入参数错误 | 参数名 | 说明 | | —- | —- | | request_id | Checkout.com内部Id | | error_type | 错误类型 | | error_codes | 错误代码 |