customer

维护客户信息

创建客户接口

post

创建客户接口

Header parameters

gateway-nostring(16)Required

网关号

request-idstring(64)Required

请求id，30分钟之内唯一

request-timestring(16)Required

时间戳，以毫秒（ms）为单位，请求误差不能超过10分钟

sign-infostring(255)Required

验签字段，具体加签方式请参阅数据签名过程章节

Body

application/json

descriptionstring(100)Optional

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

Example: VIP Customer

emailstring(200)Required

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

Example: [e-mail]

firstNamestring(100)Optional

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

Example: asia

lastNamestring(50)Optional

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

Example: bill

phonestring(50)Optional

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

Example: 13212344321

Responses

200

OK

*/*

post

/V2022-03/customers

HTTPcURLJavaScriptPython

POST /V2022-03/customers HTTP/1.1
Host: {paymentApiUrl}
gateway-no: null
request-id: null
request-time: null
sign-info: null
Content-Type: application/json
Accept: */*
Content-Length: 110

{
  "description": "VIP Customer",
  "email": "[e-mail]",
  "firstName": "asia",
  "lastName": "bill",
  "phone": 13212344321
}

200

OK

{
  "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

获取客户接口

Path parameters

customerIdstring(100)Required

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

Header parameters

gateway-nostring(16)Required

网关号

request-idstring(64)Required

请求id，30分钟之内唯一

request-timestring(16)Required

时间戳，以毫秒（ms）为单位，请求误差不能超过10分钟

sign-infostring(255)Required

验签字段，具体加签方式请参阅数据签名过程章节

Responses

200

OK

*/*

get

/V2022-03/customers/{customerId}

HTTPcURLJavaScriptPython

GET /V2022-03/customers/{customerId} HTTP/1.1
Host: {paymentApiUrl}
gateway-no: null
request-id: null
request-time: null
sign-info: null
Accept: */*

200

OK

{
  "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

获取所有客户接口

Query parameters

pageIndexInteger(10)Optional

当前页码，从1开始，最长10位，默认为1

pageSizeInteger(4)Optional

每页显示记录数，最大1000，默认10

Header parameters

gateway-nostring(16)Required

网关号

request-idstring(64)Required

请求id，30分钟之内唯一

request-timestring(16)Required

时间戳，以毫秒（ms）为单位，请求误差不能超过10分钟

sign-infostring(255)Required

验签字段，具体加签方式请参阅数据签名过程章节

Responses

200

OK

*/*

get

/V2022-03/customers

HTTPcURLJavaScriptPython

GET /V2022-03/customers HTTP/1.1
Host: {paymentApiUrl}
gateway-no: null
request-id: null
request-time: null
sign-info: null
Accept: */*

200

OK

{
  "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

删除客户接口

Path parameters

customerIdstring(100)Required

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

Header parameters

gateway-nostring(16)Required

网关号

request-idstring(64)Required

请求id，30分钟之内唯一

request-timestring(16)Required

时间戳，以毫秒（ms）为单位，请求误差不能超过10分钟

sign-infostring(255)Required

验签字段，具体加签方式请参阅数据签名过程章节

Responses

200

OK

*/*

delete

/V2022-03/customers/{customerId}

HTTPcURLJavaScriptPython

DELETE /V2022-03/customers/{customerId} HTTP/1.1
Host: {paymentApiUrl}
gateway-no: null
request-id: null
request-time: null
sign-info: null
Accept: */*

200

OK

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

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

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