Payee Edit
API Information
- Path:
/api/v1/beneficiary/edit - Method: POST
- Content-Type: application/json
Business Description
- Used when payee information needs to be updated. The edited payee information may require re-
Duplicate Creation Notice
- The system returned an error status without a detailed message. This request may have attempted to create a payee that already exists.
- Please use the cardNumber to call the Payee List Query API , retrieve the existing payeeId, and use that payeeId for subsequent payout operations.
Request Parameters
Headers
Request Headers
| Parameter | Value | Required | Description |
|---|---|---|---|
| Content-Type | application/json | Yes | Request body type |
Request Body
Main Parameters
| Parameter | Type | Description | Required |
|---|---|---|---|
| merchantNo | string | Merchant number (Provided by Onerway) | M |
| beneficiaryId | Long | Payee ID | M |
| bankCountry | string(12) | Payout country | M |
| payoutCurrency | string(128) | Payout currency | M |
| entityType | string(1) | Entity type [0:corporate,1:individual] | M |
| paymentMethod | string | Payment Method | M |
| receiverInfo | string(1024) | Recipient information | M |
| address | string(1024) | Address information | M |
| accountInfomation | string(1024) | Account information | M |
| sign | string | Signature | M |
Request Example
json
{
"method": null,
"merchantNo": "800353",
"bankCountry": "PK",
"payoutCurrency": "PKR",
"entityType": "1",
"paymentMethod": "E_WALLET",
"sign": "ABC123DEF456GHI789JKL012MNO345PQR678STU901VWX2356Z",
"receiverInfo": "{\"companyName\":\"MENG22\",\"lastName\":\"JAHAN\",\"firstName\":\"HAMIDA\",\"areaCode\":\"+92\",\"phone\":\"1719819439\",\"birthDate\":\"1991-12-04\",\"email\":\"gqx@onerway.com\",\"identityType\":\"SSN\",\"vatNumber\":\"8859884831\"}",
"address": "{\"countryCode\":null,\"state\":\"NY\",\"city\":\"Adin\",\"townName\":null,\"postalCode\":\"10005\"}",
"accountInfomation": "{\"cardNumber\":null,\"accountType\":null,\"swiftCode\":null,\"bankName\":\"MCB BankLimited\",\"sortCode\":null,\"branchCode\":null,\"bankHolderName\":null,\"walletType\":\"BKASH\",\"walletPhone\":\"+8801719819439\",\"pickUpBankName\":null,\"pickUpBankBranchName\":null,\"pickUpBankBranchId\":null,\"pickUpBankBranchAddress\":null}",
"beneficiaryId": 1950028569679110144
}Response Results
Response Headers
| Parameter | Value | Required | Description |
|---|---|---|---|
| content-type | application/json;charset=UTF-8 | Yes | Response body type |
Response Parameters
| Parameter | Type | Description |
|---|---|---|
| respCode | string | Response code |
| respMsg | string | Response message |
| data | object | Response data |
| └─beneficiaryId | integer | Payee ID |
| └─payeeStatus | string | Payee status |
Response Example
json
{
"respCode": "20000",
"respMsg": "Success",
"data": {
"beneficiaryId": 98765432,
"payeeStatus": "PROCESSING"
}
}