POST
Create payment link
Use this endpoint to create a payment link that customers can open to complete payment on an Onerway-hosted checkout page.
Request
merchantNoMerchant number assigned by Onerway. See Setup for how to obtain it.
Example:
replace_with_merchant_nolinkNameDisplay name for the payment link, used to identify the link in list queries and merchant operations.
amountPayment amount in the specified currency. Use integer values for zero-decimal currencies. Format rules follow currency and amount validation.
Example:
99.99defaultCountryDefault country or region code used on the payment link checkout page. The recommended format is a two-letter ISO 3166-1 alpha-2 country code.
Example:
USitemNameName of the goods or services shown to the customer.
descriptionDescription of the goods or services shown to the customer.
collectEmailWhether the payment link checkout page collects the customer email address.
Example:
truecollectNameWhether the payment link checkout page collects the customer name.
Example:
truesignRequest signature string. See Request signing for how to generate it.
curl -X POST 'https://sandbox-acq.onerway.com/v1/txn/paymentLink/add' \
-H 'Content-Type: application/json' \
--data-raw '{
"amount": 99.99,
"collectEmail": true,
"collectName": true,
"currency": "USD",
"defaultCountry": "US",
"description": "Demo product description",
"itemName": "Demo product",
"linkName": "Demo payment link",
"merchantNo": "replace_with_merchant_no",
"sign": "{{SIGN}}"
}'Response
respCode20000 means the create request was processed successfully. Other values are error codes. See Response codes.respMsgHuman-readable message for the response code.
data{ id, linkUrl }Business data object containing the created payment link.
Response example
Example code is unavailable.
No error responses are documented for this endpoint.