Bot Create Order
Introduction
This interface can be used when accessing Crypto Payment on telegram. ACH returns a web url and pulls up a page for user payment.
Regarding telegram bot, three usage modes are provided, depending on which front-end the merchant pulls up the payment page.
-
Browser mode: The merchant pulls up the weburl in the browser, and the payment page will be opened in the browser. After payment, it will jump to the redirectURL uploaded by the merchant
-
MINIAPP mode: The merchant pulls up the weburl in the miniapp, and the payment page will be embedded in the miniapp. The pop-up window will be closed after the payment is successful.(No need to uploaded redirectURL)
-
Bot mode: The merchant pulls up the ACH's bot, and jumps back to the merchant's bot after the payment is successful.
API Description
Request Method:POST
Request Path:/open/api/tg/payment/V2
Request Parameters
Body Parameters
Parameter | Sign | Mandatory | Type | Length | Remarks |
|---|---|---|---|---|---|
appId | Y | Y | string | 64 | AppId is uniqle for merchant |
merchantOrderNo | Y | Y | string | 64 | Customer transaction ID |
orderAmount | Y | Y | string | 64 | Order amount (amount unit: dollar) |
payCurrency | Y | Y | string | 64 | Currency of payment (EUR / USD) |
userId | Y | Y | string | 128 | UserId is uniqle for user (email / phone number) |
paymentTokens | Y | N | string | 128 |
|
redirectURL | N | N | string | 512 | The redirection address after the successful purchase |
callbackURL | N | N | string | 512 | The address receiving order webhook |
customParam | N | N | string | 512 | Merchant custom parameters |
expiredTime | N | N | string | 32 | Time of expire (no more than 172800 second) |
payType | N | N | string | 32 | Type of payment |
paymentNetworks | N | N | string | 32 | Specify payment network(separated by comma) |
orderModel | N | N | string | 32 | Order mode (ORDER/RECHARGE) capital letter required ORDER: order mode order would related to order amount strictly, order fails when user payment amount lower than order amount. |
paymentExchange | Y | N | string | 512 | Payment method require configuration exchange method/ wallet method. |
tgModel | N | N | string | 32 | Telegram front-end display mode: BROWSER/MINIAPP/BOT |
“customParam”: Extension parameter (required when tgModel is set to BOT)
| Parameter | Sign | Mandatory | Type | Remarks |
|---|---|---|---|---|
| botName | N | N | string | bot user name |
| chatId | N | N | string | user tg chatId |
| orderDetail | N | N | string | Order description |
Payment Methods
| Payment Method | Payment Method Code |
|---|---|
| QR Code Payment | WALLET |
| Binance Pay | BINANCE_PAY |
| Exchange | EXCHANGE |
| Wallet Payment | WALLET_PAY |
Exchange Codes
| Exchange | Code |
|---|---|
| Kraken | 16f021b0-f220-4bbb-aa3b-82d423301957 |
| Paxos | 2fdd678d-8ece-49f5-992c-a1d7c4367833 |
| Bybit | 3b8d8911-b2c0-4c1a-9127-675653c21960 |
| Coinbase | 47624467-e52e-4938-a41a-7926b6c27acf |
| Robinhood | 6e192ebb-a073-4055-bbd7-d644539c9a20 |
| Binance | 9226e5c2-ebc3-4fdd-94f6-ed52cdce1420 |
Wallet Codes
| Wallet | Code |
|---|---|
| Metamask | 34aeb688-decb-485f-9d80-b66466783394 |
| Trust Wallet | 7f4307ea-58c6-4678-9eb2-fec205de5401 |
| Coinbase Wallet | 6132432e-d59c-4555-9844-cea0ce600ba3 |
| Uniswap Wallet | 58c89cae-b2ff-4176-85a3-1d1f7795cbe0 |
| Blockchain Wallet | d22f63a1-50c0-4439-961c-870fc430c979 |
| Bitcoin.com Wallet | f4b147b5-d166-4e6e-b4c1-e59d401cde11 |
| Crypto.com Wallet Prime | e16f1dc8-7577-4170-a67f-5ebb266e410e |
| imToken | 7f523342-0bc6-4465-a035-bb4d2ed693ed |
| Rainbow | 8a60d227-2825-4158-b14b-3c8443a2b681 |
Payment Currency
| Currency | Regular | Example |
|---|---|---|
| USD | 2 non-zero decimal places after the decimal point | 100.12 |
| EUR | 2 non-zero decimal places after the decimal point | 100.12 |
| HKD | 2 non-zero decimal places after the decimal point | 100.12 |
| IDR | integer | 1000 |
| THB | integer | 1000 |
| VND | integer | 1000 |
| Token Name(USDT) | The token used for unit configured, 8 non-zero decimal places after the decimal point | 1.12345678 |
Telegram Front-end Display Mode
Mode | Name | Difference of WebURL | Difference of RedirectURL |
|---|---|---|---|
BROWSER | Browser Mode | webUrl payment http address | redirectURL: |
MINIAPP | Pop-up mode | webUrl payment http address | redirectURL: |
BOT | Jump to payment bot mode | webUrl payment bot address | redirectURL: |
Request Parameter Example
{
"appId": "6fdbaac2********5ad705e9293",
"callbackURL": "https://crypto-payment-sbx.alchemy.cc/crypto/bot/cpCallback",
"customParam": "{\"botName\":\"ABCDCryptoPaymentTestBot\",\"orderDetail\":\"ABDC Test BAG 🎒\",\"chatId\":\"68*****61\"}",
"expiredTime": "999999",
"merchantOrderNo": "17243134568514",
"orderAmount": "10",
"orderModel": "ORDER",
"payCurrency": "USD",
"sign": "TEST000001",
"tgModel": "MINIAPP",
"userId": "51*****[email protected]"
}Response Parameters
Body Parameters
| Parameter | Type | Details |
|---|---|---|
| success | boolean | Success |
| error | boolean | Error |
| code | long | Response code |
| msg | string | Response message |
| traceId | string | Trace id |
| model | object | Response details |
| └─orderNo | string | Order number |
| └─webUrl | string | Checkout url |
Response Parameter Example
{
"code": "0",
"model": {
"orderNo": "300217243809185440066",
"webUrl": "https://sbx-crypto-payment.alchemypay.org?orderNum=300217243809185440066"
},
"msg": "success",
"traceId": "66c7f6f6f7e8c1827f4fe27905f96546"
}Updated 14 days ago