Onerway
POST

Beneficiary Add

View as Markdown
Create a beneficiary that can be used 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
merchantRefIdstringoptional
Merchant-side user or beneficiary reference ID used for mapping, search, or internal reconciliation.
bankCountrystringrequired
Destination country of the beneficiary.
Example:PK
payoutCurrencystringrequired
Payout currency used by the beneficiary.
Example:PKR
entityTypestringrequired
Beneficiary entity type. 0 for business and 1 for individual.
Example:1
paymentMethodstringrequired
Payout method used for this beneficiary. It must match the country, currency, and entity type selected for the beneficiary.
Example:E_WALLET
Beneficiary identity information encoded as a JSON string. Include every identity field required by the selected payout method.
Beneficiary address information encoded as a JSON string, including country, state, city, and address lines when required.
Beneficiary account information encoded as a JSON string. Include the account fields required by the selected payout method.
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/add' \
  -H 'Content-Type: application/json' \
  --data-raw '{
  "accountInfomation": "{\"walletType\":\"EASYPAISA\",\"walletPhone\":\"03001234567\"}",
  "address": "{\"countryCode\":\"PK\",\"state\":\"Punjab\",\"city\":\"Lahore\",\"addressLine1\":\"12 Demo Street\",\"postalCode\":\"54000\"}",
  "bankCountry": "PK",
  "entityType": "1",
  "merchantNo": "801129",
  "merchantRefId": "bene_demo_001",
  "paymentMethod": "E_WALLET",
  "payoutCurrency": "PKR",
  "receiverInfo": "{\"firstName\":\"Beta\",\"lastName\":\"Tester\",\"areaCode\":\"+92\",\"phone\":\"3001234567\",\"email\":\"beneficiary@example.com\",\"identityType\":\"NID\",\"identityNumber\":\"3520212345671\"}",
  "sign": "{{SIGN}}"
}'

Response

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

Response example

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

Beneficiary Required Fields Query

Query the field requirements for a specific country, currency, entity type, and transfer method.

Beneficiary Details Query

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