Payee List Query

API Information

• Path: /api/v1/beneficiary/queryList
• Method: POST
• Content-Type: application/json

Business Description

• Used to query payee information in batches.
• Supports filtering payees by different statuses.

Request Parameters

Headers

Request Headers

Parameter	Value	Required	Description
Content-Type	application/json	Yes	Request body type

Request Body

Main Parameters

Parameter	Type	Description	Required
merchantNo	string	Merchant number (Provided by Onerway)	M
payeeStatus	string	Payee Status	N
beneficiaryId	integer	Payee ID	N
cardNumber	string	Bank account number	N
size	integer	Records per page, default 10	M
current	integer	Current page, default 1	M
sign	string	Signature	M

payeeStatus Status Description

• WAITING: Waiting
• PROCESS: Processing
• REJECT: Rejected
• PASS: Approved
• FAIL: Failed
• UNNECESSARY: Not Required
• PENDING_UPDATE: Pending Update
• DISABLE: Disabled

Request Example

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

Response Result

Response Headers

Parameter	Value	Required	Description
content-type	application/json;charset=UTF-8	Yes	Response body type

Response Parameters

Response Fields

Parameter	Type	Description
respCode	string	Response code
respMsg	string	Response message
data	object	Response data
└─records	array	Payee record list
└─total	integer	Total record count
└─size	integer	Page size
└─current	integer	Current page number

records Field Description

Each record contains the following fields:

Parameter	Type	Description
beneficiaryId	integer	Payee ID
createTime	string	Creation time
updateTime	string	Update time
merchantNo	integer	Merchant number
nationality	string	Nationality
status	string	Status
remark	string	Remark
payoutCurrency	string	Payout Currency
expireDate	string	Expiration date
bankName	string	Bank name
accountName	string	Account name
bankAddress	string	Bank address
payeeStatus	string	Payee status
accountBelong	string	Account ownership [0:Own,1:Others]
bankCountry	string	Receiving bank country
entityType	string	Entity type [0:Corporate,1:Individual]
payeeAddress	string	Payee address
paymentMethod	string	Payment Method
payeeCountry	string	Payee country
receiverInfo	string	Receiver information(JSON)
address	string	Address information(JSON)
accountInfomation	string	Account information(JSON)

Response Example

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\",\"bankName\":\"MCB BankLimited\"}"
      }
    ],
    "total": 1,
    "size": 10,
    "current": 1
  }
}

Pagination Description

• size: Number of records displayed per page
• current: Current page number
• total: Total number of records