Onerway
POST

Beneficiary Edit

View as Markdown
Update the profile information of an existing beneficiary.

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
merchantRefIdstringoptional
Merchant-side beneficiary reference ID.
beneficiaryIdstringrequired
Beneficiary ID to update.
bankCountrystringrequired
Destination country of the beneficiary.
payoutCurrencystringrequired
Beneficiary payout currency.
entityTypestringrequired
Beneficiary entity type. 0 for business and 1 for individual.
paymentMethodstringrequired
Configured payout method.
Beneficiary identity information encoded as a JSON string.
Beneficiary address information encoded as a JSON string.
Beneficiary account information encoded as a JSON string.
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/edit' \
  -H 'Content-Type: application/json' \
  --data-raw '{
  "accountInfomation": "{\"cardNumber\":null,\"accountType\":null,\"swiftCode\":null,\"bankName\":\"MCB BankLimited\",\"sortCode\":null,\"branchCode\":null,\"bankHolderName\":null,\"walletType\":\"EASYPAISA\",\"walletPhone\":\"03079770877\",\"pickUpBankName\":null,\"pickUpBankBranchName\":null,\"pickUpBankBranchId\":null,\"pickUpBankBranchAddress\":null}",
  "address": "{\"countryCode\":null,\"state\":\"NY\",\"city\":\"Adin\",\"townName\":null,\"addressLine1\":\"testdsgddfs1233\",\"addressLine2\":null,\"addressLine3\":null,\"postalCode\":\"10005\"}",
  "bankCountry": "PK",
  "beneficiaryId": "1984102812163112960",
  "entityType": "1",
  "merchantNo": 801129,
  "paymentMethod": "E_WALLET",
  "payoutCurrency": "PKR",
  "receiverInfo": "{\"companyName\":\"helloBoy\",\"lastName\":\"testData\",\"firstName\":\"betaData\",\"areaCode\":\"+92\",\"phone\":\"2313019452\",\"birthDate\":\"1990-12-04\",\"email\":\"jing.yuan1@onerway.com\",\"identityType\":\"SSN\",\"vatNumber\":\"8859884832\"}",
  "sign": "d2ea92efff636320122021f65b613201403f6d34334cfbc7e589ce9f842284a3"
}'

Response

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

Response example

{
  "respCode": "20000",
  "respMsg": null,
  "data": {
    "beneficiaryId": "1984102812163112960",
    "payeeStatus": "unnecessary"
  }
}
No error responses are documented for this endpoint.

Beneficiary List Query

Query beneficiary records with pagination.

Beneficiary Delete

Delete a beneficiary that is no longer needed.