0% found this document useful (0 votes)
294 views7 pages

PayMe API Document

1. The document describes PayMe's API for processing orders and withdrawals. It provides details on the request parameters, signatures, and responses for submitting orders, order callbacks, withdrawal applications, and withdrawal callbacks. 2. Requests use GET/POST with application/x-www-form-urlencoded format and require parameters like merchant ID, order number, amount, and a signature. Callbacks return in 5 seconds with status and signature to validate. 3. Withdrawal applications require additional parameters like payment password, bank/wallet details depending on currency. Responses return a status code to indicate success or failure.
Copyright
© © All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as PDF, TXT or read online on Scribd
0% found this document useful (0 votes)
294 views7 pages

PayMe API Document

1. The document describes PayMe's API for processing orders and withdrawals. It provides details on the request parameters, signatures, and responses for submitting orders, order callbacks, withdrawal applications, and withdrawal callbacks. 2. Requests use GET/POST with application/x-www-form-urlencoded format and require parameters like merchant ID, order number, amount, and a signature. Callbacks return in 5 seconds with status and signature to validate. 3. Withdrawal applications require additional parameters like payment password, bank/wallet details depending on currency. Responses return a status code to indicate success or failure.
Copyright
© © All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as PDF, TXT or read online on Scribd
You are on page 1/ 7

PayMe API Document

version:V1.1

1. Submit order

The access party assembles the parameters as required, and the obtained

address can be provided to the front desk to jump. md5key is obtained from

the background。

Request type:GET/POST
Data format:application/x-www-form-urlencoded
API address:https://user.payme999.com/api/payment
parameter:

Parameter required explanation


name

merchantId Y Customer ID, obtained in the


background

orderNo Y Merchant order number,


maximum length 32
characters

customerId Y Buyer's name

orderCurrency Y
Order currency, fixed value:
CNY or USDT

orderAmount Y
The order amount

notifyUrl Y notification callback address

callbackUrl Y Transaction completion


jump address

signType Y signature type, fixed value:


MD5
sign Y sign

languageType N Display language, fixed


value: CHN or UK, default
value CHN

How to sign:

Concatenate the parameters in the following order, and then use MD5 for hash
operation to get the sign value.

notifyUrl + callbackUrl + signType + orderNo + orderAmount + orderCurrency +


customerId + md5Key
for example:

sign = md5( notifyUrl + callbackUrl + signType + orderNo + orderAmount +

orderCurrency + customerId + md5Key );

Get the jump url as :

https://user.payme999.com/api/payment?merchantId=xx&orderNo=xx&customerId=x
xxxxx&orderCurrency=xx&orderAmount=xx&notifyUrl=xx&callbackUrl=xx&signType

=xx&languageType=CHN&sign=xx

Remark:

If the order currency is CNY, it will be automatically converted to the equivalent

USDT quantity according to the latest exchange rate, and the quantity will be

rounded up to two significant digits.

2. Order callback notification

After the order is confirmed successfully, the system takes the notifyUrl

parameter when submitting the order as the notification address. Generally, a

callback is initiated in about 5s.

Request type:POST

Data format:application/x-www-form-urlencoded

parameter:
Parameter name required explanation

orderNo Y Merchant order number,


maximum length 32 characters
orderCurrency Y
Order currency, fixed value: CNY
or USDT
orderAmount Y
The order amount

transactionId Y Platform order number

status Y success(default)

signType Y signature type, fixed value:MD5

sign Y sign

How to sign:

Use the values of the following fields, concatenate in the order given below, and
perform md5 encryption

signType + orderNo + orderAmount + orderCurrency + transactionId + status +

md5Key

for example: sign = md5( signType + orderNo + orderAmount +

orderCurrency +transactionId + status + md5Key );

Then the sign value is used to determine whether the request is forged.

response:

The system repeats the notification 5 times, the access party returns the string

success, and the system will regard the notification as successful after receiving it.

If an error is encountered, the system will wait for 3 minutes.

3. Apply for withdrawal

The access party assembles the parameters as required, and the obtained
address can be provided to the front desk to jump. md5key is obtained from

