收款方列表查询

接口信息

• 路径: /api/v1/beneficiary/queryList
• 方法: POST
• Content-Type: application/json

业务说明

• 用于批量查询收款人信息
• 可以筛选不同状态的收款人

请求参数

Headers

请求头

参数名	值	必填	说明
Content-Type	application/json	是	请求体类型

Request Body

主要参数

参数名	类型	说明	必填
merchantNo	string	商户号（由oneway提供）	M
payeeStatus	string	收款人状态	N
beneficiaryId	integer	收款人ID	N
cardNumber	string	银行账号	N
size	integer	每页条数，默认 10	M
current	integer	当前页，默认 1	M
sign	string	签名	M

payeeStatus 状态说明

• WAITING: 等待中
• PROCESS: 处理中
• REJECT: 已拒绝
• PASS: 已通过
• FAIL: 失败
• UNNECESSARY: 不需要
• PENDING_UPDATE: 待更新
• DISABLE: 已禁用

请求示例

Request

{
  "merchantNo": "800181",
  "payee": "John Smith",
  "bankAccount": "1234567890123456",
  "payoutCurrency": "USD",
  "payeeStatus": "PASS",
  "startTime": "2024-01-01 00:00:00",
  "endTime": "2024-12-31 23:59:59",
  "phone": "+1234567890",
  "beneficiaryId": 12345,
  "bankCountry": "US",
  "cardNumber": "1234567890123456",
  "size": "10",
  "current": "1",
  "sign": "ABC123DEF456GHI789JKL012MNO345PQR678STU901VWX234YZ"
}

响应结果

响应头 Headers

参数名	值	必填	说明
content-type	application/json;charset=UTF-8	是	响应体类型

响应参数

响应字段

参数名	类型	说明
respCode	string	响应码
respMsg	string	响应信息
data	object	响应数据
└─records	array	收款人记录列表
└─total	integer	总记录数
└─size	integer	每页大小
└─current	integer	当前页码

records 字段说明

每个记录包含以下字段：

参数名	类型	说明
beneficiaryId	integer	收款人ID
createTime	string	创建时间
updateTime	string	更新时间
merchantNo	integer	商户号
nationality	string	国籍
status	string	状态
remark	string	备注
payoutCurrency	string	出款币种
expireDate	string	过期时间
bankName	string	银行名称
accountName	string	账户名称
bankAddress	string	银行地址
payeeStatus	string	收款人状态
accountBelong	string	账号所属 [0:自有,1:他人]
bankCountry	string	收款行国家
entityType	string	主体类型 [0:企业,1:个人]
payeeAddress	string	收款方地址
paymentMethod	string	付款方式
payeeCountry	string	收款方国家
receiverInfo	string	收款人信息(JSON)
address	string	地址信息(JSON)
accountInfomation	string	账户信息(JSON)

响应示例

Response

{
  "respCode": "20000",
  "respMsg": "Success",
  "data": {
    "records": [
      {
        "beneficiaryId": 12345,
        "createTime": "2024-01-15 10:30:00",
        "updateTime": "2024-01-20 14:45:00",
        "merchantNo": 800181,
        "nationality": "US",
        "status": "ACTIVE",
        "remark": "Primary beneficiary account",
        "payoutCurrency": "USD",
        "expireDate": "2024-12-31 23:59:59",
        "bankName": "Chase Bank",
        "accountName": "John Smith",
        "bankAddress": "123 Main Street, New York, NY 10001",
        "payeeStatus": "PASS",
        "accountBelong": "0",
        "bankCountry": "US",
        "entityType": "1",
        "payeeAddress": "456 Oak Avenue, Los Angeles, CA 90210",
        "paymentMethod": "BANK_TRANSFER",
        "payeeCountry": "US",
        "receiverInfo": "{\"firstName\":\"John\",\"lastName\":\"Smith\",\"email\":\"john.smith@example.com\"}",
        "address": "{\"street\":\"456 Oak Avenue\",\"city\":\"Los Angeles\",\"state\":\"CA\",\"zipCode\":\"90210\"}",
        "accountInfomation": "{\"routingNumber\":\"021000021\",\"accountNumber\":\"1234567890123456\",\"accountType\":\"CHECKING\"}"
      }
    ],
    "total": 1,
    "size": 10,
    "current": 1
  }
}

分页说明

• size: 每页显示的记录数
• current: 当前页码
• total: 总记录数