Onerway
POST

收款方列表查询

查看 Markdown
分页查询收款人记录。

请求

merchantNostring必填
Onerway 分配的商户号。通常在沙盒或生产商户开通后，从商户后台或开户材料中获取。
示例：801129
payeeStatusstring可选
可选的收款方审核状态筛选条件。
beneficiaryIdstring可选
可选的收款方 ID 筛选条件。
merchantRefIdstring可选
可选的商户侧收款方引用 ID 筛选条件。
cardNumberstring可选
可选的银行账户或卡号筛选条件。
sizeinteger必填
每页条数。
currentinteger必填
当前页码。
signstring必填
请求签名字符串，需使用商户私钥按 Transfer 请求签名规则生成。

请求示例

curl -X POST 'https://sandbox-api.onerway.com/payout/api/v1/beneficiary/queryList' \
  -H 'Content-Type: application/json' \
  --data-raw '{
  "beneficiaryId": "12345",
  "cardNumber": "1234567890123456",
  "current": 1,
  "merchantNo": "800181",
  "merchantRefId": "beneficiary_demo_001",
  "payeeStatus": "PASS",
  "sign": "{{SIGN}}",
  "size": 10
}'

响应

respCodestring
Onerway 返回的响应码。
respMsgstring
Onerway 返回的响应信息。
分页收款方列表结果。

响应示例

{
  "respCode": "20000",
  "respMsg": "Success",
  "data": {
    "records": [
      {
        "beneficiaryId": "12345",
        "merchantRefId": "beneficiary_demo_001",
        "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": "Demo 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": "{\"addressLine1\":\"456 Oak Avenue\",\"city\":\"Los Angeles\",\"state\":\"CA\",\"postalCode\":\"90210\"}",
        "accountInfomation": "{\"cardNumber\":\"1234567890123456\",\"accountType\":\"CHECKING\",\"bankName\":\"Demo Bank\"}"
      }
    ],
    "total": 1,
    "size": 10,
    "current": 1
  }
}
该接口暂未记录错误响应。

打款凭证查询

查询并下载成功打款对应的电子凭证。

收款方编辑

更新已有收款人的资料信息。