Using Paylink
GET /pay
This payment method is easy to set up and is suitable for scenarios that require repeated use.
Endpoint URL
https://mixpay.me/pay
Authentication and options
Authorization | Public Access |
Limitation | No limitation |
Parameters
Param | Optional | Type | Description |
---|---|---|---|
payeeId | *required | String | Account ID for receiving money, pls see Three types of account and How to get payeeId . |
orderId | *required if no traceId | String | Unique in your system. String lengths between 6-36 must be letters, numbers, dashes and underscores and NOT space. orderId and payeeId make a payment unique. |
traceId | optional | String | UUID, used to prevent double payment and to check the payment result. You should use orderId instead. |
settlementAssetId | optional | String | assetId of settlement cryptocurrency. Settlement assets you prefer. If left blank, the payee will receive the cryptocurrency the user pays for. But you need to pay attention to the strictMode field. |
strictMode | optional | Integer | You can set 0 or 1 . Default 0 . 1 means that the payment must be settled strictly according to the currency set by settlementAssetId. See here
for more details. |
quoteAssetId | optional | String | assetId of quote cryptocurrency. |
quoteAmount | optional | Numeric | Amount of cryptocurrency received, if left blank, the user can enter manually. |
remark | optional | String | maximum 50. Payment remark viewable by the payer. |
settlementMemo | optional | String | maximum 200. A memo is similar to Mixin Snapshots, this parameter you can customise. |
returnTo | optional | String | After successful payment, the page will jump to returnTo URL. |
failedReturnTo | optional | String | After payment failure, the page will jump to failedReturnTo URL. |
callbackUrl | optional | String | After payment successfully, MixPay will issue a POST request to this URL on our server-side. For security reasons, URLs only support HTTPS and has to be URL encoded . Please refer to Payment Callback . |
expiredTimestamp | optional | int | Set a expired timestamp
. This value must be greater than 10s and less than 240min. After this period, the payment result status field will be marked as failed , and the failureReason will be Payment overtime . If you are not setting this value, the payer can have unlimited time to complete this payment. |
style | optional | String | This field is generally used in the scenario of using DApp, passing in mobile will display all available payment methods. |
Example request - Get Payment Link
You can copy the link and open it in a browser:
https://mixpay.me/pay?payeeId=a0d7791408776b47eb1dd3f94ed15d6a&settlementAssetId=c6d0c728-2624-429b-8e0d-d9d19b6592fa"eAssetId=usd"eAmount=10
We recommend short link if you want to use so many parameters.
Although this method is more convenient, and you may be more inclined to use this method of splicing parameters, you need to pay attention that when using this method, people can easily in the browser change the parameters you set.