概述
本文档详细描述了调用支付功能时所需的通用参数、业务参数的格式、规则和要求。仅适用于Klarna和其他本地支付场景,请在发起请求前仔细阅读。
调用流程
请求参数
通用参数(所有接口必传)
注意
这部分是所有接口都需要的公共参数,通常与身份认证、签名和账单基础信息相关。
| 参数名 | 类型 | 长度 | 是否必填 | 描述 | 示例 |
|---|---|---|---|---|---|
account | string | 6 | 是 | Oceanpayment账户号 | 995149 |
terminal | string | 8-12 | 是 | Oceanpayment终端号 | 99514901 |
signValue | string | 64 | 是 | 安全签名,用于验证交易的安全性,使用SHA256加密 | 2f86d081884c7d659a2feaa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a08 |
key | string | 257 | 有条件 | Oceanpayment公钥
| 9c4f2a8d7e1b3c5f6a0d9e2b4c7f1a3d5e6b8c0f2a1d9e3c7b5f4a2d6e8c1f0a3b7d9e2c5f1a6b8d0c3e7f4a2b9c1d6e8f0a3b5c7d9e2f1a6c8b4d0e3f7a9c1b5d6e8f2a3c7b1d9e0f4a6c8b2d3e5f7a9c1d0b4e |
backUrl | string | 1-500 | 是 | 同步返回支付信息的网站URL地址 | https://example.com/callback |
noticeUrl | string | 1-500 | 否 | 服务器回调URL地址,用于交易结果推送及其他业务状态推送 | https://example.com/notify |
methods | string | 1-50 | 是 | 支付方式
| Credit Card |
order_number | string | 1-50 | 是 | 网站订单号
| 123456789 |
order_currency | string | 3 | 是 | 订单号的交易币种
| USD |
order_amount | string | 1-10 | 是 | 订单号的交易金额
| 1.00 |
账单信息
| 参数名 | 类型 | 长度 | 是否必填 | 描述 | 示例 |
|---|---|---|---|---|---|
billing_firstName | string | 1-50 | 是 | 消费者的名
| John |
billing_lastName | string | 1-50 | 是 | 消费者的姓
| Wilson |
billing_email | string | 1-50 | 是 | 消费者的邮箱
| customer@gmail.com |
billing_phone | string | 0-50 | 有条件 | 消费者的电话
| 13106683312 |
billing_country | string | 1-100 | 是 | 消费者的账单国家
| US |
billing_state | string | 1-100 | 是 | 消费者的州(省、郡)
| NY |
billing_city | string | 0-500 | 否 | 消费者的城市 | New York |
billing_address | string | 0-500 | 否 | 消费者的详细地址 | 350 5th Ave |
billing_zip | string | 0-50 | 否 | 消费者的邮编 | 10024-3941 |
billing_ip | string | 0-50 | 有条件 | 消费者的ip地址 | 127.0.0.1 |
产品信息
信息
产品信息为结汇合规要求,相关字段均为必传参数。
| 参数名 | 类型 | 长度 | 是否必填 | 描述 | 示例 |
|---|---|---|---|---|---|
productName | string | 1-500 | 是 | 产品名称
| shoes |
productNum | string | 1-50 | 是 | 产品数量
| 1 |
productSku | string | 1-500 | 是 | 产品SKU
| #123 |
productPrice | string | 1-500 | 是 | 产品单价
| 1.00 |
收货信息
当网站没有收货信息时,可以用账单信息的值进行传值。
| 参数名 | 类型 | 长度 | 是否必填 | 描述 | 示例 |
|---|---|---|---|---|---|
ship_firstName | string | 1-50 | 否 | 收货人的名 | John |
ship_lastName | string | 1-50 | 否 | 收货人的姓 | Wilson |
ship_email | string | 1-50 | 否 | 收货人的邮箱 | customer@gmail.com |
ship_phone | string | 0-50 | 否 | 收货人的电话 | 13106683312 |
ship_country | string | 1-100 | 否 | 收货人的账单国家
| US |
ship_state | string | 1-100 | 否 | 收货人的州(省、郡)
| NY |
ship_city | string | 0-500 | 否 | 收货人的城市 | New York |
ship_addr | string | 0-500 | 否 | 收货人的详细地址 | 350 5th Ave |
ship_zip | string | 0-50 | 否 | 收货人的邮编 | 10024-3941 |
业务参数
按对接场景需求进行传参。
| 参数名 | 类型 | 长度 | 是否必填 | 描述 | 示例 |
|---|---|---|---|---|---|
order_notes | string | 0-500 | 否 | 订单备注信息,返回时则原样返回 | test |
pages | string | 0-50 | 否 | 支付页面终端
| 0 |
logoUrl | string | 0-50 | 否 | 用于显示在支付页面上的logo URL | https://example.com/logo.png |
language | string | 0-50 | 否 | 支付页面语言,不传值默认根据浏览器语言进行适配 | en_US |
cssUrl | string | 0-50 | 否 | 在线CSS样式文件链接,用于重写支付页面的样式
| https://example.com/style.css |
pay_website | string | 0-500 | 有条件 | 商家的来源网址
| example.com |
附加参数(本地支付)
注意
在使用本地支付方式时,除通用请求参数外,部分支付方式还需传递额外的特定参数。请根据不同支付方式的接口要求,正确传入对应参数。
| 参数名 | 类型 | 长度 | 是否必填 | 描述 |
|---|---|---|---|---|
pay_bankCode | string | 1-50 | 有条件 | 支持的银行代码 |
pay_countryCode | string | 1-50 | 有条件 | 支持的国家代码 |
pay_installments | string | 1-50 | 有条件 | 分期数 |
pay_cpf | string | 1-50 | 有条件 | 消费者的CPF,纳税人识别号 |
pay_accountNumber | string | 1-50 | 有条件 |
|
card_type | string | 1-50 | 有条件 | 支付卡种。Google Pay、Apple Pay直连支付必传
|
Klarna附加参数
注意
使用Klarna支付
itemList参数为必填项。订单总金额必须与商品明细金额之和完全一致,否则可能导致支付失败。- 对于非实物电商场景,
customer_info部分字段的必填要求可能因业务场景而异。请联系Oceanpayment技术支持确认具体哪些字段为必填项。
| 参数名 | 类型 | 长度 | 是否必填 | 描述 | 示例 |
|---|---|---|---|---|---|
+itemList | object | - | 是 | 产品信息节点Json(需压缩传值) | {"0":{"type":"1","title":"book","sku":"#001", "price":"100","quantity":"1","total_amount":"100.00", "taxRate":"0","taxPrice":01", "image_url":"https://example.com/a.jpg", "product_url":"https://example.com/a.html", "remark":""}, "1":{"type":"3","title":"discount","sku":"#002", "price":"0","quantity":"1","total_amount":"0", "taxRate":"0","taxPrice":"0","image_url":"", "product_url":"","remark":""}, "2":{"type":"4","title":"shipping_fee","sku":"#002", "price":"0","quantity":"1","total_amount":"0", "taxRate":"0","taxPrice":"0","image_url":"", "product_url":"","remark":""}} |
+customer_info | object | - | 有条件 | 客户信息节点Json(需压缩传值) | {"customer_info":{"account_registrationDate": "2026-10-01T08:30:00Z","account_lastModifiedDate": "2026-10-01T08:30:00Z","paid_before":"true"}} |
订单总价由以下部分组成:
- 商品金额:每个商品单价 × 数量
- 税费:可针对商品、物流或订单全局的税额
- 物流费用:运费、快递费等
- 折扣:优惠券、满减、促销折扣等
订单总价 = 商品金额 + 税费 + 物流费用 - 折扣。
航空参数
信息
航空参数仅在航空支付场景下使用,其他交易类型无需传递。
| 参数名 | 类型 | 长度 | 是否必填 | 描述 | 示例 |
|---|---|---|---|---|---|
travel_totalTaxes | string | 0-50 | 否 | 税费 | |
travel_websiteLanguage | string | 0-50 | 否 | 网站语言 | |
travel_adult | string | 0-3 | 否 | 成人数量 | |
travel_child | string | 0-3 | 否 | 子女数量 | |
travel_infant | string | 0-3 | 否 | 婴儿数量 | |
travel_electronicTicket | string | 1 | 是 | 是否为电子机票
| |
travel_agencyCode | string | 0-10 | 否 | ATA机场代码 | |
travel_pnr | string | 1-10 | 是 | PNR | |
travel_spnr | string | 0-10 | 否 | SPNR | |
ticket_deliveryMethod | string | 1 | 是 | 票据的交付方式,仅支持小写字母
| |
+travel_customerInfoJson | object | - | 是 | 乘客节点信息(Json格式) |
QuickPay
创建QuickPay ID
Note
当您在使用订阅场景,创建Quickpay ID时,此字段customer_id为必传。
| 参数名 | 类型 | 长度 | 是否必填 | 描述 | 示例 |
|---|---|---|---|---|---|
customer_id | string | 1-50 | 是 | 用户ID
| NO123456 |
发起扣款
Note
当您在使用订阅场景或快捷支付发起扣款时,此字段quickpay_id为必传。
| 参数名 | 类型 | 长度 | 是否必填 | 描述 | 示例 |
|---|---|---|---|---|---|
quickpay_id | string | 1-200 | 是 | Oceanpayment生成的唯一的Quickpay ID
| c6db7a28-7639-4d24-b7c5-6cd222c3e0fc |
返回参数
浏览器同步返回:
- 每笔支付均以POST方式返回至交易传参的
backUrl; - 返回方式默认为POST,可修改为GET方式。
| 参数名 | 类型 | 描述 | 示例 |
|---|---|---|---|
response_type | string | 回调类型
| 0 |
account | string | 账户号 | 995149 |
terminal | string | 终端号 | 99514901 |
signValue | string | 安全签名,用于验证交易的安全性,使用SHA256加密 | A3F1C9D4E8B27F6A5C0D1E9F4B6A7C8D2E3F1A9B5C6D7E8F0A1B2C3D4E5F678 |
methods | string | 支付方式 | Credit Card |
order_number | string | 网站订单号 | 123456789 |
order_currency | string | 订单号的交易币种 | USD |
order_amount | string | 订单号的交易金额 | 1.00 |
order_notes | string | 订单备注信息 | test |
card_number | string | 持卡人的信用卡卡号 | 411111***1111 |
card_type | string | 卡种 | Visa |
payment_country | string | 消费者IP所在国家 | US |
payment_id | string | 支付ID,Oceanpayment的支付唯一单号 | 26154125951032147852122 |
payment_status | string | 该笔交易的结果状态
| 1 |
payment_authType | string | 该笔交易的类型
| 0 |
payment_details | string | 该笔交易的支付详情
| 80000:Transaction Approved |
payment_solutions | string | 付款失败后的解决方法
| |
payment_risk | string | 未通过的风控规则
| |
pay_barCode | string | 订单打印码 | |
payment_bankInfo | string | 调起银行SDK的参数信息 |
异步通知
查看完整的Oceanpayment异步通知参数。