Onerway
POST

Beneficiary List Query

View as Markdown
Query beneficiary records with pagination.

Request

merchantNostringrequired
Merchant number assigned by Onerway. Retrieve it from the merchant portal or onboarding material after your sandbox or production account is created.
Example:801129
payeeStatusstringoptional
Optional beneficiary review-status filter.
beneficiaryIdstringoptional
Optional beneficiary ID filter.
merchantRefIdstringoptional
Optional merchant-side beneficiary reference ID filter.
cardNumberstringoptional
Optional bank-account or card-number filter.
sizeintegerrequired
Page size.
currentintegerrequired
Current page number.
signstringrequired
Request signature string. Generate it according to the Transfer request-signing rules with your merchant private key.

Request example

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

Response

respCodestring
Response code returned by Onerway.
respMsgstring
Response message returned by Onerway.
Paged beneficiary list result.

Response example

{
  "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
  }
}
No error responses are documented for this endpoint.

Transfer Voucher Query

Query and download the electronic voucher for a successful transfer.

Beneficiary Edit

Update the profile information of an existing beneficiary.