OnlinePay API
  1. Introduction
OnlinePay API
  • Introduction
    • Introduction
    • How to Start
    • Country Code
    • Country Info
    • Currency Code
    • Error Code
    • Transfer Order Info Type
    • Transfer Order File Type
    • Per Bank
    • Spei Bank
  • Payin
    • OnRamps API
      GET
    • Alipay API
      POST
    • Credit Card API
      POST
    • Crypto Pay API
      POST
    • GCash API
      POST
    • PerTransfer API
      POST
    • PIX API
      POST
    • SEPA API
      POST
    • SPEI API
      POST
    • Union Pay API
      POST
    • WeChat API
      POST
    • CheckOut
      POST
    • CheckOut Payment
      POST
  • Payout
    • Bank Account
      POST
    • Card
      POST
    • Per Transfer
      POST
    • Pix
      POST
    • CheckOut
      POST
    • Spei Payout
      POST
  • Notify
    • Notify WebHook API
    • Card Notify WebHook API
  • Refund
    • Refund API
  • Review
    • Upload SEPA File API
  • Query
    • Query API
    • QueryBalance API
    • QueryOrderList API
  • Card
    • CreateCardholder API
    • CreateCard API
    • QueryCardInfo API
    • ActiveCard API
    • TopUpCard API
    • CardWithdraw API
    • QueryCardTransaction API
    • QueryCardBalance API
    • FreezeCard API
    • UnFreezeCard API
    • CancelCard API
    • AddVpaScene API
    • UploadFile API
  1. Introduction

How to Start

Payment Acquiring
Card Issuing

1. Apply for Test Merchant Id and Key#

1.1 Complete registration on the Test OnlinePay Portal
1.2 Obtain your Test API keys:
Log in to the Test OnlinePay Portal.
Navigate to Personal Center > Developer Center > View your API keys.

2. Parameter Signature#

Note: The default signing method is RSA.
2.1 RSA Signature
Applicable when the interface's sign parameter uses RSA.
Generate Your RSA Key Pair using KeyPairExample:
-Your Private Key: This key is highly sensitive and must be kept secret and secure within your system.
-Your Public Key: This key is intended to be shared. You will upload this public key to our Developer Center.
Upload Your RSA Public Key to the Developer Center:
image.png
-Log in to the Developer Center. locate the field "User Publickey" .
-Click on the Edit button to upload your RSA public key
-Purpose: By uploading your public key, you enable our system to verify that the requests purportedly coming from you are genuinely signed by your corresponding private key.
Retrieve the OnlinePay Public Key for Verifying Platform Signatures:
image.png
-While still in the Developer Center, locate the field "OnlinePay Publickey" .
-Click the "View" button to obtain the OnlinePay public key.
-Purpose: You will use this OnlinePay public key to verify the digital signatures on responses, notifications, or callbacks sent from our payment system to your system. This ensures that the messages you receive from us are authentic and have not been tampered with.
2.2 MD5 Signature
Applicable when the interface's sign parameter uses MD5.
Construct the raw string as A+B+C+PrivateKey.
Generate an MD5 hash of the string.
Convert the hash to uppercase for the final sign value.

3. Add Your Website URL to the Whitelist#

3.1 Navigate to the Developer Center
3.2 Access the URL Whitelist Tab
image.png
3.3 Submit Your Website URL:
On the "URL Whitelist" page, click the add button.
A pop-up window will appear, enter your website URL into the designated field.
Please submit your URL without the https:// prefix.
For example, if your website is https://example.com, you should enter example.com.
3.4 Wait for Review and Approval:
Once your URL is approved and whitelisted, your website will be authorized to interact with our platform's services as intended.

4. Calling the payment interface#

Call the interface using the RESTful method.

5. Support#

Jumpstart your integration with our API demos and code samples.
Payment demo

6. Pre-Go-Live Review#

Confirm all Sandbox test cases have passed.
Modified at 2025-07-04 09:42:01
Previous
Introduction
Next
Country Code
Built with