API Reference

Main URL: https://dashboard.deltaplan.pro/api/v1/
Endpoints
Balances of the shops
https://dashboard.deltaplan.pro/api/v1/balance/list/

Methods: GET

Request parameters
shop_uuidShop UUID (from Shops table) <string>
Mandatory
api_keyAPI key of general purpose (from Shops table) <string>
Mandatory
Response fields <json>
statusResponse status <string>
Available: success, fail
messageResponse message <string>
dataReturned data <array>
Data fields <array>
blockchainBlockchain network <string>
Available: Binance Smart Chain, Bitcoin, Ethereum, Polygon, Solana, The Open Network, Tron, Fiat
currencyCurrency code <string>
Available: BNB, BTC, ETH, POL, SOL, TON, TRX, USDC, USDT, USD
amountAmount <decimal (36,18)>
crossrateIf true, this balance is USD equivalence of all shop balances of the merchant <boolean>

Transactions of the shops
https://dashboard.deltaplan.pro/api/v1/transaction/list/

Methods: GET

Request parameters
shop_uuidShop UUID (from Shops table) <string>
Mandatory
api_keyAPI key of general purpose (from Shops table) <string>
Mandatory
sortSorting <string>
Available: date, blockchain, currency, amount
Default: date
sort_dirSorting direction <string>
Available: ascending, descending
Default: descending
page_numPage number (for paginated list) <integer>
Default: 1
Minimum: 1
page_countItems amount per page (for paginated list) <integer>
Default: 20
Minimum: 1
Maximum: 100
uuidTransaction UUID <string>
Response fields <json>
statusResponse status <string>
Available: success, fail
messageResponse message <string>
dataReturned data <array>
Data fields <array>
uuidTransaction UUID <string>
typeTransaction type <string>
Available: outgoing_payment, incoming_payment, commission, withdrawal, top_up, internal_transfer
blockchainBlockchain network <string>
Available: Binance Smart Chain, Bitcoin, Ethereum, Polygon, Solana, The Open Network, Tron
currencyCurrency code <string>
Available: BNB, BTC, ETH, POL, SOL, TON, TRX, USDC, USDT
amountAmount <decimal (36,18)>
datePayment creation date (UTC) <date>
Example: 2025-04-26 12:27:59

Incoming payments of the shops
https://dashboard.deltaplan.pro/api/v1/incoming-payment/list/

Methods: GET

Request parameters
shop_uuidShop UUID (from Shops table) <string>
Mandatory
api_keyAPI key for incoming payments (from Shops table) <string>
Mandatory
sortSorting <string>
Available: date, amount, blockchain, currency
Default: date
sort_dirSorting direction <string>
Available: ascending, descending
Default: descending
page_numPage number (for paginated list) <integer>
Default: 1
Minimum: 1
page_countItems amount per page (for paginated list) <integer>
Default: 20
Minimum: 1
Maximum: 100
uuidPayment UUID <string>
statusStatus <string>
Available: created, pending, completed, failed
Response fields <json>
statusResponse status <string>
Available: success, fail
messageResponse message <string>
dataReturned data <array>
Data fields <array>
uuidPayment UUID <string>
referencePayment reference <string>
descriptionDescription <string>
price_blockchainBlockchain network <string>
Available: Binance Smart Chain, Bitcoin, Ethereum, Fiat, Polygon, Solana, The Open Network, Tron
price_currencyCurrency code <string>
Available: BNB, BTC, CAD, ETH, EUR, INR, POL, SOL, TON, TRX, USD, USDC, USDT
pricePrice amount <decimal (36,18)>
feeFee <decimal (36,18)>
statusPayment status <string>
Available: created, signed, pending, processing, completed, failed, canceled
datePayment creation date (UTC) <date>
Example: 2025-04-26 12:27:59

Creating incoming payment
https://dashboard.deltaplan.pro/api/v1/incoming-payment/create/

Methods: POST

