PayKKa OpenAPI Documentation
  1. 订单
PayKKa OpenAPI Documentation
  • 概述
  • 接口规则
  • SDK
  • 通信安全
    • 签名生成与验证
  • API列表
    • 商户入网
      • 商户入网申请
      • 商户资料更新
      • 商户入网结果查询
      • 商户入网结果(通知)
    • 收款账户
      • 收款账户开通申请
      • 收款账号开通申请结果查询
      • 收款账号开通结果(通知)
    • 汇入汇款
      • 汇入汇款(通知)
    • 订单
      • 订单创建
        POST
      • 订单更新
        POST
      • 订单状态查询
        POST
      • 补充物流(发货)信息
        POST
    • 解付入账
      • 创建解付入账流程
      • 解付入账状态查询
      • 解付入账结果(通知)
    • 账户余额
      • 查询账户余额
    • 收款人
      • 收款人创建
      • 修改收款人(用于被驳回时修改收款人信息)
      • 收款人创建结果查询
      • 收款人创建结果(通知)
    • 换汇
      • 换汇预下单(询价)
      • 换汇确认
      • 查询换汇结果
      • 换汇结果通知
    • 付款
      • 付款
      • 付款状态查询
      • 付款结果通知
    • 文件服务
      • 文件上传接口参数说明
      • 文件上传
  • 附录
    • 开通收款账户码表
    • 商品品类
    • 经营品类
    • 省市编码
    • 银行编码
    • 行业
    • 国家地区代码
  1. 订单

订单更新

POST
/api/v2/merch/contract/update
合同订单
request_id与合同订单创建接口相同

请求参数

