The test information

Sandbox environment only

Test merchant information

1.tradeMerNo：104001001
2.merchantKey： _bndqOD^

Test merchant website

2D returnUrl：www.test01.com

Credit Card

Gold Pomelo

Signature Rules

To ensure that the data is not tampered with during transmission, the system requires you to sign the payment parameter data and send the data signature along with the payment request

The MD5 Signature

The signature mode of all interfaces in the system is MD5. For details about the signature field, see the signature parameter remarks of each interface
Verify the signature, you can to MD5 signature string 123456 signature string E10ADC3949BA59ABBE56E057F20F883E result, can think the signature right
Signature rule: Concatenates the fields to be signed in the specified order, and converts all the characters after the signature to uppercase after the MD5 signature
The merchant key can be obtained from the merchant background after the merchant is successfully registered and approved

Request Parameters

Request URL:
- sandbox: https://sandbox.paypomelo.com/payment
Request Type: POST
Request Header: Content-Type:application/json
Request Header Parameters:

Parameter name	Required	Type	Explain	Length	Remark
referer	No	String	Referer	256	When the referer is not filled in, the url will be obtained from returnUrl and verified by default. If the referer is filled in, the referer will be judged first. When the verification fails, returnUrl will not be verified

Body Parameters:

Body Parameters


  {
    "tradeMerNo": 123455,
    "merOrderNo": "1641972507000",
    "currencyCode": "CNY",
    "sourceAmount": "100.05",
    "returnUrl": "http://baidu.com",
    "sign": "9D6FDF4880B00B002B1F2AB61AE9A721",
    "cardNo": "6011200081728932",
    "cardExpireMonth": "06",
    "cardExpireYear": "2020",
    "cardSecurityCode": "361",
    "billingFirstName": "san",
    "billingLastName": "zhang",
    "billingAddress1": "China",
    "billingCity": "shanghai",
    "billingState": "shanghai",
    "billingCountry": "CN",
    "billingZipCode": "200000",
    "billingPhone": "13688888888",
    "shippingFirstName": "san",
    "shippingLastName": "zhang",
    "shippingAddress1": "China",
    "shippingCity": "shanghai",
    "shippingState": "shanghai",
    "shippingCountry": "CN",
    "shippingZipCode": "200000",
    "shippingPhone": "13688888888",
    "ipAddress": "116.235.134.86",
    "browser":{
      "acceptHeader": "/**",
      "userAgent":"Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/104.0.0.0 Safari/537.36",
      "language":"en",
      "timeZoneOffset":10,
      "colorDepth":10,
      "screenHeight":100,
      "screenWidth":1300,
      "javaEnabled":true
    },
    "holderName": "test",
    "productInfo": [
      {
        "sku": "1",
        "productName": "mac pro",
        "price": "12000",
        "quantity": "1"
      },
      {
        "sku": "2",
        "productName": "iphone13",
        "price": "8000",
        "quantity": "1"
      }
    ]
  }

