Onerway
POST

Payer Edit

View as Markdown
Update an existing payer profile.

Request

idstringrequired
Payer ID to update.
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
companyNameEnstringoptional
English company name for business payers.
companyNamestringoptional
Local company name for business payers.
countrystringrequired
Payer country.
addressEn1stringrequired
Primary address line of the payer.
addressEn2stringoptional
Secondary address line.
addressEn3stringoptional
Tertiary address line.
registerNostringoptional
Registration number.
registerDatestringoptional
Registration date.
postcodestringrequired
Postal code.
emailstringrequired
Email address.
areaCodestringrequired
Phone area code.
phoneNumberstringrequired
Phone number.
statestringrequired
State or province.
citystringrequired
City.
subEntityTypestringoptional
Payer entity type.
firstNamestringoptional
First name for individual payers.
lastNamestringoptional
Last name for individual payers.
idTypestringrequired
Identity-document type.
idNumberstringrequired
Identity-document number.
birthDatestringoptional
Birth date for individual payers.
idValidDateFromstringoptional
Identity-document valid-from date.
idValidDateTostringrequired
Identity-document expiry date.
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/editPayer' \
  -H 'Content-Type: application/json' \
  --data-raw '{
  "addressEn1": "Nanshan Science & Technology Park, Shenzhen",
  "addressEn2": "2all",
  "addressEn3": "3",
  "areaCode": "+86",
  "city": "London",
  "companyName": "卡玛有限公司 &sunshine",
  "companyNameEn": "keyma LTD.",
  "country": "GB",
  "email": "324321@qq.com",
  "id": 1984096429476806700,
  "idType": "2",
  "idValidDateFrom": "2006-08-04",
  "idValidDateTo": "2046-08-04",
  "merchantNo": 801129,
  "phoneNumber": "15072871023",
  "postcode": "518057",
  "registerDate": "2005-08-04",
  "registerNo": "4563456546",
  "sign": "d2ea92efff636320122021f65b613201403f6d34334cfbc7e589ce9f842282q4",
  "state": "London",
  "subEntityType": "0"
}'

Response

respCodestring
Response code returned by Onerway.
respMsgstring
Response message returned by Onerway.
dataobject
Update result placeholder.

Response example

{
  "respCode": "20000",
  "respMsg": "Success",
  "data": null
}
No error responses are documented for this endpoint.

Payer Query

Query saved payers with pagination.

Payer Delete

Delete a payer that is no longer needed.