konbini api模式

POST/api

功能说明

时序图

sequenceDiagram
Customer->>Merchant: 点击支付
Merchant->>UseePay Server: 调用/cashier接口
UseePay Server->>Merchant: Response[resultCode=challenge]
Merchant->>Customer: 展示response[redirectUrl]
Customer->>konbin Server: 使用konbin进行支付
konbin Server ->> UseePay Server: 同步通知支付结果
konbin Server -->> UseePay Server: 异步支付结果
UseePay Server->>Merchant: 展示支付结果
Merchant->>Customer: 展示支付结果，并同步通知/cashier接口传输redirectUrl页面
UseePay Server-->>Merchant: 异步通知notifyUrl接口

请求对象参数说明

PayerInfo 请求参数说明

参数	必选	类型	说明
paymentMethod	Y	String	目前固定为 konbini
billingAddress	Y	Json String	账单信息

billingAddress Object

参数	必选	类型	说明
firstName	Y	string	收货人名
lastName	Y	string	收货人姓
email	Y	string	收货邮箱
phoneNo	Y	string	收货手机号
street	N	string	收货街道地址
houseNo	N	string	收货街道地址和门牌号当street存在时可以不填
postalCode	N	string	邮编，如果该国家或地区由邮编必须传，否则可以不传
city	N	string	城市
state	N	string	省/州/地区, 需满足 ISO 3166-2
country	N	string	国家，ISO 两位大写英文国家代码, 需满足 ISO 3166-1

orderInfo 订单信息

参数	必选	类型	说明
subject	Y	string	订单标题
goodsInfo	N	array	商品信息, 请参考 goodsInfo
shippingAddress	N	object	收货地址, 请参考 shippingAddress

请求参数

Header 参数

Content-Type

string

必需

示例值:

application/x-www-form-urlencoded

Body 参数application/x-www-form-urlencoded

amount

string

必需

支付金额，单位为对应币种的最小货币单位(详见 ISO 4217)(12)

示例值:

100

appId

string

必需

max=128 网站域名

示例值:

www.pay.com

autoRedirect

string

可选

是否302跳转 true/ false 默认 true

示例值:

false

country

string

可选

示例值:

currency

string

必需

max=3 位 ISO 大写字母货币代码(详见 ISO 4217) 目前仅支持JPY

示例值:

JPY

echoParam

string

可选

max=256 回声参数，响应报文会原样返回

示例值:

echoParam

merchantNo

string

必需

merchantNo

示例值:

500000000007362

notifyUrl

string

异步通知(512)

可选

示例值:

http://gatewaytest.useepay.com/notifyV2u0

orderInfo

string

必需

订单信息, 请参考上方文档参数描述

示例值:

{"subject":"order title","goodsInfo":[{"id":"商品编号","name":"商品名称","body":"商品描述","category":"商品类目","categoryTree":"商品类目树，不同级别类目使用”|”分割","brand":"商品品牌","quantity":1,"price":1234,"url":"商品url","sku":"商品sku","image":"商品图片url"}],"shippingAddress":{"email":"haile1y@useepay.com","phoneNo":"123123","firstName":"Victor","lastName":"Yang","street":"Heathcoat House, 20 Savile Row","postalCode":"W1S 3PR","city":"London","state":"LND","country":"GB"}}

payerInfo

string

必需

Json格式的String 付款方信息, 请下方

示例值:

{"paymentMethod":"klarna","countryCode":"DE","billingAddress":{"houseNo":"El Gallo Giro(https://gallogiro.com/)","email":"amber.lei@useepay.com","phoneNo":"1235854433","firstName":"amber","lastName":"Yang","stlogreet":"7148 Pacific Blvd, Huntington Park, CA","postalCode":"90225","city":"Huntington Park","state":"CA","country":"DE","street":"street"}}

redirectUrl

string

必需

跳转商户地址(512)

示例值:

http://192.168.1.56:8005/redirectV2u0

sign

string

可选

示例值:

9ee208a2dcdd4bbc9ba0a99be4b6b0d8

signType

string

必需

max=16 商户生成签名字符串所使用的签名算法类型 RSA/MD5

示例值:

MD5

transactionExpirationTime

string

可选

maxlength=6 过期时间,本地化过期时间建议7天以上

示例值:

1880

transactionId

string

必需

max=64 商户订单号，建议每次请求的 transactionId 唯一，有利于后续订单查询和对账。

示例值:

490f9dc6-59c9-49b5-8c88-2a948f1b4d3b

transactionType

string

必需

交易类型 : pay

示例值:

pay

userInfo

string

必需

userInfo

示例值:

{"userId":"victor1","ip":"103.25.65.178","email":"useepay@useepay.com"}

version

string

必需

max=5 调用的接口版本，固定为：1.0

示例值:

1.0

示例代码

返回响应

成功(200)

HTTP 状态码: 200

内容格式: JSONapplication/json

amount

string

金额

必需

redirectUrl

string

收银台地址

可选

当resultCode=challenge时存在

resultCode

string

业务返回码

必需

判断交易是否成功 challenge表示收银台请求被成功接受，可以返回redirectUrl给消费者

sign

string

签名

必需

验证签名

errorCode

string

错误返回码

可选

用于展示给消费者具体的错误信息，可参考错误码页面

transactionId

string

商户订单号

必需

errorMsg

string

错误返回信息

可选

transactionType

string

交易类型

必需

pay

reference

string

业务流水号

可选

UseePay的业务流水号

echoParam

string

可选

max=256 回声参数，响应报文会原样返回

signType

string

签名类型

必需

currency

string

币种

必需

merchantNo

string

商户号

必需

商户号

redirectMethod

string

可选

重定向请求方法：get\post

redirectParam

string

可选

重定向请求所需携带的参数。当业务结果码=Challenge 时返回

{
  "amount": "10000",
  "redirectUrl": "https://r2.girogate.de/klarna/T971/I?tx=2082117755&rs=VafOZYt1r63slNyIy9M7kn9W3kON7Z82&cs=ef46cd83ca104e56e7087f55a6e8a58563c852989272642e3d0737256d785ad0",
  "resultCode": "challenge",
  "sign": "eede407042a59a90dd891e2a0146fecd",
  "errorCode": "3200",
  "transactionId": "202305291225132",
  "errorMsg": "Transaction is pending",
  "transactionType": "pay",
  "reference": "1012305290025689145",
  "redirectMethod": "POST",
  "echoParam": "echoParam",
  "redirectParam": "{}",
  "reserved": "",
  "signType": "MD5",
  "currency": "EUR",
  "merchantNo": "500000000007362"
}

最后修改时间： 1 年前