Parameter name	Required	Type	Explain	Length	Remark
tradeMerNo	Yes	Integer	Merchant Number	10	Unique identifier assigned to the merchant by the Gold Pomelo payment platform when registering with Gold Pomelo
merOrderNo	Yes	String	Merchant Order Number	32	Each order must be unique, and each merchant order number can only be submitted once within 1 second
currencyCode	Yes	String	Currency	3
sourceAmount	Yes	String	Total amount of the order	12	keep two decimals
returnUrl	Yes	String	Jump address after payment is completed	512
notifyUrl	No	String	Asynchronous notification address	512	The asynchronous notification address is used when 3DS pays to receive Gold Pomelo to push payment results to merchants
sign	Yes	String	signature	32	(tradeMerNo、merOrderNo、currencyCode、sourceAmount、Merchant key) Please refer to See signature for details
cardNo	Yes	String	card number	16
cardExpireMonth	Yes	String	Expiry date of card (month)	2
cardExpireYear	Yes	String	Expiry date of card (year)	4
cardSecurityCode	Yes	String	CVV2/CSC	3
billingFirstName	Yes	String	First Name	50
billingLastName	Yes	String	Last name	50
billingAddress1	Yes	String	billing address 1	128
billingAddress2	No	String	billing address 2	128
billingCity	Yes	String	City of residence (bill)	100
billingState	Yes	String	State Name (Bill)	100
billingCountry	Yes	String	International ISO country abbreviation	2	Refer to the country code table
billingZipCode	Yes	String	Postal Code	20
billingPhone	Yes	String	billing phone	20
billingEmail	Yes	String	billing email	100
shippingFirstName	Yes	String	Consignee’s first name	50
shippingLastName	Yes	String	Consignee’s last name	50
shippingAddress1	Yes	String	Receiving address details 1	128
shippingAddress2	No	String	Receiving address details 2	128
shippingCity	Yes	String	Receiving city	100
shippingState	Yes	String	Receiving continent, province	100
shippingCountry	Yes	String	Receiving country	2	Refer to the country code table
shippingZipCode	Yes	String	Consignee’s zip code	20
shippingPhone	Yes	String	Consignee phone	20
shippingEmail	Yes	String	shilling email	100
ipAddress	Yes	String	Cardholder IP address	64
productInfoList	Yes	List	product list
browser	Yes	browser	Browser information
holderName	Yes	String	Cardholder Name	30

Item parameters in the item list

Parameter name	Required	Type	Explain	Length
sku	Yes	String	Product ID	64
productName	Yes	String	product name	128
price	Yes	String	Commodity price	16
quantity	Yes	String	quantity of commodity	16

Browser information parameters Required field

Parameter name	Required	Type	Explain	Length
acceptHeader	Yes	String	Customer browser(Accept header)	50
userAgent	Yes	String	Customer browser(userAgent)	128
language	Yes	String	Customer browser language setting	50
timeZoneOffset	Yes	Interger	Time Zone Offset from UTC	11
colorDepth	Yes	Interger	Color depth of the client browser	11
screenHeight	Yes	Interger	Screen height of client browser	11
screenWidth	Yes	Interger	Screen width of client browser	11
javaEnabled	Yes	Interger	Whether Javascript is enabled in the client's browser	true

Sample request


public class Test{
  public static void main(String[] args){
    JSONObject jsonObject = new JSONObject();
    jsonObject.put("tradeMerNo", "123455");
    jsonObject.put("merOrderNo", "1641972507000");
    jsonObject.put("currencyCode", "CNY");
    //.....All body parameters except the sign

    //sign
    String sign = MD5(tradeMerNo+merOrderNo+currencyCode+sourceAmount+MerchantKey);
    jsonObject.put("sign", sign.toUpperCase());

    String url = "/payment";
    HttpResponse httpResponse = HttpRequest.post(url)
                    .body(jsonObject.toJSONString(), "application/json")
                    .execute();
    int status = httpResponse.getStatus();
    if(status == HttpStatus.HTTP_OK){
        String content = httpResponse.body();
    }
  }
}

Response Parameters

2D Response Success Example


{
  "code": "00000",
  "message": "SUCCESS",
  "data": {
    "tradeNo": "DZ02204201926015340",
    "merOrderNo": "1650453961070",
    "payCode": 0,
    "payUrl": null,
    "payDesc": "success",
    "sourceAmount": "1",
    "currencyCode": "HKD",
    "tradeMerNo": 104001001,
    "sign": "2345D858E5326A6E1747314E658760A9"
  }
}

3D Response Success Example


