Appearance
订单类接口
创建采购订单
场景:服务商调用当前接口实现企业创建采购订单,配合支付开票接口使用。当前场景只适用于农产品收购交易场景,采购企业面向农户采购初级农产品时,农户出示数农码给到采购企业扫码,扫码后采购企业通过此接口创建相关采购订单(订单携带农户的数农码编号),订单的结果通过查询接口获取。
POST
/open-api/ncp-purchase-order/create-v2请求参数 Body
snCodestring必需
数农码编号
最大长度 100
businessNostring必需
业务请求流水号,必须保持唯一性
最大长度 50
payModeenum<integer>必需
结算账户类型
枚举值:
1银行卡
2微信
totalPricenumber必需
商品总金额
decimal(12, 2),最多保留 2 位小数
customerNamestring必需
采购商名称
最大长度 100
customerUsccstring必需
采购商统一社会信用代码
长度 18,数字或者大写字母
agentIdentificationstring可选
经纪人外部 ID,跟经纪人手机号二选一;与采购商员工手机号不能同时传入
最大长度 32
agentPhonestring可选
经纪人手机号,跟经纪人外部 ID 二选一;与采购商员工手机号不能同时传入
长度 11
customerStaffPhonestring可选
采购商员工手机号,与经纪人外部 ID、经纪人手机号不能同时传入
长度 11
invoiceRemarkstring可选
发票备注,自定义发票备注
最大长度 450
transferRemarkstring可选
转账备注
最大长度 60
响应参数
msgstring可选
显示消息内容
codeinteger必需
响应码,200 表示接口请求正常
下单前查询需要上传的证明材料
场景:服务商在调用创建采购订单接口前,可通过本接口按下单必要参数预查询该笔订单需要农户上传的证明材料和合格证。接口只使用外部系统可获取的采购商、数农码、商品类目和金额信息,不需要传入数字农人内部 ID。
注意
本接口仅返回平台/税务侧配置命中的农户证明材料,不查询采购商自定义证明配置,也不查询旧合格证配置。
POST
/open-api/ncp-purchase-order/need-upload-proof请求参数 Body
snCodestring必需
数农码编号,用于识别农户
最大长度 100
customerNamestring必需
采购商名称
最大长度 100
customerUsccstring必需
采购商统一社会信用代码
最大长度 18,数字或者大写字母
totalPricenumber必需
商品总金额,用于匹配平台/税务侧金额区间配置
响应参数
msgstring可选
显示消息内容
codeinteger必需
响应码,200 表示接口请求正常
订单支付开票
场景:配合订单创建接口使用,调用创建订单后服务商通过调用支付开票接口发起支付开票申请。调用本接口后,待收款的农户在数字农人平台上确认收款。
注意
农户收款确认后,系统将自动进行款项划拨,即企业付款和农户收款。
POST
/open-api/ncp-purchase-order/payAndInvoice-v2请求参数 Body
purchaseOrderNostring可选
平台订单编号
最大长度 64
businessNostring可选
业务请求流水号,与平台订单编号必须至少传一个
最大长度 50
响应参数
msgstring可选
错误消息
codeinteger必需
响应码,200 表示正常
dataobject可选
数据有就显示,没有就不显示
订单查询
场景:发起订单支付开票后,服务商可通过此接口查询订单支付开票结果。
POST
/open-api/ncp-purchase-order/one-v2请求参数 Body
purchaseOrderNostring可选
采购订单编号,传创建订单时的请求订单号
最大长度 64
businessNostring可选
业务请求流水号,与采购订单编号至少传一个
响应参数
msgstring可选
错误消息
codeinteger必需
响应码,200 表示正常
查询支付回单
场景:批量查询企业已完成交易的支付订单回单信息(只适合订单状态是"已完成"),支持银行和微信支付回单数据查询。
POST
/open-api/ncp-purchase-order/receipt-url请求参数 Body
purchaseOrderNosarray[string]可选
采购订单号数组,创建订单时生成的采购订单号,与 businessNos 二选一
businessNosarray[string]可选
外部单号数组,与 purchaseOrderNos 二选一
响应参数
msgstring可选
错误消息
codeinteger必需
响应码,200 表示正常
订单批量查询
场景:服务商可通过此接口批量查询采购订单详情。支持通过采购订单编号列表或外部业务流水号列表查询,当两个列表同时传入时,以采购订单编号列表为准。
POST
/open-api/ncp-purchase-order/list-v2请求参数 Body
purchaseOrderNosarray[string]可选
采购订单编号列表
businessNosarray[string]可选
外部业务流水号列表
响应参数
msgstring可选
错误消息
codeinteger必需
响应码,200 表示正常
dataarray[object]可选
订单列表数据,具体结构请参考订单查询接口返回的 data 对象
errorCodestring可选
业务错误码
stackTraceStringstring可选
堆栈异常信息
订单取消
场景:当企业已提交开票和转账申请,订单状态处于某个阶段(订单状态已完成、已取消或者支付状态已支付、支付失败等情况除外),且因业务原因企业有意向取消该笔申请时,调用此接口完成订单支付开票申请的取消。
POST
/open-api/ncp-purchase-order/cancel请求参数 Body
purchaseOrderNostring可选
采购订单号,创建订单时生成的采购订单号,与 businessNo 二选一
businessNostring可选
外部单号,与 purchaseOrderNo 二选一
cancelReasonenum<string>必需
取消原因
枚举值:
ORDER_INFO_ERROR订单信息有误
PLAN_CHANGE计划有变取消交易
REPEAT_PAY_ORDER重复下单
OFFLINE_TRADE需要线下交易
OTHER其他原因
cancelRemarkstring可选
补充说明,订单取消时补充取消的具体详细原因
最大长度 20
响应参数
msgstring必需
显示消息内容
codeinteger必需
响应码,200 表示取消成功,非 200 表示取消失败
okboolean必需
操作是否成功