Request parameters
shop_uuidShop UUID (from Shops table) <string>
Mandatory
api_keyAPI key for incoming payments (from Shops table) <string>
Mandatory
price_blockchainBlockchain for price <string>
Mandatory
Available: Binance Smart Chain, Bitcoin, Ethereum, Fiat, Polygon, Solana, The Open Network, Tron
price_currencyCurrency code for price <string>
Mandatory
Available: BNB, BTC, CAD, ETH, EUR, INR, POL, SOL, TON, TRX, USD, USDC, USDT
pricePrice amount <decimal (36,18)>
descriptionDescription <string>
referencePayment reference string provided by shop <string>
userfieldsMandatory fields for payer <string>
Separate with comma to add multiple values
Available: email, name, address, phone
payment_currenciesBlockchains and currencies for payment <string>
Separate with comma to add multiple values
Available: Binance Smart Chain / BNB, Binance Smart Chain / USDC, Binance Smart Chain / USDT, Bitcoin / BTC, Ethereum / ETH, Ethereum / USDC, Ethereum / USDT, Polygon / POL, Polygon / USDC, Polygon / USDT, Solana / SOL, Solana / USDC, Solana / USDT, The Open Network / TON, The Open Network / USDT, Tron / TRX, Tron / USDT
Response fields <json>
statusResponse status <string>
Available: success, fail
messageResponse message <string>
dataReturned data <array>
Data fields <array>
uuidPayment UUID <string>
urlPayment URL <string>

Outgoing payments and withdrawals of the shops
https://dashboard.deltaplan.pro/api/v1/outgoing-payment/list/

Methods: GET

Request parameters
shop_uuidShop UUID (from Shops table) <string>
Mandatory
api_keyAPI key for outgoing payments (from Shops table) <string>
Mandatory
sortSorting <string>
Available: date, amount, blockchain, currency, wallet
Default: date
sort_dirSorting direction <string>
Available: ascending, descending
Default: descending
page_numPage number (for paginated list) <integer>
Default: 1
Minimum: 1
page_countItems amount per page (for paginated list) <integer>
Default: 20
Minimum: 1
Maximum: 100
uuidPayment UUID <string>
typeOutgoing payment type <string>
Available: payment, withdrawal
Default: payment
Response fields <json>
statusResponse status <string>
Available: success, fail
messageResponse message <string>
dataReturned data <array>
Data fields <array>
uuidPayment UUID <string>
typeOutgoing payment type <string>
Available: payment, withdrawal
Default: payment
walletRecipient’s wallet address <string>
blockchainBlockchain network <string>
Available: Binance Smart Chain, Bitcoin, Ethereum, Polygon, Solana, The Open Network, Tron
currencyCurrency code <string>
Available: BNB, BTC, ETH, POL, SOL, TON, TRX, USDC, USDT
amountAmount <decimal (36,18)>
feeFee (USD) <decimal (36,18)>
statusPayment status <string>
Available: created, signed, pending, processing, completed, failed, canceled
recipientRecipient <string>
recipient_referenceRecipient reference <string>
recipient_countryCountry of Recipient <string>
recipient_addressAddress of Recipient <string>
referencePayment reference string provided by shop <string>
startPayment starts from (UTC) <date>
Example: 2025-04-26 12:27:59
datePayment creation date (UTC) <date>
Example: 2025-04-26 12:27:59

Creating outgoing payment or withdrawal
https://dashboard.deltaplan.pro/api/v1/outgoing-payment/create/

Methods: POST

Request parameters
shop_uuidShop UUID (from Shops table) <string>
Mandatory
api_keyAPI key for outgoing payments (from Shops table) <string>
Mandatory
typeOutgoing payment type <string>
Available: payment, withdrawal
Default: payment
walletRecipient’s wallet address <string>
Mandatory
blockchainBlockchain <string>
Mandatory
Available: Binance Smart Chain, Bitcoin, Ethereum, Polygon, Solana, The Open Network, Tron
currencyCurrency code <string>
Mandatory
Available: BNB, BTC, ETH, POL, SOL, TON, TRX, USDC, USDT
amountAmount <decimal (36,18)>
Mandatory
recipientRecipient <string>
This field is mandatory if required by applicable law.
recipient_referenceRecipient reference (e.g. e-mail) <string>
recipient_countryCountry of Recipient <string>
This field is mandatory if required by applicable law.
recipient_addressAddress of Recipient <string>
This field is mandatory if required by applicable law.
startPayments starts from (UTC) <date>
Example: 2025-04-26 12:27:59
referencePayment reference string provided by shop <string>
statusSet status: pending (by default), or signed (to send this payment manually later) <string>
Available: pending, signed
Response fields <json>
statusResponse status <string>
Available: success, fail
messageResponse message <string>
dataReturned data <array>
Data fields <array>
uuidPayment UUID <string>

