客户创建接口

更新时间：
以 Markdown 格式查看 LLM请查看llms.txt

接口说明

接口名称：alipay.trade.customer.create

支持第三方代理调用：本接口支持第三方开发者代用户发起调用。

适用场景

客户创建接口，用于创建商户侧客户信息。

公共请求参数

参数类型是否必选最大长度描述示例值
app_idString必选32支付宝分配给开发者的应用 ID2014072300007148
methodString必选128接口名称alipay.trade.customer.create
formatString可选40仅支持JSONJSON
charsetString必选10请求使用的编码格式，如utf-8,gbk,gb2312等utf-8
sign_typeString必选10商户生成签名字符串所使用的签名算法类型，目前支持RSA2和RSA，推荐使用RSA2RSA2
signString必选344商户请求参数的签名串，详见签名详见示例
timestampString必选19发送请求的时间，格式”yyyy-MM-dd HH:mm
”		2014-07-24 03:07:50
versionString必选3调用的接口版本，固定为：1.01.0
app_auth_tokenString可选40详见应用授权概述-
biz_contentString必选-请求参数的集合，最大长度不限，除公共参数外所有请求参数都必须放在这个参数中传递，具体参照各产品快速接入文档-

业务请求参数

参数类型是否必选最大长度描述注意事项/枚举值示例值
nameString必选64客户名称-张三
descriptionString可选255客户描述-业务客户
phoneString可选50客户手机号，和客户邮箱需至少传入1个-15011112222
emailString可选255客户邮箱，和客户手机号需至少传入1个-email@antgroup.com

常见请求示例

package com.java.sdk.demo;

import com.alipay.api.AlipayApiException;
import com.alipay.api.AlipayClient;
import com.alipay.api.DefaultAlipayClient;
import com.alipay.api.AlipayConfig;
import com.alipay.api.request.AlipayTradeCustomerCreateRequest;
import com.alipay.api.response.AlipayTradeCustomerCreateResponse;
import com.alipay.api.domain.AlipayTradeCustomerCreateModel;

import com.alipay.api.FileItem;
import java.util.Base64;
import java.util.ArrayList;
import java.util.List;

public class AlipayTradeCustomerCreate {

    public static void main(String[] args) throws AlipayApiException {
        // 初始化SDK
        AlipayClient alipayClient = new DefaultAlipayClient(getAlipayConfig());

        // 构造请求参数以调用接口
        AlipayTradeCustomerCreateRequest request = new AlipayTradeCustomerCreateRequest();
        AlipayTradeCustomerCreateModel model = new AlipayTradeCustomerCreateModel();
        
        // 设置客户名称
        model.setName("张三");
        
        // 设置客户描述
        model.setDescription("业务客户");
        
        // 设置客户手机号
        model.setPhone("15011112222");
        
        // 设置客户邮箱
        model.setEmail("email@antgroup.com");
        
        request.setBizModel(model);
        // 第三方代调用模式下请设置app_auth_token
        // request.putOtherTextParam("app_auth_token", "<-- 请填写应用授权令牌 -->");

        AlipayTradeCustomerCreateResponse response = alipayClient.execute(request);
        System.out.println(response.getBody());

        if (response.isSuccess()) {
            System.out.println("调用成功");
        } else {
            System.out.println("调用失败");
            // sdk版本是"4.38.0.ALL"及以上,可以参考下面的示例获取诊断链接
            // String diagnosisUrl = DiagnosisUtils.getDiagnosisUrl(response);
            // System.out.println(diagnosisUrl);
        }
    }

    private static AlipayConfig getAlipayConfig() {
        String privateKey  = "<-- 请填写您的应用私钥，例如：MIIEvQIBADANB ... ... -->";
        String alipayPublicKey = "<-- 请填写您的支付宝公钥，例如：MIIBIjANBg... -->";
        AlipayConfig alipayConfig = new AlipayConfig();
        alipayConfig.setServerUrl("https://openapi.alipay.com/gateway.do");
        alipayConfig.setAppId("<-- 请填写您的AppId，例如：2019091767145019 -->");
        alipayConfig.setPrivateKey(privateKey);
        alipayConfig.setFormat("json");
        alipayConfig.setAlipayPublicKey(alipayPublicKey);
        alipayConfig.setCharset("UTF-8");
        alipayConfig.setSignType("RSA2");
        return alipayConfig;
    }
}
<?php
require_once '../aop/AopClient.php';
require_once '../aop/AopCertClient.php';
require_once '../aop/AopCertification.php';
require_once '../aop/AlipayConfig.php';
require_once '../aop/request/AlipayTradeCustomerCreateRequest.php';

// 初始化SDK
$alipayClient = new AopClient(getAlipayConfig());
// 构造请求参数以调用接口
$request = new AlipayTradeCustomerCreateRequest();
$model = array();

// 设置客户名称
$model['name'] = "张三";

// 设置客户描述
$model['description'] = "业务客户";

// 设置客户手机号
$model['phone'] = "15011112222";

// 设置客户邮箱
$model['email'] = "email@antgroup.com";

