Onerway
POST

Beneficiary Delete

View as Markdown
Delete a beneficiary that is no longer needed.

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
beneficiaryIdstringrequired
Beneficiary ID to delete.
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/remove' \
  -H 'Content-Type: application/json' \
  --data-raw '{
  "beneficiaryId": 1899696430844878800,
  "merchantNo": "800181",
  "sign": "12312sdfadsf"
}'

Response

respCodestring
Response code returned by Onerway.
respMsgstring
Response message returned by Onerway.
Deleted beneficiary result.

Response example

{
  "respCode": "20000",
  "respMsg": "Success",
  "data": {
    "beneficiaryId": 1899696430844878800,
    "status": "DELETED"
  }
}
No error responses are documented for this endpoint.

Beneficiary Edit

Update the profile information of an existing beneficiary.

Payer Query

Query saved payers with pagination.