Onerway
POST

Query cardholders

View as Markdown
Use this endpoint to query cardholders under the merchant account.

Request

ApiKeystringrequired
Issuing API key request header assigned by Onerway.
Example:replace_with_issuing_api_key
merchantNointegeroptional
Merchant number filter. Use only when cross-merchant query access is enabled.
Example:88888
cardholderIdintegeroptional
Cardholder ID filter.
Example:300001
clientRequestIdstringoptional
Idempotent request ID filter.
Example:REQ_CH_20260101_001
pageNumintegerrequireddefault1
Page number.
Example:1
Constraints
Range
1
pageSizeintegerrequireddefault10
Page size.
Example:10
Constraints
Range
1100

Request example

curl -X POST 'https://sandbox-api.onerway.com/api/v1/merchant/cardholder/queryCardholder' \
  -H 'ApiKey: replace_with_issuing_api_key' \
  -H 'Content-Type: application/json' \
  --data-raw '{
  "pageNum": 1,
  "pageSize": 10
}'

Response

respCodestring
Business response code. 20000 means success.
respMsgstring
Response message.
Paginated cardholder result.

Response example

{
  "respCode": "20000",
  "respMsg": "success",
  "data": {
    "records": [
      {
        "cardholderId": 300001,
        "firstName": "Alex",
        "lastName": "Chen",
        "email": "example_cardholder@example.com",
        "mobile": null,
        "mobileAreaCode": null,
        "birthDay": null,
        "nationality": "CN",
        "addressRegionCode": "CN",
        "addressStateCode": "GD",
        "addressCityCode": "SZ",
        "addressDetailLine1": "Example address line 1",
        "addressDetailLine2": null,
        "addressPostalCode": "518000",
        "remark": null
      }
    ],
    "total": 1,
    "current": 1,
    "size": 10
  }
}
No error responses are documented for this endpoint.

Update cardholder

Update an existing cardholder's profile information.

Region list

Query the list of supported regions for Issuing cardholder addresses.