Onerway
POST

Transfer with beneficiary ID

View as Markdown
Submit a Transfer payout by using an approved beneficiary ID.

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
payerIdstringConditional
Condition: Provide payerId or payerDetail.
Stored payer ID used for the transfer. Reuse this field when the payer has already been created and does not need to be passed inline.
Condition: Provide payerDetail or payerId.
Inline payer details encoded as a JSON string. Use it when the payer is not pre-created or when the latest payer attributes must be sent with the request.
beneficiaryIdstringrequired
Approved beneficiary ID used for the transfer.
Example:1953727182141784064
sourceAmountnumberConditional
Condition: Required when chargeFlag=N.
Source amount before downstream deductions. Use this field when the transfer is driven by the debit-side amount.
Example:113
sourceCurrencystringrequired
Source currency of the transfer.
Example:USD
targetAmountnumberConditional
Condition: Required when chargeFlag=Y.
Expected arrival amount in the beneficiary currency. Use this field when the transfer is driven by the beneficiary-side arrival amount.
Example:1901
targetCurrencystringrequired
Target or beneficiary currency of the transfer.
Example:PKR
requestIdstringrequired
Merchant request ID. Keep it unique for each transfer request for reconciliation and idempotency tracking.
Example:DM2025081120520
referencestringoptional
Transfer reference or memo that appears in downstream reconciliation or beneficiary statements when supported.
transactionPurposestringrequired
Transfer purpose code. Choose the value that matches the underlying business purpose and compliance requirement of the payout.
chargeFlagstringrequired
Full-arrival flag used to choose whether the target amount or source amount drives the calculation.
feeBearingstringConditional
Condition: Required for SWIFT transfers when fee-bearing mode must be declared.
SWIFT fee-bearing mode.
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/txn/remittance' \
  -H 'Content-Type: application/json' \
  --data-raw '{
  "beneficiaryId": "1953727182141784064",
  "chargeFlag": "Y",
  "merchantNo": "801040",
  "payerId": "1953712585351499776",
  "reference": "REFERENCE PAYOUT",
  "requestId": "DM2025081120520",
  "sign": "{{SIGN}}",
  "sourceAmount": 113,
  "sourceCurrency": "USD",
  "targetAmount": 1901,
  "targetCurrency": "PKR",
  "transactionPurpose": "4"
}'

Response

respCodestring
Response code returned by Onerway.
respMsgstring
Response message returned by Onerway.
Created transfer record.

Response example

{
  "respCode": "20000",
  "respMsg": null,
  "data": {
    "merchantNo": "801129",
    "payoutId": "1984136974445449216",
    "status": "A",
    "requestId": "CYPW20251031055450"
  }
}
No error responses are documented for this endpoint.

Payer Add

Create a payer that can be reused in later Transfer payouts.

Transfer Single Query

Query a single transfer by merchant request ID or Onerway payout ID.