1. Communication security
PayKKa OpenAPI Documentation
英文(EN)
  • 中文(CN)
  • 英文(EN)
  • Overview
  • Interface rules
  • SDK
  • Communication security
    • Signature Generation & Verification
  • API list
    • Merchant Onboarding
      • Apply for Onboarding
      • Update Onboarding Info
      • Query Onboarding Status
      • Onboarding Notification
    • Risk Assessment
      • Submit Assessment
      • Update Assessment Info
      • Get Assessment Result
      • Assessment Notification
    • VA
      • apply
      • inquiry
      • notification
    • Remittance
      • notification
    • Order
      • create
      • update
      • inquiry
      • supplement
    • Tradesettle
      • apply
      • inquiry
      • notification
    • Balance
      • inquiry
    • Payee
      • create
      • update
      • inquiry
      • notification
    • Forex
      • pre-order
      • confirm
      • inquiry
      • notification
    • Payment
      • apply
      • inquiry
      • notification
    • file service
      • upload
  • appendix
    • Open the collection account code table
    • Product Category
    • Business categories
    • Province and city code
    • Bank code
    • industry
    • new industry
    • Country code
  1. Communication security

Signature Generation & Verification

Constructing the Signature String#

The signature string consists of 5 lines, each ending with \n (ASCII 0x0A), except the last line.
Important rules:
One element per line
If a field is empty, the line must still exist (keep \n)
Structure must remain unchanged
Standard Structure ↓
Request path\n
Request timestamp(timestamp)\n
Request a random string (nonce)\n
Merchant ID\n
Request message body
Without Request Body ↓
Request path\n
Request timestamp(timestamp)\n
Request a random string (nonce)\n
Merchant number
Without Merchant ID ↓
(Still keep empty line)
Request path\n
Request timestamp(timestamp)\n
Request a random string (nonce)\n
\n
Request message body
Note:
Always maintain line structure consistency
Even if a value is empty, the newline must remain
Exception: last line does not end with \n
File upload APIs use a different body structure (see file upload section)
Example
TBD

Signature Calculation#

Use SHA256withRSA to sign the signature string
Use the client private key
Encode the signature result with Base64
It is strongly recommended to use built-in cryptographic libraries

HTTP Headers#

When the requested content belongs to the merchant, the X-Merch-Id request header needs to be set, and the content is the merchant number assigned by Paykka Cross-border Collection Open Platform (generation method)
The request passes the signature through the HTTP Authorization header, whose content is a URLEncode JSON object, containing the following fields:
keyformatdescription
sign_typeStringSignature algorithm (SHA256_WITH_RSA)
timestampStringMillisecond timestamp (Unix Epoch)
nonceString(6-32)Random string for replay protection
key_idStringPlatform-issued key ID
signatureStringSignature value
Modified at 2026-04-17 01:42:04
Previous
Communication security
Next
API list
Built with