the background.

Request type:GET/POST
Data format:application/x-www-form-urlencoded
API address: https://user.payme999.com/APIWithdrawal/Withdrawal
parameter:

Parameter name required explanation

merchantId Y Customer ID, obtained in the


background

orderNo Y Merchant order number,


maximum length 32 characters

orderCurrency Y
Order currency, fixed value:
CNY or USDT

orderAmount Y
The order amount

payPasswordMD5 Y The payment password after MD5


encryption, such as: 123456 is the
value after md5 encryption:
e10adc3949ba59abbe56e057f20f883e

bankName N(Required when the Bank name, such as: Bank of China
value of orderCurrency
is CNY)

bankAccountName N(Required when the Cardholder name, eg: Mike


value of orderCurrency
is CNY)

bankAccount N(Required when the bank card number, such as:


value of orderCurrency 6214856549854612
is CNY)

USDTType N(Required when the USDT type, fixed value: ERC20 or


TRC20
value of orderCurrency
is USDT)

coinAddress N(Required when the Withdrawal address


value of orderCurrency
is USDT)
notifyUrl Y notification callback address

signType Y signature type, fixed value:MD5

sign Y sign

How to sign:

When orderCurrency is CNY, splice the parameters in the following order,

and then use MD5 to perform hash operation to get the sign value

notifyUrl + orderNo + orderAmount+ orderCurrency + bankName +

bankAccountName+ bankAccount+ payPasswordMD5 + md5Key

for example :

sign = md5(notifyUrl + orderNo + orderAmount+ orderCurrency +

bankName + bankAccountName+ bankAccount+ payPasswordMD5 +

md5Key );

get the url as :

https://user.payme999.com/APIWithdrawal/Withdrawal?merchantId=xx&orderNo=xx
&orderCurrency=CNY&orderAmount=xx&payPasswordMD5=xx&bankName=xx&bankAcc

ountName=xx&bankAccount=xx&notifyUrl=xx&signType=MD5&sign=xx

When orderCurrency is USDT, concatenate the parameters in the following

order, and then use MD5 to perform hash operation to obtain the sign value

notifyUrl + orderNo + orderAmount+ orderCurrency + USDTType +

coinAddress+ payPasswordMD5 + md5Key

for example:

sign = md5(notifyUrl + orderNo + orderAmount+ orderCurrency +

USDTType + coinAddress+ payPasswordMD5 + md5Key);

get the url as :

https://user.payme999.com/APIWithdrawal/Withdrawal?merchantId=xx&orderNo=xx
&orderCurrency=USDT&orderAmount=xx&payPasswordMD5=xx&USDTType=xx&
coinAddress=xx&notifyUrl=xx&signType=MD5&sign=xx
response:

After calling the interface, json data will be returned, such as: {"msg":"Withdrawal
application successful","status":0,"url":"","data":null};

status=0 means the submission is successful, status=-1 means the submission fails

4. Withdrawal callback notification

After the withdrawal is confirmed successfully, the system takes out the

notifyUrl parameter of the withdrawal order as the notification address.

Generally, a callback is initiated in about 5s。

Request type:POST

Data Format:application/x-www-form-urlencoded

parameter:

Parameter required explanation


name
orderNo Y Merchant order number,
maximum length 32
characters
orderCurrency Y
Order currency, fixed value:
CNY or USDT
orderAmount Y
The order amount

transactionId Y Platform order number

status Y success(default)

signType Y signature type, fixed value:


MD5
sign Y sign
How to sign:

Use the values of the following fields, concatenate in the order given below, and
perform md5 encryption

signType + orderNo + orderAmount + orderCurrency + transactionId + status +

md5Key

for example: sign = md5( signType + orderNo + orderAmount +

orderCurrency +transactionId + status + md5Key );

Then the sign value is used to determine whether the request is forged。

response:

The parameter status=success means that the acceptor has made payment, and
status=fail means that the withdrawal order is invalid.

The system repeats the notification 5 times, the access party returns the string
success, and the system will regard the notification as successful after receiving it. If
an error is encountered, the system will wait for 3 minutes.

You might also like