Get service exchange rates
https://dashboard.deltaplan.pro/api/v1/exchange-rate/

Methods: GET

Request parameters
shop_uuidShop UUID (from Shops table) <string>
Mandatory
api_keyAPI key of general purpose (from Shops table) <string>
Mandatory
source_currencyCode of currency to convert from (source currency) <string>
Mandatory
Available: BNB, BTC, CAD, ETH, EUR, INR, POL, SOL, TON, TRX, USD, USDC, USDT
target_currencyCode of currency to convert to (target currency) <string>
Available: BNB, BTC, CAD, ETH, EUR, INR, POL, SOL, TON, TRX, USD, USDC, USDT
Default: USD
source_amountAmount of source currency <decimal (36,18)>
Default: 1
Should be more than: 0
Response fields <json>
statusResponse status <string>
Available: success, fail
messageResponse message <string>
dataReturned data <array>
Data fields <array>
source_currencySource currency code <string>
Available: BNB, BTC, CAD, ETH, EUR, INR, POL, SOL, TON, TRX, USD, USDC, USDT
source_amountAmount of source currency <decimal (36,18)>
target_currencyTarget currency code <string>
Available: BNB, BTC, CAD, ETH, EUR, INR, POL, SOL, TON, TRX, USD, USDC, USDT
target_amountAmount of target currency based on exchange rate <decimal (36,18)>

Callbacks
Callback for incoming payments
Callback fields are being sent to Callback URL of Shop via POST method since incoming payment is created or its status is changed
Callback fields
typeType of callback <string>
Available: incoming_payment, top_up
uuidPayment UUID <string>
shop_uuidShop UUID <string>
shopShop name <string>
referencePayment reference string provided by shop <string>
price_blockchainBlockchain for price <string>
Available: Binance Smart Chain, Bitcoin, Ethereum, Fiat, Polygon, Solana, The Open Network, Tron
price_currencyCurrency code for price <string>
Available: BNB, BTC, CAD, ETH, EUR, INR, POL, SOL, TON, TRX, USD, USDC, USDT
pricePrice amount <decimal (36,18)>
statusPayment status <string>
Available: created, pending, completed, failed
from_walletPayer wallet address <string>
payment_blockchainBlockchain of payment sent <string>
Available: Binance Smart Chain, Bitcoin, Ethereum, Polygon, Solana, The Open Network, Tron
payment_currencyCurrency of payment sent <string>
Available: BNB, BTC, ETH, POL, SOL, TON, TRX, USDC, USDT
payment_amountPayment amount sent <decimal (36,18)>
feeFee paid <decimal (36,18)>
date_createdInvoice creation date (UTC) <date>
Example: 2025-04-26 12:27:59
date_payedPayment creation date (UTC) <date>
Example: 2025-04-26 12:27:59
signatureSignature created from several fields values (payment UUID, shop UUID, incoming API key, payment reference, price blockchain, price currency, price amount, status) concatenated and encrypted with SHA256 <string>

Callback for outgoing payments and withdrawals
Callback fields are being sent to Callback URL of Shop via POST method since outgoing payment or withdrawal is created or its status is changed
Callback fields
typeType of callback <string>
Available: outgoing_payment, withdrawal
uuidPayment UUID <string>
shop_uuidShop UUID <string>
shopShop name <string>
referencePayment reference string provided by shop <string>
to_walletWallet address for payment <string>
blockchainBlockchain <string>
Available: Binance Smart Chain, Bitcoin, Ethereum, Fiat, Polygon, Solana, The Open Network, Tron
currencyCurrency code <string>
Available: BNB, BTC, CAD, ETH, EUR, INR, POL, SOL, TON, TRX, USD, USDC, USDT
amountAmount <decimal (36,18)>
statusPayment status <string>
Available: created, signed, pending, processing, completed, failed, canceled
feeFee paid <decimal (36,18)>
date_createdPayment creation date (UTC) <date>
Example: 2025-04-26 12:27:59
date_completedDate when payment completed (UTC) <date>
Example: 2025-04-26 12:27:59
signatureSignature created from several fields values (payment UUID, shop UUID, outgoing API key, payment reference, blockchain, currency code, amount, status) concatenated and encrypted with SHA256 <string>