$request->setBizContent(json_encode($model,JSON_UNESCAPED_UNICODE));
// 如果是第三方代调用模式，请设置app_auth_token（应用授权令牌）
$responseResult = $alipayClient->execute($request, null, "<-- 请填写应用授权令牌 -->", null);
$responseApiName = str_replace(".","_",$request->getApiMethodName())."_response";
$response = $responseResult->$responseApiName;
if(!empty($response->code)&&$response->code==10000){
    echo("调用成功");
}
else{
    echo("调用失败");
}

function getAlipayConfig()
{
    $privateKey  = '<-- 请填写您的应用私钥，例如：MIIEvQIBADANB ... ... -->';
    $alipayPublicKey = '<-- 请填写您的支付宝公钥，例如：MIIBIjANBg... -->';
    $alipayConfig = new AlipayConfig();
    $alipayConfig->setServerUrl('https://openapi.alipay.com/gateway.do');
    $alipayConfig->setAppId('<-- 请填写您的AppId，例如：2019091767145019 -->');
    $alipayConfig->setPrivateKey($privateKey);
    $alipayConfig->setFormat('json');
    $alipayConfig->setAlipayPublicKey($alipayPublicKey);
    $alipayConfig->setCharset('UTF-8');
    $alipayConfig->setSignType('RSA2');
    return $alipayConfig;
}
using System;
using System.Collections.Generic;
using Aop.Api;
using Aop.Api.Request;
using Aop.Api.Response;
using Aop.Api.Domain;
using Aop.Api.Util;
namespace SdkDemoTest
{
    public class AlipayTradeCustomerCreate
    {
        public static void Main(string[] args) 
        {
            // 初始化SDK
            IAopClient alipayClient = new DefaultAopClient(GetAlipayConfig());
            // 构造请求参数以调用接口
            AlipayTradeCustomerCreateRequest request = new AlipayTradeCustomerCreateRequest();
            AlipayTradeCustomerCreateModel model = new AlipayTradeCustomerCreateModel();
            
            // 设置客户名称
            model.Name = "张三";
            
            // 设置客户描述
            model.Description = "业务客户";
            
            // 设置客户手机号
            model.Phone = "15011112222";
            
            // 设置客户邮箱
            model.Email = "email@antgroup.com";
            
            request.SetBizModel(model);
            // 第三方代调用模式下请设置app_auth_token
            // request.PutOtherTextParam("app_auth_token", "<-- 请填写应用授权令牌 -->");

            AlipayTradeCustomerCreateResponse response = alipayClient.Execute(request);

            if(!response.IsError)
            {
                Console.WriteLine("调用成功");
            }
            else
            {
                Console.WriteLine("调用失败");
            }
        }

        private static AlipayConfig GetAlipayConfig()
        {
            string privateKey  = "<-- 请填写您的应用私钥，例如：MIIEvQIBADANB ... ... -->";
            string alipayPublicKey = "<-- 请填写您的支付宝公钥，例如：MIIBIjANBg... -->";
            AlipayConfig alipayConfig = new AlipayConfig();
            alipayConfig.ServerUrl = "https://openapi.alipay.com/gateway.do";
            alipayConfig.AppId = "<-- 请填写您的AppId，例如：2019091767145019 -->";
            alipayConfig.PrivateKey = privateKey;
            alipayConfig.Format = "json";
            alipayConfig.AlipayPublicKey = alipayPublicKey;
            alipayConfig.Charset = "UTF-8";
            alipayConfig.SignType = "RSA2";
            return alipayConfig;
        }
    }
}
curl 'https://openapi.alipay.com/gateway.do?charset=UTF-8&method=alipay.trade.customer.create&format=json&sign=${sign}&app_id=${appid}&version=1.0&sign_type=RSA2&timestamp=${now}' \
 -F 'app_auth_token=${app_auth_token}' \
 -F 'biz_content={
    "name":"张三",
    "description":"业务客户",
    "phone":"15011112222",
    "email":"email@antgroup.com"
}'

公共响应参数

参数类型是否必选描述示例值
codeString必选网关返回码，详见文档40004
msgString必选网关返回码描述，详见文档Business Failed
sub_codeString可选业务返回码，参见具体的 API 接口文档-
sub_msgString可选业务返回码描述，参见具体的 API 接口文档-
signString必选签名，详见文档DZXh8eeTuAHoYE3w1J…

业务响应参数

参数类型是否必选最大长度描述注意事项/枚举值示例值
customer_idString必选32客户id-202603230010000006783

响应示例

{
    "alipay_trade_customer_create_response":{
        "code":"10000",
        "msg":"Success",
        "customer_id":"202603230010000006783"
    },
    "sign":"ERITJKEIJKJHKKKKKKKHJEREEEEEEEEEEE"
}
{"alipay_trade_customer_create_response":{"code":"20000","msg":"Service Currently Unavailable","sub_code":"isp.unknow-error","sub_msg":"系统繁忙"},"sign":"ERITJKEIJKJHKKKKKKKHJEREEEEEEEEEEE"}

业务错误码

错误码错误描述解决方案
SYSTEM_ERROR系统繁忙服务器异常 可能发生了网络或者系统异常，导致服务调用失败，商户可以用同样的请求发起重试
INVALID_PARAMETER参数有误请根据接口返回的参数非法的具体错误信息，修改参数后进行重试