Onerway
POST

List available payment methods

View as Markdown
Use this endpoint before creating a payment when your integration needs to display or filter the payment methods available for the customer's country, currency, amount, platform, and merchant configuration.

Request

appIdstringrequired
Application or site identifier assigned by Onerway. It identifies the merchant application that starts this query.
Example:replace_with_app_id
countrystringrequired
Customer country or region code, using the two-letter ISO 3166-1 alpha-2 format. Onerway uses it to match available payment methods for that region.
Example:US
merchantNostringrequired
Merchant number assigned by Onerway. See Setup for how to obtain it.
Example:replace_with_merchant_no
orderAmountstringrequired
Order amount as a decimal string in the currency specified by orderCurrency. Format and minimum-amount rules follow currency and amount validation.
Example:99.99
orderCurrencystringrequired
Order currency, using a three-letter ISO 4217 currency code that matches orderAmount.
Example:USD
osTypestringConditional
Condition: Required when paymentMode is not WEB.
Operating system type for mobile or app-based payment scenarios.
Example:IOS
Allowed values
IOS
iOS device.
ANDROID
Android device.
paymentModestringoptionaldefaultWEB
Payment mode indicating the transaction platform or environment. Defaults to WEB when omitted.
Example:WEB
Allowed values
WEB
Desktop browser payment.
APP
Native mobile app payment. Submit osType together with this value.
WAP
Mobile browser payment. Submit osType together with this value.
signstringrequired
Request signature string. See Request signing for how to generate it.
subProductTypestringoptional
Payment-method category filter. When provided, Onerway returns only payment methods that support this transaction processing mode; when omitted, the available methods are based on the other order parameters.
Example:DIRECT
Allowed values
DIRECT
Direct payment.
SUBSCRIBE
Subscription payment.
INSTALLMENT
Installment payment.
Constraints
Consistency
The shared enum is a value dictionary only. Actual availability still depends on product compatibility, merchant configuration, and the current order context.

Request example

curl -X POST 'https://sandbox-acq.onerway.com/v1/txn/consultPaymentMethod' \
  -H 'Content-Type: application/json' \
  --data-raw '{
  "appId": "replace_with_app_id",
  "country": "US",
  "merchantNo": "replace_with_merchant_no",
  "orderAmount": "99.99",
  "orderCurrency": "USD",
  "osType": "IOS",
  "paymentMode": "APP",
  "sign": "{{SIGN}}",
  "subProductType": "DIRECT"
}'

Response

respCodestring
Response code returned by Onerway. 20000 means the request was processed successfully; other values indicate failure or an exception. See Response codes.
respMsgstring
Human-readable message for the response code.
Payment methods available for the current order context.

Response example

Example code is unavailable.

No error responses are documented for this endpoint.

Capture or void authorization

Capture a successful pre-authorization or void it to release the reserved amount.

Query payments

Query Payment records by payment intent, transaction identifiers, or time range.