Technical Terms
A
API (Application Programming Interface)
Interface specification that allows different software systems to communicate and exchange data.
SUNBAY API: RESTful API providing payment, refund, query, and other functions.
Related Documentation: API Reference
API Key
Key used to identify and authenticate API callers. Usually includes API Key and API Secret.
Security Recommendations:
- Don’t hardcode API keys in code
- Store using environment variables
- Rotate keys regularly
- Don’t commit keys to version control systems
Asynchronous Processing
Processing method that returns response without waiting for operation to complete. Commonly used for time-consuming operations, such as Webhook event processing.
C
Callback
When specific event occurs, system automatically calls predefined function or interface.
Example: After payment completes, Tapro terminal notifies POS application of payment result through callback.
Certificate / SSL Certificate
Digital certificate used to verify website identity and encrypt data transmission. HTTPS websites must configure valid SSL certificates.
Client
Application or device that initiates requests, such as POS applications, mobile apps, web applications, etc.
Cloud Integration
Integration method that completes payments by calling SUNBAY cloud API over the internet.
Related Documentation: Cloud Integration Guide
E
Endpoint
Specific access address of API, usually a URL.
Examples:
- Payment endpoint:
POST /api/v1/payments/sale - Query endpoint:
GET /api/v1/payments/query
Environment Variable
Variable in operating system or application that stores configuration information, such as API keys, database connection strings, etc.
H
HMAC (Hash-based Message Authentication Code)
Hash-based message authentication code used to verify message integrity and authenticity.
SUNBAY Use Case: Webhook signature verification uses HMAC-SHA256 algorithm.
HTTPS (Hypertext Transfer Protocol Secure)
Secure version of HTTP that uses TLS/SSL to encrypt data transmission.
Requirement: All SUNBAY API calls and Webhook URLs must use HTTPS.
I
Idempotency
Property where executing same operation multiple times produces same result. Idempotent operations can be safely retried without side effects.
Implementation: Use unique request ID (Idempotency Key) to identify each request.
Example:
{
"idempotencyKey": "unique-request-id-123",
"amount": "100.00"
}Integration
Integrating SUNBAY payment functionality into merchant’s own application system.
Integration Methods:
- Local integration (using Taplink SDK)
- Cloud integration (calling cloud API)
J
JSON (JavaScript Object Notation)
Lightweight data exchange format that is easy for humans to read and write, and easy for machines to parse and generate.
SUNBAY API: All requests and responses use JSON format.
L
LAN Mode
Integration mode where POS system communicates with Tapro terminal over local area network.
Related Documentation: LAN Mode Integration
P
Polling
Method where client periodically sends requests to server to query status or retrieve data.
Example: Regularly call Query API to query transaction status.
R
RESTful API
API following REST (Representational State Transfer) architectural style, using HTTP methods (GET, POST, PUT, DELETE) to operate resources.
Retry
When operation fails, automatically or manually attempting to execute operation again.
Retry Strategies:
- Exponential Backoff
- Maximum retry count limit
- Only retry retryable errors (such as network timeout)
S
Sandbox Environment
Simulated environment for development and testing that doesn’t produce real fund flows.
Related Documentation: Sandbox Environment
SDK (Software Development Kit)
Software development kit that encapsulates API call logic to simplify development work.
SUNBAY SDK:
- Nexus SDK (Cloud Integration): Java, Python, Node.js, PHP, Go, .NET
- Taplink SDK (Local Integration): Android, .NET
Related Documentation: SDK Documentation
Server
Computer or application that receives and processes client requests.
Signature
String generated by encrypting data using key, used to verify data integrity and source.
SUNBAY Use Cases:
- API request signature
- Webhook event signature
T
Terminal Integration / Local Integration
Integration method where POS application communicates directly with Tapro terminal through Taplink SDK.
Communication Modes:
- App-to-App mode
- Cable mode (USB/Serial)
- LAN mode
Related Documentation: Terminal Integration Guide
Timeout
When operation doesn’t complete within specified time, system automatically terminates operation.
Recommended Settings:
- API call timeout: 30 seconds
- Webhook response timeout: 10 seconds
- Terminal payment timeout: 120 seconds
TLS (Transport Layer Security)
Transport layer security protocol used to provide encryption and authentication in network communications.
Requirement: SUNBAY requires TLS 1.2 or higher.
W
Webhook
Mechanism where server proactively sends HTTP requests to client when specific events occur. Also called “reverse API” or “HTTP callback”.
SUNBAY Webhook: Events such as payment success and refund completion trigger Webhook notifications.
Related Documentation: Webhook Documentation
WebSocket
Protocol for full-duplex communication over single TCP connection, supports server proactively pushing data to client.
Other
Base64 Encoding
Encoding method that encodes binary data as ASCII string, commonly used to transmit binary data in text protocols.
CORS (Cross-Origin Resource Sharing)
Allows web applications to request resources from servers with different domain names.
UUID (Universally Unique Identifier)
Universally unique identifier used to generate globally unique IDs.
Format Example: 550e8400-e29b-41d4-a716-446655440000
Versioning
Managing different versions of API or software to ensure backward compatibility.
SUNBAY API Version: Current version is v1, URL format is /api/v1/...