Onerway
POST

Beneficiary Required Fields Query

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

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
payoutCurrencystringrequired
Payout currency to validate.
Example:NGN
bankCountrystringrequired
Destination country of the beneficiary account.
Example:US
entityTypestringrequired
Beneficiary entity type. 0 for business and 1 for individual.
Example:0
paymentMethodstringrequired
Payout method to validate.
Example:BANK_TRANSFER
walletTypestringConditional
Condition: Required when the payout method is a wallet-based method.
Wallet subtype used in wallet-based payout methods.
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/queryPaymentFeild' \
  -H 'Content-Type: application/json' \
  --data-raw '{
  "bankCountry": "US",
  "entityType": "1",
  "merchantNo": "801129",
  "paymentMethod": "BANK_TRANSFER",
  "payoutCurrency": "USD",
  "sign": "{{SIGN}}"
}'

Response

respCodestring
Response code returned by Onerway.
respMsgstring
Response message returned by Onerway.
Field requirement matrix for the requested payout scenario.

Response example

{
  "respCode": "20000",
  "respMsg": null,
  "data": {
    "merchantNo": "801129",
    "accountInfomation": {
      "cardNumber": "Y",
      "accountType": "Y",
      "swiftCode": "C",
      "sortCode": "C",
      "branchCode": "N",
      "bankHolderName": "Y",
      "walletType": "N",
      "walletPhone": "N"
    },
    "address": {
      "state": "Y",
      "city": "Y",
      "addressLine1": "Y",
      "addressLine2": "N",
      "addressLine3": "N",
      "postalCode": "Y"
    },
    "receiverInfo": {
      "nickName": "N",
      "companyName": "N",
      "lastName": "Y",
      "firstName": "Y",
      "areaCode": "C",
      "phone": "C",
      "vatNumber": "N",
      "birthDate": "C",
      "email": "C"
    }
  }
}
No error responses are documented for this endpoint.

Transfer Method Query

Query the supported transfer methods for a country, currency, and entity type combination.

Beneficiary Add

Create a beneficiary that can be used in later Transfer payouts.