Onerway Payment API
Onerway APIs
    • Onerway 商户 API 接入指南
    • Onerway Merchant API Testing
    • Payment APIs
      • Checkout
        • Card Checkout
        • Card Checkout - Subscribe
        • APMs Checkout
        • Single-Method APM Checkout
        • Card Checkout - Authorizaiton
      • JS-SDK
        • One-Time Payment Intent
        • Subscription Payment Intent
        • Card Tokenization Intent
      • API
        • Card
        • Pre-Auth
        • Auth Reversal
        • Capture
        • Card Tokenization
        • Tokenized Payment
        • Subscription - Charge by Onerway
        • Subscription Initial Charge
        • Subscription Recurring Charge
        • Subscription Cancellation
        • Subscription Reactivation
        • Token Removal
      • APMs - Alternative Payment Methods
        • Thailand
          • Thailand-TrueMoney Wallet
          • Thailand-PromptPay
          • Thailand-Rabbit_Line_pay
          • Thailand-KRUNGSRI_ONLINE
        • Malaysia
          • Malaysia-TOUCH_GO_EWALLET
          • Malaysia-Boost
          • Malaysia-MCASH
          • Malaysia-ShopeePay
          • Malaysia-FPX
        • Indonesia
          • Indonesia-ShopeePay
          • Indonesia-OVO
          • Indonesia-DANA
          • Indonesia-QRIS
          • Indonesia-BNI
          • Indonesia-MANDIRI
          • Indonesia-Maybank
          • Indonesia-PERMATA
          • Indonesia-BRI
          • Indonesia-CIMB
          • Indonesia-AKULAKU
          • Indonesia-DANA(Subscribe)
        • Japan
          • Japan-Konbini
          • Japan-PayEasy
        • South Korea
          • South Korea-Kakao_Pay
          • South Korea-Naver_Pay
          • South Korea-PAYCO
          • South Korea-Cards_KOR
        • Vietnam
          • Vietnam-NINE_PAY
          • Vietnam-PAYME
          • Vietnam-VIET_QR
          • Vietnam-MOMO
          • Vietnam-ATM_CARD
        • Philippines
          • Philippines-Dragonpay
          • Philippines-QR_PH
        • Brazil
          • Brazil-Boleto
          • Brazil-Visa/Master
          • Brazil-PIX
          • Brazil-PicPay
          • Brazil-MercadoPago
        • Mexico
          • Mexico-Visa/Master
          • Mexico-SPEI
          • Mexico-OXXO
          • Mexico-PaySafeCard
        • Chile
          • Chile-Visa/Master
          • Chile-Khipu
          • Chile-Webpay
          • Chile-Servipag
          • Chile-Sencillito
        • Paraguay
          • Paraguay-Visa/Master
          • Paraguay-Infonet
        • United States
          • United States-PayPal
          • United States-Venmo
          • United States-CASH_APP
        • Belgium
          • Belgium-Bancontact
          • Belgium-Payconiq
        • Germany
          • Germany-PaySafeCard
          • Germany-Giropay
        • Italy
          • Italy-MyBank
        • Luxembourg
          • Luxembourg-Payconiq
        • Estonia
        • Turkey
          • Turkey-Papara
        • Peru
          • Peru-PagoEfectivo
      • Refund
        • Initiate Refund
        • Cancel Refund
      • Settlement
        • Settlement File Download
      • Query
        • Retrieve Transaction Orders
        • Query Installment Options
        • Retrieve Subscription Details
        • Query Chargeback Records
        • Retrieve Card Tokenization Records
      • Utils
        • Signature Validation Helper

    Onerway 商户 API 接入指南

    API 版本: v1.0.0

    平台简介#

    欢迎使用 Onerway 商户 API 调试平台！本平台提供了完整的 API 调试环境，帮助您快速接入 Onerway 支付系统。通过本平台，您可以：
    无需开发：直接在线测试 API 功能
    即时反馈：实时查看请求和响应数据
    场景模拟：模拟各类业务场景，验证接口表现
    快速上手：提供详细的参数说明和示例值
    本平台适用于：
    正在评估 Onerway 服务的潜在商户
    已签约并需要进行系统对接的商户技术团队
    需要排查 API 问题的已上线商户

    快速开始#

    第一步：获取访问凭证#

    在开始使用本平台前，您需要从商户后台获取以下信息：
    1.
    商户号(merchantNo)：您的商户唯一标识
    2.
    应用ID(appId)：对应站点的应用标识符
    3.
    API密钥(secretKey)：用于生成签名，请妥善保管
    📝 注意：如果您尚未获取以上信息，请联系您的商务经理

    第二步：选择环境#

    我们提供两个环境供您使用：
    环境描述适用场景
    测试环境模拟交易，不产生实际资金流动开发测试、接口调试
    生产环境真实交易，涉及实际资金上线运营
    ⚠️ 重要提示：请务必在测试环境完成全面测试后，再迁移至生产环境

    第三步：初始化环境变量#

    MERCHANT-NO: 商户号
    secret: 签名密钥
    APPID: 应用标识
    WEBHOOK-ENDPOINT: 支付回调地址
    RETURN-URL: 支付完成后前端跳转地址

    第四步：选择接口#

    我们提供全面的支付处理解决方案，涵盖从支付收款到退款结算的完整生命周期。以下是主要功能模块：

    核心支付功能#

    Checkout (收银台) 🔵: 提供标准化的支付结账体验，快速集成
    JS-SDK 🔵: 服务端下单接口，用于渲染SDK自定义支付界面
    API (核心接口) 🔵: 底层支付处理接口，提供最大的灵活性和控制力
    APMs (替代支付方式) 🔵: 支持全球多种支付方法，包括钱包、银行转账等
    集成方案适用场景开发复杂度自定义程度维护成本
    Checkout快速上线，标准支付流程低基础定制低
    JS-SDK自定义支付界面，控制用户体验中高度定制UI中
    API完全自定义支付流程，特殊业务逻辑高完全控制高
    APMs拓展全球市场，支持本地支付方式中因支付方式而异中

    交易后处理#

    Refund (退款模块) 🔵: 提供完整的退款生命周期管理功能，支持发起和取消退款操作，确保商户能够灵活处理客户退款需求。
    Settlement (结算模块) 🔵: 负责商户资金结算流程，提供结算文件下载功能，便于商户进行财务对账和资金管理。

    查询与管理#

    Query (查询模块) 🔵: 全面的数据查询功能集合，支持交易订单、分期选项、订阅详情、拒付记录及卡片令牌化信息的检索，为商户提供完整的交易数据视图。
    Utils (工具模块) 🔵: 辅助功能集合，包含签名验证等安全工具，确保API通信的安全性和完整性，帮助开发者验证请求的真实性。
    🔵 稳定版接口 | 🟡 测试版接口 | 🟠 即将弃用

    第五步：发起测试请求#

    1.
    在左侧导航栏选择需要测试的接口
    2.
    填写必要的请求参数（系统已预设默认值, 环境变量会自动填充）
    3.
    点击"发送"按钮提交请求
    4.
    查看响应结果及详细信息
    注意
    如遇Repeated order transactions!,请点击auto-generate按钮

    核心支付流程#

    常见错误处理#

    错误码描述处理建议
    13027Repeated order transactions!请点击auto-generate 按钮重新生成请求参数
    40013Abnormal parameters (cannot be read)请检查环境变量是否配置完成
    70002Unknown decline联系技术支持
    💡 提示：完整错误码列表请参考错误码文档

    安全最佳实践#

    1.
    API密钥保护
    绝不在客户端存储密钥
    2.
    签名验证
    所有请求必须包含有效签名
    验证所有回调通知的签名
    使用HTTPS进行所有API通信
    3.
    IP白名单
    在商户后台设置API调用IP白名单
    限制回调接收服务器的IP范围

    术语表#

    术语定义
    Merchant使用Onerway支付服务的商户
    Transaction单次支付交易
    Settlement资金结算过程
    Chargeback消费者向银行发起的交易争议
    Webhook异步通知机制
    Tokenization卡信息加密存储技术

    技术支持#

    如遇到技术问题，请通过以下渠道获取支持：
    技术支持邮箱: abel.wang@onerway.com
    问题上报流程:
    1.
    准备订单号、错误信息和复现步骤
    2.
    提交详细问题描述和截图
    3.
    技术团队将在1个工作日内响应
    Modified at 2025-05-21 07:09:03
    Next
    Onerway Merchant API Testing
    Built with