customer

维护客户信息

创建客户接口

创建客户接口

POST//unknown/V2022-03/customers

Header parameters

Body

application/json

客户对象

descriptionstring(100)

客户描述；最大长度为100，如：VIP Customer

Example: "VIP Customer"

email*string(200)

邮箱；最小长度为2，最大长度为200；如：[e-mail]

Example: "[e-mail]"

firstNamestring(100)

名；最小长度为1，最大长度为100，如：asia

Example: "asia"

lastNamestring(50)

姓；最小长度为1，最大长度为50，如：bill

Example: "bill"

phonestring(50)

电话；最小长度为2，最大长度为50；如：13212344321

Example: 13212344321

Response

200

OK

Body

*/*response body

codestring

返回码

Example: "success"

messagestring

返回信息

Example: "message response"

dataCustomerResp

Request

JavaScriptCurlPython

const response = await fetch('//unknown/V2022-03/customers', {
    method: 'POST',
    headers: {
      "gateway-no": "text",
      "request-id": "text",
      "request-time": "text",
      "sign-info": "text",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "email": "[e-mail]"
    }),
});
const data = await response.json();

Response

200

{
  "code": "success",
  "message": "message response",
  "data": {
    "created": "2022-08-11T10:10:10",
    "customerId": "cus_1420997690607206400",
    "description": "description info",
    "email": "[e-mail]",
    "firstName": "名",
    "lastName": "姓",
    "phone": "13200001111"
  }
}

创建客户接口请求报文示例

createCustomer.sh

curl --request POST \
  --url https://{paymentApiUrl}/V2022-03/customers \
  --header 'Content-Type: application/json' \
  --header 'request-id: 58675' \
  --header 'request-time: 1651888520935' \
  --header 'gateway-no: 12345001' \
  --header 'sign-info: 787966BF2479A1BE8E1886CD18E6919447FAF4F357E7056188D4F035661B822B' \
  --data'{
    "description": "It's VIP 40210 customer",
    "email": "[e-mail]",
    "firstName": "Smfrvi",
    "lastName": "Txwtbs",
    "phone": "13924343678"
}'

获取客户接口

获取客户接口

GET//unknown/V2022-03/customers/{customerId}

Path parameters

customerId*string

客户id，最大长度100，如：cus_1420997690607206400

Header parameters

Response

200

OK

Body

*/*response body

codestring

返回码

Example: "success"

messagestring

返回信息

Example: "message response"

dataCustomerResp

Request

JavaScriptCurlPython

const response = await fetch('//unknown/V2022-03/customers/{customerId}', {
    method: 'GET',
    headers: {
      "gateway-no": "text",
      "request-id": "text",
      "request-time": "text",
      "sign-info": "text"
    },
});
const data = await response.json();

Response

200

{
  "code": "success",
  "message": "message response",
  "data": {
    "created": "2022-08-11T10:10:10",
    "customerId": "cus_1420997690607206400",
    "description": "description info",
    "email": "[e-mail]",
    "firstName": "名",
    "lastName": "姓",
    "phone": "13200001111"
  }
}

获取客户接口请求报文示例

getCustomer.sh

curl --request GET \
  --url https://{paymentApiUrl}/V2022-03/customers/cus_1526753334131306496 \
  --header 'Content-Type: application/json' \
  --header 'request-id: 58675' \
  --header 'request-time: 1651888520935' \
  --header 'gateway-no: 12345001' \
  --header 'sign-info: 787966BF2479A1BE8E1886CD18E6919447FAF4F357E7056188D4F035661B822B' \

结果对象描述（创建客户接口、获取客户接口）

property name	type	description
code	String	返回码
message	String	返回信息
data	Object	数据对象
customerId	String	客户ID
email	String	邮箱
firstName	String	名
lastName	String	姓
phone	String	电话
description	String	描述
created	String	创建客户时间

获取所有客户接口

获取所有客户接口

GET//unknown/V2022-03/customers

Query parameters

Header parameters

Response

200

OK

Body

*/*response body

codestring

返回码

Example: "success"

messagestring

返回信息

Example: "message response"

dataPageResultResp«CustomerResp»

Request

JavaScriptCurlPython

const response = await fetch('//unknown/V2022-03/customers', {
    method: 'GET',
    headers: {
      "gateway-no": "text",
      "request-id": "text",
      "request-time": "text",
      "sign-info": "text"
    },
});
const data = await response.json();

Response

200

{
  "code": "success",
  "message": "message response",
  "data": {
    "page": {
      "pageIndex": 1,
      "pageSize": 100,
      "total": 1000
    },
    "list": [
      {
        "created": "2022-08-11T10:10:10",
        "customerId": "cus_1420997690607206400",
        "description": "description info",
        "email": "[e-mail]",
        "firstName": "名",
        "lastName": "姓",
        "phone": "13200001111"
      }
    ]
  }
}

批量获取客户接口请求报文示例

getCustomerList.sh

curl --request GET \
  --url https://{paymentApiUrl}/V2022-03/customers?pageIndex=1&pageSize=100 \
  --header 'Content-Type: application/json' \
  --header 'request-id: 58675' \
  --header 'request-time: 1651888520935' \
  --header 'gateway-no: 12345001' \
  --header 'sign-info: 787966BF2479A1BE8E1886CD18E6919447FAF4F357E7056188D4F035661B822B' \

结果对象属性描述（获取所有客户接口）

property name	type	description
code	String	返回码
message	String	返回信息
data	Object	数据对象
page	Object	分页对象
pageIndex	Integer	当前页
pageSize	Integer	每页数据条数
total	Integer	总条数
list	Array	列表
customerId	String	客户ID
email	String	邮箱
firstName	String	名
lastName	String	姓
phone	String	电话
description	String	描述
created	String	创建客户时间

删除客户接口

删除客户接口

DELETE//unknown/V2022-03/customers/{customerId}

Path parameters

customerId*string

客户id，最大长度100，如：cus_1420997690607206400

Header parameters

Response

200

OK

Body

*/*response body

codestring(7)

返回码；最大长度为7，如：success

Example: "success"

messagestring(22)

返回信息；最大长度为22，如：message response

Example: "message response"

dataobject

返回数据

Request

JavaScriptCurlPython

const response = await fetch('//unknown/V2022-03/customers/{customerId}', {
    method: 'DELETE',
    headers: {
      "gateway-no": "text",
      "request-id": "text",
      "request-time": "text",
      "sign-info": "text"
    },
});
const data = await response.json();

Response

200

{
  "code": "success",
  "message": "message response"
}

删除客户接口请求报文示例

curl --request DELETE \
  --url https://{paymentApiUrl}/V2022-03/customers/cus_1526753334131306496 \
  --header 'Content-Type: application/json' \
  --header 'request-id: 58675' \
  --header 'request-time: 1651888520935' \
  --header 'gateway-no: 12345001' \
  --header 'sign-info: 787966BF2479A1BE8E1886CD18E6919447FAF4F357E7056188D4F035661B822B' \

结果对象描述（删除客户接口）

property name	type	description
code	String	返回码，"00000"表示删除成功
message	String	返回信息
data	Object	返回null