Create Payout
Interface address
POST https://api.tokenpay.me/v1/payout/payment
Interface parameters
Name
Location
Type
Required
Description
app_id
body
string
Yes
Application ID, example value: 8e4b8c2e7cxxxxxxxx1a1cbd3d59e0bd
mch_id
body
string
Yes
Merchant ID, example value: 1234567890
description
body
string
No
Description, example value: 1234567890
out_trade_no
body
string
No
Merchant order number(out_trade_no
and transaction_id
pass at least one)
amount
body
string
Yes
Payout amount
chain
body
string
Yes
Owned public chain, example value: TRON
、ETHEREUM
、BSC
. View supported public chains
to_address
body
string
Yes
Collection address
attach
body
string
No
Custom parameter. It returns as-is in the query API and payment notifications and can be used as a custom parameter. In practice, this field is returned only when the payment is complete.
Interface return
Name
Time
Required
Description
msg
string
true
Statements
request_id
string
true
Example retrun
{
"code": 0,
"msg": "ok",
"request_id": "08250916-a677-4a36-a090-323807ac644c",
"data": {
"out_trade_no": "fb722ca8-ed7b-444b-9f58-0b5c8a7b52cb",
"transaction_id": "e98b3029477f4bdcb971797a9d9e09ce",
"trade_state": "SUCCESS",
"description": "recharge",
"block_no": 33215220,
"create_time": 1673407302044,
"block_time": 1673407329000,
"expire_time": 1673407902044,
"expire_second": 0,
"pay_time": 1673407329000,
"close_time": 0,
"tx_id": "9fdf0ab5823e23225f93bcc644af30a6ab83b6583a8e29e359ee80219802a33a",
"from_address": "TULRFYoFuEmUbxxxxxxxx8nQYFHJ88888",
"contract_address": "",
"to_address": "TQjxEW2Z3p9wjoxxxxxxxxgJUrWXBun91w",
"amount": 15000000,
"chain": "TRON",
"decimals": 6,
"attach": "anim dolore",
"service_amount": 45000,
"service_amount_currency": "USDT",
"notify_url": "/console/callback/pay",
"notify_num": 1,
"notify_status": 2,
"status": 2,
"currency": {
"type": "TRX",
"chain": "TRON",
"code": "TRON_TRX",
"currency": "TRX",
"name": "TRX",
"sub_name": "TRON",
"logo": "https://static.tronscan.org/production/logo/trx.png",
"contract_address": "",
"decimal": 6,
}
}
}
Example code
curl --location --request POST 'https://api.tokenpay.me/v1/payout/payment' \
--header 'Authorization: <Authorization>' \
--header 'User-Agent: tokenpay API (https://tokenpay.me)' \
--header 'Content-Type: application/json' \
--data-raw '<body data here>'
Last updated