Onerway
POST

Payer Query

View as Markdown
Query saved payers with pagination.

Request

sizeintegerrequired
Page size. Use -1 to request all records when supported.
currentintegerrequired
Current page number.
columnstringrequired
Sort column name.
ascbooleanrequired
Whether to sort in ascending order.
idstringoptional
Optional payer ID filter.
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
subEntityTypestringoptional
Optional payer entity type filter.
companyNamestringoptional
Optional company name filter.
companyNameEnstringoptional
Optional English company name filter.
firstNamestringoptional
Optional first-name filter.
lastNamestringoptional
Optional last-name filter.
countrystringoptional
Optional country filter.
registerNostringoptional
Optional registration-number filter.
idTypestringoptional
Optional identity-document type filter.
registerDatestringoptional
Optional registration-date filter.
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/acct/queryPayer' \
  -H 'Content-Type: application/json' \
  --data-raw '{
  "asc": false,
  "column": "create_time",
  "current": 1,
  "merchantNo": "801129",
  "sign": "{{SIGN}}",
  "size": 10
}'

Response

respCodestring
Response code returned by Onerway.
respMsgstring
Response message returned by Onerway.
Paged payer query result.

Response example

{
  "respCode": "20000",
  "respMsg": "Success",
  "data": {
    "records": [
      {
        "id": "1984096429476806656",
        "merchantNo": "801129",
        "subEntityType": "0",
        "country": "GB"
      }
    ],
    "total": 1,
    "size": 10,
    "current": 1
  }
}
No error responses are documented for this endpoint.

Beneficiary Delete

Delete a beneficiary that is no longer needed.

Payer Edit

Update an existing payer profile.