Header 参数
X-Merch-Id
string 
可选
默认值:
M24061911365700670
Body 参数application/json
request_id
string 
必需
请求号,请求方系统内唯一
>= 1 字符<= 32 字符
buyer_name
string 
必需
买家姓名(最长128字符)
>= 1 字符<= 128 字符
buyer_country
string 
必需
买家国家代码,使用ISO3166-2标准2位国家代码(见附录)
amount
integer <int64>
必需
订单金额(币种最小单位)
currency
enum<string> 
必需
币种: EUR-欧元, USD-美元, CNY-人民币, GBP-英镑, JPY-日元, AUD-澳元, CAD-加元, SGD-新加坡元, HKD-港币, PHP-菲律宾比索, CNH-离岸人民币
枚举值:
EURUSDCNYGBPJPYAUDCADSGDHKDPHPCNH
contract_file_ids
array[integer <int32>]
必需
合同附件id-上传文件接口返回的id(最多10个文件)
>= 1 items<= 10 items
contract_no
string 
必需
合同编号(最长32字符)(只能为数字和字母)(商户下唯一)
>= 1 字符<= 32 字符
goods_info
object 
商品信息
必需
category
integer <int32>
必需
商品分类(支持的商品品类见附件)
name
string 
必需
商品名称(最长128字符)
>= 1 字符<= 128 字符
quantity
integer <int64>
商品数量
可选
url
string 
商品网址
必需
>= 1 字符<= 256 字符
custom_dec_info
object 
报关信息
必需
invoice_file_ids
array[integer <int32>]
必需
PI/CI/发票id-上传文件接口返回id(最多10个文件)
>= 1 items<= 10 items
is_exchange_settle
boolean 
是否需要结汇
必需
logistics_info
object 
物流信息
必需
buyer_type
enum<string> 
可选
NEW-新买家;OLD-老买家
枚举值:
NEWOLD
destination
string 
可选
目的地 已发货时必传(最长256字符)
>= 1 字符<= 256 字符
expected_ship_date
string <date>
可选
预期发货日期 未发货时必传 格式:yyyy-MM-dd
freight_arrange_file_ids
array[integer <int32>]
可选
货运安排沟通记录id-上传文件接口返回id (最多10个文件),新买家必传
>= 1 items<= 10 items
latest_order_file_ids
array[integer <int32>]
可选
商户与该买家最近一笔交易的报关单或出境物流凭证id-上传文件接口返回id 老买家时必传(最多10个文件)
>= 1 items<= 10 items
logistics_company_name
string 
可选
物流公司名称 已发货时必传(最长256字符)
>= 1 字符<= 256 字符
outbound_no
string 
可选
出境物流单号 已发货时必传((最长32字符)
>= 1 字符<= 32 字符
inquiry_records_file_ids
array[integer <int32>]
可选
询盘下单沟通记录-上传文件接口返回的id (最多10个文件),新买家必传
>= 1 items<= 10 items
ship_date
string <date>
可选
发货日期 已发货时必传 格式:yyyy-MM-dd
ship_status
enum<string> 
必需
物流状态: SHIPPED-已发货 UNSHIPPED-未发货
枚举值:
SHIPPEDUNSHIPPED
shipped_file_ids
array[integer <int32>]
可选
发货凭证id-上传文件接口返回的id 已发货时必传(最多10个文件)
>= 1 items<= 10 items
transaction_type
enum<string> 
必需
成交方式: EXW-工厂交货 FCA-货交承运人 FAS-船边交货 FOB-船上交货 CFR-成本加运费 CIF-成本、保险加运费 CPT-运费付至 DDP-完税后交货 DAF-边境交货 DDU-未完税交货 DEQ-目的港码头交货 DES-目的港船上交货
枚举值:
EXWFCAFASFOBCFRCIFCPTDDPDAFDDUDEQDES
transport_type
enum<string> 
可选
运输方式: AIR-空运 SHIPPING-海运 EXPRESS-快递 LAND-陆运 POST-邮政 OTHER-其他
枚举值:
AIRSHIPPINGEXPRESSLANDPOSTOTHER
order_date
string <date>
必需
订单时间 格式: yyyy-MM-dd
remark
string 
可选
备注(长度128字符)
>= 0 字符<= 128 字符
other_file_ids
array[integer <int32>]
可选
其他附件id-上传文件接口返回的id
示例
{
    "request_id": "string",
    "buyer_name": "string",
    "buyer_country": "string",
    "amount": 0,
    "currency": "EUR",
    "contract_file_ids": [
        0
    ],
    "contract_no": "string",
    "goods_info": {
        "category": 0,
        "name": "string",
        "quantity": 0,
        "url": "string",
        "custom_dec_info": {
            "dec_method": "string",
            "dec_no": "string"
        }
    },
    "invoice_file_ids": [
        0
    ],
    "is_exchange_settle": true,
    "logistics_info": {
        "buyer_type": "NEW",
        "destination": "string",
        "expected_ship_date": "2019-08-24",
        "freight_arrange_file_ids": [
            0
        ],
        "latest_order_file_ids": [
            0
        ],
        "logistics_company_name": "string",
        "outbound_no": "string",
        "inquiry_records_file_ids": [
            0
        ],
        "ship_date": "2019-08-24",
        "ship_status": "SHIPPED",
        "shipped_file_ids": [
            0
        ],
        "transaction_type": "EXW",
        "transport_type": "AIR"
    },
    "order_date": "2019-08-24",
    "remark": "string",
    "other_file_ids": [
        0
    ]
}

示例代码

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
请求示例请求示例
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://open-fat.cb.paykka.com/api/v2/merch/contract/update' \
--header 'X-Merch-Id: M24061911365700670' \
--header 'Content-Type: application/json' \
--data-raw '{
    "request_id": "string",
    "buyer_name": "string",
    "buyer_country": "string",
    "amount": 0,
    "currency": "EUR",
    "contract_file_ids": [
        0
    ],
    "contract_no": "string",
    "goods_info": {
        "category": 0,
        "name": "string",
        "quantity": 0,
        "url": "string",
        "custom_dec_info": {
            "dec_method": "string",
            "dec_no": "string"
        }
    },
    "invoice_file_ids": [
        0
    ],
    "is_exchange_settle": true,
    "logistics_info": {
        "buyer_type": "NEW",
        "destination": "string",
        "expected_ship_date": "2019-08-24",
        "freight_arrange_file_ids": [
            0
        ],
        "latest_order_file_ids": [
            0
        ],
        "logistics_company_name": "string",
        "outbound_no": "string",
        "inquiry_records_file_ids": [
            0
        ],
        "ship_date": "2019-08-24",
        "ship_status": "SHIPPED",
        "shipped_file_ids": [
            0
        ],
        "transaction_type": "EXW",
        "transport_type": "AIR"
    },
    "order_date": "2019-08-24",
    "remark": "string",
    "other_file_ids": [
        0
    ]
}'

返回响应

🟢200成功
*/*
OK
Body
status
enum<string> 
必需
开放平台合同订单状态: RELATABLE-可关联、ALL_RELATED-已关联
枚举值:
RELATABLEALL_RELATED
示例
{
    "status": "RELATABLE"
}
🟠400请求有误
🟠401没有权限
🟠404记录不存在
🟠429429
🔴500服务器错误
修改于 2024-12-03 07:24:33
上一页
订单创建
下一页
订单状态查询
Built with