# Integration Guide
Welcome to EnjoyPay. This guide will help you quickly integrate our payment services.
# Quick Start
# 1. Get Merchant No
Please contact our business support team to obtain your Merchant No (mchNo) and App ID (appId).
# 2. Get Transaction Key
To ensure communication security, you need to obtain the MD5 signature key.
- Get Key: Please contact support or log in to the merchant dashboard to view your
MD5 Key.
# 3. Make First Test Request
After configuration, you can choose one of the following two modes to initiate a test based on your business needs.
# Mode 1: Unified Order (API Direct)
Suitable for merchants with their own checkout page. Call the API directly and specify the payment method (wayCode) in the parameters. View Docs
curl -X POST https://gateway.sandbox.enjoypayment.com/payment/api/pay/unifiedOrder \
-H "Content-Type: application/json" \
-d '{
"mchNo": "M162...",
"appId": "60cc...",
"mchOrderNo": "TEST001",
"wayCode": "PIX",
"amount": 100,
"currency": "BRL",
"subject": "Test Order",
"body": "Test Description",
"reqTime": 1622016572190,
"version": "1.0",
"signType": "MD5",
"sign": "YOUR_SIGNATURE_HERE"
}'
# Mode 2: Checkout Order (Hosted Cashier)
Suitable for redirecting to the EnjoyPay hosted cashier to complete payment without specifying a payment method. View Docs
curl -X POST https://gateway.sandbox.enjoypayment.com/payment/api/pay/checkoutOrder \
-H "Content-Type: application/json" \
-d '{
"mchNo": "M162...",
"appId": "60cc...",
"mchOrderNo": "TEST002",
"amount": 100,
"currency": "USD",
"country": "US",
"subject": "Checkout Order",
"body": "Checkout Description",
"reqTime": 1622016572190,
"version": "1.0",
"signType": "MD5",
"sign": "YOUR_SIGNATURE_HERE"
}'
# Authentication
EnjoyPay API uses MD5 signature method for security authentication.
# MD5 Signature
Based on MD5 symmetric encryption.
- Rule: Parameter sorting & concatenation + Key (
key) for MD5 calculation. - Details: MD5 API Specification
# Server Information
All API requests should be sent to the following server addresses:
| Environment | API Address | Tag | Description |
|---|---|---|---|
| Production | https://gateway.enjoypayment.com/payment | Production | Real Transaction Environment |
| Test | https://gateway.sandbox.enjoypayment.com/payment | Test | For Development Debugging |
# Production Environment Traffic Export
Security Note
* Whitelist Configuration: For the production environment, it is recommended to add the following IPs to your firewall whitelist to ensure correct reception of asynchronous notifications from the platform.
| No. | Outbound IP |
|---|---|
| 1 | 47.89.254.99 |
| 2 | 47.251.5.85 |
| 3 | 198.11.177.112 |