签约查询 - 易宝开放平台

请求参数

Query 参数

parentMerchantNo

string

发起方商户编号

必需

*标准商户收付款方案中此参数与收款商户编号一致；
*平台商户收付款方案中此参数为平台商商户编号；
*服务商解决方案中，①标准商户收款时，该参数为标准商户商编 ②平台商收款或平台商入驻商户收款时，该参数为平台商商编

merchantNo

string

商户编号

必需

收单主体商编，平台商或服务商下的子商户，普通特约商户

agreementId

string

协议ID

必需

商户自己生成的协议号，要求商户保证唯一

Header 参数

x-yop-sdk-version

string

可选

默认值:

4.0.0

返回响应

🟢200成功

application/json

Body

result

object (aggpay.EntrustWithholdSignQueryResponseDTO)

响应结果

可选

code

string

返回码

可选

message

string

返回信息

可选

payWay

string

支付方式

可选

channel

string

渠道类型

可选

signSource

string

签约来源

可选

appId

string

可选

微信公众号ID/微信小程序ID

plainId

string

协议模版ID

可选

agreementId

string

协议ID

可选

signStatus

string

签约状态

可选

可选项如下:
INIT:初始化
SIGNED:已签约
UNSIGNED:已解约

uniqueAgreementNo

string

易宝唯一签约协议号

可选

示例

{
  "result": {
    "code": "string",
    "message": "string",
    "payWay": "string",
    "channel": "string",
    "signSource": "string",
    "appId": "string",
    "plainId": "string",
    "agreementId": "string",
    "signStatus": "string",
    "uniqueAgreementNo": "string"
  }
}

🔴500服务器错误