文档中心 > API类目 > AliOS支付API

aliyun.alios.pay.period.agreement.status.get (查询周期扣款签约状态)

查询周期扣款签约状态

公共参数

请求参数

名称 类型 是否必须 示例值 更多限制 描述
get_period_agreement_status_request GetPeriodAgreementStatusRequest 可选 请求参数
  • └ trace_id
  • String
  • 必须
  • 0b0aad0e15441575065206212d0756
  • 请求唯一id,不可重复,服务端会根据此参数防重放
  • └ lang
  • String
  • 必须
  • en
  • 语言,en表示英文,zh表示中文
  • └ time
  • String
  • 必须
  • 1559200938392
  • 请求时间戳
  • └ external_period_agreement_code
  • String
  • 必须
  • 15fcd70c3609746b95ef10b211a5dde8
  • 外部商户周期扣款签约码,周期扣款协议中标示用户的唯一签约编号(确保在商户系统中唯一)。格式规则:支持大写小写字母和数字,最长32位。

响应参数

名称 类型 示例值 描述
aliospay_response AliOSPayResponse 响应参数
  • └ trace_id
  • String
  • 0b0aad0e15441575065206212d0756
  • 请求唯一id,不可重复,服务端会根据此参数防重放
  • └ code
  • Number
  • 0
  • 错误码
  • └ message
  • String
  • success
  • 错误信息
  • data
  • GetPeriodAgreementStatusResponse
  • 业务数据
  • └ agreement_id
  • String
  • 76DCD131A8DC428A0220866018D60479
  • 周期扣款协议签约id
  • └ agreement_status
  • String
  • SIGNED
  • 周期扣款协议签约状态,INIT-初始,SIGNED-已签约,UNSIGNED-已解约
  • └ sign_time
  • Number
  • 1545127232000
  • 协议签约时间,时间戳,单位毫秒
  • └ unsign_time
  • Number
  • 1545127232000
  • 协议解约时间,时间戳,单位毫秒

请求示例

  • JAVA
  • .NET
  • PHP
  • CURL
  • Python
  • C/C++
  • NodeJS
TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
AliyunAliosPayPeriodAgreementStatusGetRequest req = new AliyunAliosPayPeriodAgreementStatusGetRequest();
AliyunAliosPayPeriodAgreementStatusGetRequest.GetPeriodAgreementStatusRequest obj1 = new AliyunAliosPayPeriodAgreementStatusGetRequest.GetPeriodAgreementStatusRequest();
obj1.setTraceId("0b0aad0e15441575065206212d0756");
obj1.setLang("en");
obj1.setTime("1559200938392");
obj1.setExternalPeriodAgreementCode("15fcd70c3609746b95ef10b211a5dde8");
req.setGetPeriodAgreementStatusRequest(obj1);
AliyunAliosPayPeriodAgreementStatusGetResponse rsp = client.execute(req);
System.out.println(rsp.getBody());

响应示例

  • XML示例
  • JSON示例
<aliyun_alios_pay_period_agreement_status_get_response>
    <aliospay_response>
        <trace_id>0b0aad0e15441575065206212d0756</trace_id>
        <code>0</code>
        <message>success</message>
        <data>
            <agreement_id>76DCD131A8DC428A0220866018D60479</agreement_id>
            <agreement_status>SIGNED</agreement_status>
            <sign_time>1545127232000</sign_time>
            <unsign_time>1545127232000</unsign_time>
        </data>
    </aliospay_response>
</aliyun_alios_pay_period_agreement_status_get_response>

异常示例

  • XML示例
  • JSON示例
<error_response>
    <code>50</code>
    <msg>Remote service error</msg>
    <sub_code>isv.invalid-parameter</sub_code>
    <sub_msg>非法参数</sub_msg>
</error_response>

错误码解释

错误码 错误描述 解决方案

API工具

如何获得此API

FAQ

返回
顶部