Skip to content

查询客户列表

功能简述

  • 查询客户列表

查询客户列表 API

请求 URL

  • /payee/custom/list

请求方式

  • GET

请求参数

请求参数如下:

参数必填类型默认值描述
pagenonumber1页码,最多支持 1000 页
pagesizenumber20每页显示条数,最多支持 100 条
starttimenumber-客户创建开始时间,秒级时间戳
endtimenumber-客户创建结束时间,秒级时间戳
mercustomidsstring-商户客户 ID,多个 ID 以英文逗号分割,长度限制 512 字符,示例:u001, u002
customidsstring-系统客户 ID,多个 ID 以英文逗号分割,长度限制 512 字符,示例:1187, 2f131
identitystring-身份证号(敏感信息,需系统公钥加密处理),长度限制 64 字符
cardnostring-银行账户(敏感信息,需系统公钥加密处理),要求为数字,长度限制 13 ~ 19 字符
bankcodestring-银行 CODE
ibanaccountstring-IBAN,字母和数字组成,长度限制 34 字符
name_estring-客户英文名称,支持模糊查询,长度限制 64 字符
statusnumber-客户状态
stcaccountstring-STCPay 账户(敏感信息,需系统公钥加密处理),支持格式:
5xxxxxxxx
9665xxxxxxxx
+9665xxxxxxxx
05xxxxxxxx
mobilestring-客户手机号(敏感信息,需系统公钥加密处理),支持格式:
5xxxxxxxx
9665xxxxxxxx
+9665xxxxxxxx
05xxxxxxxx

响应参数

响应参数如下:

  • Response Body
参数名类型描述
customidstring系统客户 ID
mercustomidstring商户客户 ID
name_estring客户英文名称
name_astring客户阿拉伯文名称
mobilestring客户手机号
addressstring客户银行卡绑定的地址信息
identitystring身份证号(敏感信息,使用商户公钥加密处理)
identitypicstring身份证照片 URL(敏感信息,使用商户公钥加密处理)
signpicstring签名照片 URL(敏感信息,使用商户公钥加密处理)
banknamestring银行名称
bankcodestring银行 CODE
cardnostring银行账户(敏感信息,使用商户公钥加密处理)
ibanaccountstringIBAN
swiftcodestring客户银行账户对应的 Swift Code
stcaccountstringSTCPay 账户(敏感信息,使用商户公钥加密处理)
statusnumber客户状态
statusdescstring客户状态说明
autoapprovalnumber是否开启自动审批:
0:不开启
1:开启
otpappnamestring发送 OTP 验证的产品名称
demand_perfectionarray用户当前待完善哪些资料
created_atnumber创建时间
updated_atnumber更新时间

响应参数示例

json
{
  "code": 200,
  "message": "Request succeeded.",
  "data": [
    {
      "customid": "12ad4",
      "mercustomid": "u004",
      "name_e": "usera",
      "name_a": "usera",
      "mobile": "Dl6W1H0FxS/M86t9beRVietvkH2ZwIZNO4AwVJI5BGJfh/hJ83n3oXkfABfYCH/4SgklJVQ7aSqiHQ+8LIbUh5ycjfqTCGRpKgfk5Ae2/9NRsOpcnfl9GMo2oP4AiS4NEdJBybtSm+gDCxRrDqyAIpLq6ycXJT3BGqtKPu1xsqzdYQuJovdERg/8GqKn57r2MI3jXGIhdInL61SNuAFImOTVCBXA0ZXsho0Txtp1zJj+t6raQbCvynNgYHNIqrUh6Kta8mezJGqfLtw0RE7VzgWGFKb3caEzdAZERF3BHx49qR72MvIHtRBpoxfvf9VB9cZf2yn/+yo9iaDqMLxsug==",
      "address": "Saudi Arabia",
      "identity": "hg3TiMx12VsW+m0a60FpIbU6k+ppfrWz5VAzpzRr8wOasTELnFuQqRO5bGLn/SUK8FhpfLqI+Mf9GqMFuKk7Ogh6izh2UkTbg5/kO8unT2pNsI1vqSuAKJP2QeMzKBORWAn878fLvNf10Y7drMimwP+FU3ChMVREaPMoosOIWdsDh13mFce6IfDQUBXqcHDeUZAdRZMvIyUBAAhp60d4J83BXuvZeQkrxKMnD34AhO0/gABRqiSWAWgNGv6UgBkiH0siLlevyKt674HZSRaMGh4tv5KXx/qWVTUGI7JGes5vh6iO1gy+5G6bd8amfUQ+J2W3UysyZGcNLrtBq5VfpQ==",
      "identitypic": "",
      "signpic": "",
      "bankname": "Riyad Bank",
      "bankcode": "1174c",
      "cardno": "OAz0pmLB/wKtKvyNHte+Bsq4D3FlKt5snflmh15PnyIV3nyuoLs10Xm5Eg2erq5jgeeRdrQsBqAF5FeUfthS4NaAtgVVTlOpe5vFLtt3RL6BQ1i829Fx7rSCjdoYXpBDdBG7D85D4OnNgJpSxXvAJMK8qZDZv4XPxwAgcH5b+VCu138kpOaBjDuzl9dVOgoX69xIBWrd+kkD7btGytKD4H+jvU+NK+/Lfo0I61gzc/xYe5VEwFxlH4Cr/TeMhH1opwM6F2V+Mi45JL58DprZx7N0TtPaUOyhioZn6MdbNlJoI1bLARjMJIyt6sB1ZsglLChDRLFDhkLonWrlYxZWhA==",
      "ibanaccount": "1234567892",
      "swiftcode": "ABNACNSHXXX",
      "stcaccount": "",
      "status": 4,
      "statusdesc": "2023-06-15 06:12:54",
      "autoapproval": 1,
      "otpappname": "test",
      "demand_perfection": ["identitypic"],
      "created_at": 1686809574,
      "updated_at": 1686809574
    }
  ],
  "sensitiveFields": [
    "identity",
    "identitypic",
    "signpic",
    "stcaccount",
    "mobile",
    "cardno"
  ],
  "requestId": "5B7C31E52D37FF42627F18A20BD9AFB2"
}