Onerway
POST

Upload logistics information

View as Markdown
Use this endpoint to attach carrier and tracking details to a transaction for settlement confirmation, order tracking, and chargeback handling. For stc pay settlement, upload logistics information only after the physical-goods transaction has completed successfully and the package has been delivered to and signed for by the customer.

Request

merchantNostringrequired
Merchant number assigned by Onerway. See Setup for how to obtain it.
Example:replace_with_merchant_no
transactionIdstringrequired
Onerway transaction number for the target payment whose logistics information is being uploaded, transmitted as a JSON string.
Example:example_transaction_id
Constraints
Rule
Upload logistics information only for transactions that have completed successfully.
Rule
Submitting the same transactionId again automatically replaces the existing logistics information with the information in the new request.
Unsupported
For stc pay settlement, virtual-goods transactions and installment transactions are not supported for this logistics settlement prerequisite.
carrierNostringrequired
Carrier code used to identify the logistics provider for shipment tracking.
Example:SF
Constraints
Values
Use a carrier code from Onerway's logistics carrier code list. The downloadable list covers more than 1,000 carriers globally.
trackingNostringrequired
Package tracking number provided by the carrier, used to track shipment progress and delivery status.
Example:SF1234567890
Constraints
Rule
For stc pay settlement, upload logistics information only after the package has been delivered to and signed for by the customer.
signstringrequired
Request signature string. See Request signing for how to generate it.

Request example

curl -X POST 'https://sandbox-acq.onerway.com/v1/txn/uploadLogisticsInfo' \
  -H 'Content-Type: application/json' \
  --data-raw '{
  "carrierNo": "SF",
  "merchantNo": "replace_with_merchant_no",
  "sign": "{{SIGN}}",
  "trackingNo": "SF1234567890",
  "transactionId": "example_transaction_id"
}'

Response

respCodestring
Response code; 20000 means the upload request was processed successfully, other values are error codes. See Response codes.
respMsgstring
Human-readable message for the response code.
datastring
Onerway transaction number corresponding to the successful logistics upload.
Example:example_transaction_id
Constraints
Rule
data is the transaction ID string itself, not a nested object.

Response example

Example code is unavailable.

20050018

Transaction not found

Trigger: The transaction does not exist or does not belong to the merchant identified by merchantNo.

Example

{
  "respCode": "50018",
  "respMsg": "Non-existent order!",
  "data": null
}
20050204

Invalid transaction status

Trigger: The transaction has not completed successfully. This includes transactions that are still processing or have failed.

Example

{
  "respCode": "50204",
  "respMsg": "Wrong order status!",
  "data": null
}
20050000

System error

Trigger: A system error occurs while saving the logistics information.

Example

{
  "respCode": "50000",
  "respMsg": "System error",
  "data": null
}

Create or cancel refund

Create a refund request or cancel a submitted refund request for a paid transaction.

Download settlement file

Download a UTF-8 CSV settlement file by settlement date and settlement currency.