Onerway
POST

Payer Add

View as Markdown
Create a payer that can be reused in later Transfer payouts.

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
subEntityTypestringrequired
Payer entity type. 0 for business and 1 for individual. This choice determines which business or personal identity fields must be supplied.
Example:0
countrystringrequired
Country of the payer.
Example:GB
companyNameEnstringoptional
English company name for business payers.
companyNamestringoptional
Local company name for business payers.
addressEn1stringrequired
Primary address line of the payer.
postcodestringrequired
Postal code of the payer.
emailstringrequired
Payer email address.
areaCodestringrequired
Phone area code.
phoneNumberstringrequired
Phone number of the payer.
statestringrequired
State or province of the payer.
citystringrequired
City of the payer.
idTypestringrequired
Payer identity-document type. The required value depends on whether the payer is a business or an individual.
idNumberstringrequired
Payer identity-document number.
idValidDateTostringrequired
Payer 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/addPayer' \
  -H 'Content-Type: application/json' \
  --data-raw '{
  "addressEn1": "Nanshan Science & Technology Park, Shenzhen",
  "areaCode": "+86",
  "city": "London",
  "companyName": "Demo Company Ltd",
  "companyNameEn": "Demo Company Ltd",
  "country": "GB",
  "email": "payer@example.com",
  "idNumber": "4563456546",
  "idType": "2",
  "idValidDateTo": "2046-08-04",
  "merchantNo": "801129",
  "phoneNumber": "15072871023",
  "postcode": "518057",
  "sign": "{{SIGN}}",
  "state": "London",
  "subEntityType": "0"
}'

Response

respCodestring
Response code returned by Onerway.
respMsgstring
Response message returned by Onerway.
datastring
Created payer ID.

Response example

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

Beneficiary Details Query

Query the profile details and review status of a single beneficiary.

Transfer with beneficiary ID

Submit a Transfer payout by using an approved beneficiary ID.