API DOCUMENTATION
Crypto payments.
Simple to integrate.
Create an address with payment notifications and transfer your funds.
${URL}/api/v1Address and notifications
One request for the address and its callback.
Create an address for an order and specify where to send its payment notifications.
Handling notifications
/accounts/{account}/addressesRequest parameters
JSONcurrency- The currency:
btc,ltc,trxorusdt@trx. callback.url- The HTTPS notification handler on your website.
callback.data- Your metadata, such as an order reference. Optional.
Save address with the order. Every successful POST creates a new address. Do not retry automatically after a lost response. TRX and USDT share the account’s TRON address list.
curl --request POST \
"${URL}/api/v1/accounts/${ACCOUNT_ID}/addresses" \
--header 'Content-Type: application/json' \
--data-raw '{
"currency": "btc",
"callback": {
"url": "https://shop.example/callback",
"data": {
"order_id": "ORDER_1001"
}
}
}'
{
"address": "YOUR_RECEIVING_ADDRESS"
}
Handling notifications
Set the address callback when creating the address. The default is POST with JSON; callback.method also accepts GET. Omit callback if you do not need notifications.
Save the notification and verify the incoming payment through the API. Reply with HTTP 200, Content-Type: text/plain and exactly *ok*, including the asterisks.
Acknowledging pending with *ok* stops the later confirmed notification. If you rely on notifications for confirmation, send *ok* once you receive the required count.
Example notification
{
"account": "00000000000000000000000000000001",
"currency": "btc",
"value": 100000,
"input_address": "YOUR_RECEIVING_ADDRESS",
"confirmations": 1,
"input_transaction_hash": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
"network": "mainnet",
"event": "confirmed",
"status": "confirmed",
"event_kind": "utxo_output",
"position": 0,
"data": {
"order_id": "ORDER_1001"
}
}
Transfer funds
To your wallet or another recipient.
Send the amount as a whole number in the currency’s smallest unit. Network and API fees are added on top.
/accounts/{account}/transferRequest parameters
JSONcurrency- The currency to send.
transfer-key- Your secret Transfer Key.
destinationsaddressis the recipient;amountis a whole number in the currency’s smallest unit.
Save the returned id. If the response is lost, check the transfer first: repeating the POST could send the funds again.
Fees and transfer results
For a fixed amount, use an integer in the currency’s smallest unit. Fees are added on top unless subtract-fee-from-amount: true is set. A single 100% recipient automatically deducts both fees.
fee: normal selects the normal network fee. fee-limit and processing-fee-limit cap the network and API fees. Omitted limits use the current quote. addresses restricts spending to your selected source addresses.
success means publication; it does not guarantee confirmation. TRX/USDT can initially return pending without a TXID. USDT fees are paid in USDT; the platform supplies execution TRX.
After a timeout, 500 or 503, check the saved payment. A missing ID or a 404 alone does not prove rejection. If the result remains unknown, contact your manager. A TRON payment may be partial: some funds were sent; do not repeat the POST.
curl --request POST \
"${URL}/api/v1/accounts/${ACCOUNT_ID}/transfer" \
--header 'Content-Type: application/json' \
--data-raw '{
"currency": "btc",
"transfer-key": "YOUR_TRANSFER_KEY",
"destinations": [
{
"address": "YOUR_DESTINATION_ADDRESS",
"amount": 100000
}
],
"fee": "normal"
}'
{
"id": "8312c94cb8d4a9025f7d1c783f2be9a446c0e837965219b46792ac8523d9f068",
"status": "success",
"txs": [
"aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
]
}
Amounts are whole numbers in the currency’s smallest unit. 1 BTC = 100,000,000 satoshi