创建收款信息

请求地址

https://www.xxyb.cn/union/api/wlpt/consignor/createPayee

Header

参数名	必选	类型	说明
Token	是	string	应用令牌
cid	是	string	合作ID

请求参数

参数名	必选	类型	层级	说明	备注
payeeBasicDomain	是	object	1	收款信息
payeeName	是	string	2	收款人姓名
payeeIdCard	是	string	2	收款人身份证
payeeBankCard	是	string	2	收款银行卡号
payeeBankCardImg	否	string	2	收款银行卡图片
payeeBankName	否	string	2	收款银行
payeePhone	是	string	2	收款手机号
accountType	是	enum	2	收款人类型	见下方收款人类型代码

入参示例

{
  "payeeBasicDomain": {
    "payeeName": "张三",
    "payeeIdCard": "410181198107110012",
    "payeeBankCard": "6222020200000000000",
    "payeeBankCardImg": "https://example.com/bank_card_front.jpg",
    "payeeBankName": "中国工商银行",
    "payeePhone": "13800138000",
    "accountType": "PERSONAL"
  }
}

入参对象

@Setter
@Getter
@Schema(description = "创建收款信息")
public class ApiConsignorPayeeCreateReq {

    @Schema(description = "收款信息")
    @Valid
    @NotNull(message = "收款信息不能为空")
    private ApiPayeeBasicDomain payeeBasicDomain;

    @Setter
    @Getter
    @Accessors(chain = true)
    @Schema(description = "收款人基础信息")
    public class ApiPayeeBasicDomain {

        @Schema(description = "收款人姓名", example = "张三 | 尼古拉斯·赵四")
        @NotBlank(message = "收款人姓名不能为空")
        @Pattern(regexp = "^[\u2E80-\u9FFF·]{2,60}$", message = "收款人姓名格式错误")
        private String payeeName;

        @Schema(description = "收款人身份证", example = "410181198107110012")
        @NotBlank(message = "收款人身份证不能为空")
        @Pattern(regexp = "^[1-9]\\d{5}[1-2]\\d{3}((0\\d)|(1[0-2]))(([012]\\d)|3[0-1])\\d{3}(\\d|X|x)$", message = "收款人身份证格式错误")
        private String payeeIdCard;

        @Schema(description = "收款银行卡号")
        @NotBlank(message = "收款银行卡号不能为空")
        private String payeeBankCard;

        @Schema(description = "收款银行卡图片", example = "https://xx/yy.png")
        private String payeeBankCardImg;

        @Schema(description = "收款银行")
        private String payeeBankName;

        @Schema(description = "收款手机号", example = "13800000000")
        @NotBlank(message = "收款手机号不能为空")
        @Pattern(regexp = "^1[3-9]\\d{9}$", message = "收款手机号格式错误")
        private String payeePhone;

        @Schema(description = "收款人类型", example = "PERSONAL")
        @NotNull(message = "收款人类型不能为空")
        private AccountTypeEnum accountType;

    }

}

返回参数

参数名	类型	层级	说明	备注
code	int	1	状态码
msg	string	1	请求结果
total	int	1	返回总条数
requestId	string	1	请求编号
data	object	1	返回数据
id	string	2	收款人ID
bankCardId	string	2	银行卡ID

反参示例

{
  "code": 200,
  "data": {
    "id": "131321321",
    "bankCardId": "312312321"
  },
  "msg": "业务处理成功",
  "total": null,
  "requestId": "1eb7cb0e"
}

反参对象

@Setter
@Getter
@Schema(description = "创建收款信息")
public class ApiConsignorPayeeCreateRes {

    @Schema(description = "收款人ID")
    private String id;

    @Schema(description = "银行卡ID")
    private String bankCardId;

}

收款人类型代码（AccountTypeEnum）：

Name	Message
PERSONAL	个人
ENTERPRISE	企业