{
  "code": "00000",
  "message": "SUCCESS",
  "data": {
    "tradeNo": "DZ02204201930225414",
    "merOrderNo": "1650454222321",
    "payCode": 2,
    "payUrl": "https://test.LC-001hk.com/pay-web-h5/cnp_pay/directCashier?accessCode=85200162&mchtId=852999952110013&accessOrderId=DZ02204201930225414",
    "payDesc": "Please redirect to payUrl",
    "sourceAmount": "1",
    "currencyCode": "HKD",
    "tradeMerNo": 104001001,
    "sign": "4B91E93FD32245B600D8780D5C26A0EB"
  }
}

Response Failure Example


{
  "code": "10004",
  "message": "The merchant number does not exist"
}

Parameter name	Required	Type	Explain
code	Yes	String	error code(Refer to the error code table)
message	Yes	String	error description
data	No	T	Request response data

Return Parameters description

Parameter name	Required	Type	Explain
tradeNo	Yes	String	The flow number generated after each order payment (unique marker)
payCode	Yes	Integer	Payment status code(Where: 1 means payment failure, 0 means payment success, 2 means pending)
payUrl	No	String	This parameter is mandatory for 3D payment (the merchant needs to redirect to this link)
merOrderNo	Yes	String	Corresponds to the [OrderNo] parameter of the order submission parameter
payDesc	No	String	Payment message description
sourceAmount	Yes	String	Total amount of the order
currencyCode	Yes	String
tradeMerNo	Yes	String	Unique identifier assigned to the merchant by the Gold Pomelo payment platform when registering with Gold Pomelo
sign	Yes	String	(tradeMerNo、merOrderNo、currencyCode、sourceAmount、payCode、Merchant key) Please refer to See signature for details
billAddress	No	String	Billing Address Descriptor

Error Code

State Code	Description
00000	SUCCESS
10000	Payment method cannot be empty
10001	Payment method does not exist
10002	The parameter cannot be empty
10003	The same order of the same merchant number cannot be submitted repeatedly within the same time
10004	The merchant number does not exist
10005	Merchant not active
10006	Referer cannot be empty
10007	Source url does not comply with relevant regulations
10008	Merchant Url Restriction
10009	Duplicate merchant order number
10010	Merchant does not set transaction currency
10011	The channel is not open
10012	The card type is not bound
10013	Banks don't exist
10014	Currency conversion rate does not exist
10015	Signature error
10016	Exceed daily transaction limit
10017	Exceed monthly transaction limit
10018	Currency cannot be empty
10019	Currency is not open or currency incoming is wrong
10020	There is no single transaction limit
10021	There is no daily trading limit
10022	There is no monthly trading limit
10023	Merchant reaches single transaction limit
10024	Merchants have reached their daily transaction limit
10025	Merchants have reached their monthly transaction limit
99996	Data type conversion exception
99997	The parameter is missing or does not meet the restriction
99998	Channel payment failure
99995	The payment channel connection has timed out
10026	The transaction does not exist or cannot match the original transaction
10027	The order is not confirmed.
10028	The order is being processed for refund
10029	Insufficient refund amount
10031	The query type does not exist
10032	The card type was not recognized
10033	Merchant does not set card discount rate
10034	Merchant does not set margin deduction rate
10035	All quotas have been used up
10036	The channel is disabled.
10037	Transactions with this card are not supported
10038	Success limit
10039	Failed times exceed the set maximum allowed failed times (cardholder)
10040	Block rule block
10141	Card Nubmer Blacklist blocking
10142	IP Blacklist blocking
10143	EMAIL Blacklist blocking
10144	Tel Phone Blacklist blocking
10042	Element is limited
99994	The request mode is incorrect
99995	The payment channel connection has timed out
99996	Data type conversion exception
99997	The parameter is missing or does not meet the restriction
99998	Channel payment failure
99999	System Exception

APM

PayIn

Request Base URL

Test Environment : https://sandbox.paypomelo.com

Prod Environment : https://payment.paypomelo.com

EndPoints

/payment

Request Header

Parameter	Required	Value	说明
paymentCountry	yes	ISO-3	3位国家码
paymentType	yes	API/WEB	paymentType = API 时 CreditCard 直连