API Reference

Balances of the shops

https://dashboard.deltaplan.pro/api/v1/balance/list/

Methods: GET

Head parameters
shop-uuid	Shop UUID (from `Shops` table) <string> Mandatory
api-key	API key of general purpose (from `Shops` table) <string> Mandatory
Body parameters / Standard parameters
format	Output data format <string> Available: json, xml Default: json

status	Response status <string> Available: success, fail
message	Response message <string>
data	Returned data <array>
Data fields <array \| nodeset>
blockchain	Blockchain network <string> Available: Binance Smart Chain, Ethereum, Polygon, Tron, Fiat
currency	Currency code <string> Available: BNB, ETH, POL, TRX, USDC, USDT, USD
amount	Amount <decimal (36,18)>
crossrate	If `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

Head parameters
shop-uuid	Shop UUID (from `Shops` table) <string> Mandatory
api-key	API key of general purpose (from `Shops` table) <string> Mandatory
Body parameters / Standard parameters
format	Output data format <string> Available: json, xml Default: json
sort	Sorting <string> Available: date, blockchain, currency, amount Default: date
sort_dir	Sorting direction <string> Available: ascending, descending Default: descending
page_num	Page number (for paginated list) <integer> Default: 1 Minimum: 1
page_count	Items amount per page (for paginated list) <integer> Default: 20 Minimum: 1 Maximum: 100
uuid	Transaction UUID <string>

status	Response status <string> Available: success, fail
message	Response message <string>
data	Returned data <array>
Data fields <array \| nodeset>
uuid	Transaction UUID <string>
type	Transaction type <string> Available: outgoing payment, incoming payment, withdrawal, top up
related	UUID of item related to this transaction (e.g. UUID of related incoming payment invoice) <string>
blockchain	Blockchain network <string> Available: Binance Smart Chain, Ethereum, Polygon, Tron
currency	Currency code <string> Available: BNB, ETH, POL, TRX, USDC, USDT
amount	Transaction amount <decimal (36,18)>
fee	Fee amount <decimal (36,18)>
date	Payment creation date (UTC) <date> Example: 2026-02-01 17:37:37

Incoming payments of the shops

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

Methods: GET

Head parameters
shop-uuid	Shop UUID (from `Shops` table) <string> Mandatory
api-key	API key for incoming payments (from `Shops` table) <string> Mandatory
Body parameters / Standard parameters
format	Output data format <string> Available: json, xml Default: json
sort	Sorting <string> Available: date, amount, blockchain, currency Default: date
sort_dir	Sorting direction <string> Available: ascending, descending Default: descending
page_num	Page number (for paginated list) <integer> Default: 1 Minimum: 1
page_count	Items amount per page (for paginated list) <integer> Default: 20 Minimum: 1 Maximum: 100
uuid	Payment UUID <string>
status	Status <string> Available: created, pending, completed, failed

status	Response status <string> Available: success, fail
message	Response message <string>
data	Returned data <array>
Data fields <array \| nodeset>
uuid	Payment UUID <string>
reference	Payment reference <string>
description	Description <string>
price_blockchain	Blockchain network <string> Available: Binance Smart Chain, Ethereum, Fiat, Polygon, Tron
price_currency	Currency code <string> Available: BNB, CAD, ETH, EUR, INR, POL, TRX, USD, USDC, USDT
price	Price amount <decimal (36,18)>
fee	Fee <decimal (36,18)>
status	Payment status <string> Available: created, pending, completed, failed
payment_blockchain	Payment blockchain network <string> Available: Binance Smart Chain, Ethereum, Polygon, Tron
payment_currency	Payment currency code <string> Available: BNB, ETH, POL, TRX, USDC, USDT
payment_amount	Amount set for payment <decimal (36,18)>
payment_amount_real	Amount really paid <decimal (36,18)>
address	Address of wallet which receives the payment <string>
tx	TX of completed payment <string>
userfields	Additional fields willed by payer <json>
prefilled	Arbitrary fields passed by your shop to be related to the payment and returned in callbacks <json>
success_url	Success URL to redirect payer after this payment <string>
fail_url	Fail URL to redirect payer after this payment <string>
date	Payment creation date (UTC) <date> Example: 2026-02-01 17:37:37
expiration_date	Payment expiration date (UTC) <date> Example: 2026-02-01 17:37:37

Creating incoming payment

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

Methods: POST

Head parameters
shop-uuid	Shop UUID (from `Shops` table) <string> Mandatory
api-key	API key for incoming payments (from `Shops` table) <string> Mandatory
Body parameters / Standard parameters
format	Output data format <string> Available: json, xml Default: json
price_blockchain	Blockchain for price <string> Mandatory Available: Binance Smart Chain, Ethereum, Fiat, Polygon, Tron
price_currency	Currency code for price <string> Mandatory Available: BNB, CAD, ETH, EUR, INR, POL, TRX, USD, USDC, USDT
price	Price amount <decimal (36,18)>
description	Description <string>
reference	Payment reference string provided by shop <string>
userfields	Fields for payer to fill <array> Available: email, name, address, phone, details, reference, comments Example: ["name", "email"]
prefilled	Arbitrary fields passed by your shop to be related to the payment and returned in callbacks <object> Example: {"name": "John Doe", "email": "johndoe@gmail.com", "arbitrary": 7569}
payment_currencies	Blockchains and currencies for payment <array> Available: Binance Smart Chain / BNB, Binance Smart Chain / USDC, Binance Smart Chain / USDT, Ethereum / ETH, Ethereum / USDC, Ethereum / USDT, Polygon / POL, Polygon / USDC, Polygon / USDT, Tron / TRX, Tron / USDT Example: ["Polygon / POL", "Tron / TRX", "Tron / USDT"]
preferred_payment_currency	Preferred blockchain and currency for faster payment <string> Available: Binance Smart Chain / BNB, Binance Smart Chain / USDC, Binance Smart Chain / USDT, Ethereum / ETH, Ethereum / USDC, Ethereum / USDT, Polygon / POL, Polygon / USDC, Polygon / USDT, Tron / TRX, Tron / USDT
payer_reference	Unique reference string identifying the payer <string>
callback_url	Webhook URL to send callback fields for this payment <string>
success_url	Success URL to redirect payer after this payment <string>
fail_url	Fail URL to redirect payer after this payment <string>

status	Response status <string> Available: success, fail
message	Response message <string>
data	Returned data <array>
Data fields <array \| nodeset>
uuid	Payment UUID <string>
url	Payment URL <string>

Re-sending incoming payment callback

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

Methods: GET, POST

Head parameters
shop-uuid	Shop UUID (from `Shops` table) <string> Mandatory
api-key	API key for incoming payments (from `Shops` table) <string> Mandatory
Body parameters / Standard parameters
format	Output data format <string> Available: json, xml Default: json
uuid	Payment UUID <string> Mandatory

status	Response status <string> Available: success, fail
message	Response message <string>
data	Returned data <array>
Data fields <array \| nodeset>
uuid	Payment UUID <string>
callback_url	Callback URL <string>
notification	Message in the case of success <string>

Outgoing payments and withdrawals of the shops

https://dashboard.deltaplan.pro/api/v1/outgoing-payment/list/

Methods: GET

Head parameters
shop-uuid	Shop UUID (from `Shops` table) <string> Mandatory
api-key	API key for outgoing payments (from `Shops` table) <string> Mandatory
Body parameters / Standard parameters
format	Output data format <string> Available: json, xml Default: json
sort	Sorting <string> Available: date, amount, blockchain, currency, wallet Default: date
sort_dir	Sorting direction <string> Available: ascending, descending Default: descending
page_num	Page number (for paginated list) <integer> Default: 1 Minimum: 1
page_count	Items amount per page (for paginated list) <integer> Default: 20 Minimum: 1 Maximum: 100
uuid	Payment UUID <string>
type	Outgoing payment type <string> Available: payment, withdrawal Default: payment

status	Response status <string> Available: success, fail
message	Response message <string>
data	Returned data <array>
Data fields <array \| nodeset>
type	Outgoing payment type <string> Available: payment, withdrawal Default: payment
uuid	Payment UUID <string>
shop_uuid	Shop UUID <string>
shop	Shop name <string>
wallet	Recipient’s wallet address <string>
price_blockchain	Quoted amount blockchain or network <string> Available: Binance Smart Chain, Ethereum, Fiat, Polygon, Tron
price_currency	Quoted amount currency code <string> Available: BNB, CAD, ETH, EUR, INR, POL, TRX, USD, USDC, USDT
price_amount	Quoted amount <decimal (36,18)>
blockchain	Blockchain network <string> Available: Binance Smart Chain, Ethereum, Polygon, Tron
currency	Currency code <string> Available: BNB, ETH, POL, TRX, USDC, USDT
amount	Amount <decimal (36,18)>
fee	Fee <decimal (36,18)>
status	Payment status <string> Available: created, signed, pending, processing, completed, failed, canceled
recipient	Recipient <string>
recipient_reference	Recipient reference <string>
recipient_country	Country of Recipient <string>
recipient_address	Address of Recipient <string>
reference	Payment reference string provided by shop <string>
tx	TX of completed payment <string>
start	Payment starts from (UTC) <date> Example: 2026-02-01 17:37:37
date	Payment creation date (UTC) <date> Example: 2026-02-01 17:37:37

Creating outgoing payment or withdrawal

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

Methods: POST

Head parameters
shop-uuid	Shop UUID (from `Shops` table) <string> Mandatory
api-key	API key for outgoing payments (from `Shops` table) <string> Mandatory
Body parameters / Standard parameters
format	Output data format <string> Available: json, xml Default: json
type	Outgoing payment type <string> Available: payment, withdrawal Default: payment
wallet	Recipient’s wallet address <string> Mandatory
price_blockchain	Quoted amount blockchain or network <string> Available: Binance Smart Chain, Ethereum, Fiat, Polygon, Tron
price_currency	Quoted amount currency code <string> Available: BNB, CAD, ETH, EUR, INR, POL, TRX, USD, USDC, USDT
price_amount	Quoted amount <decimal (36,18)>
blockchain	Blockchain <string> Mandatory Available: Binance Smart Chain, Ethereum, Polygon, Tron
currency	Currency code <string> Mandatory Available: BNB, ETH, POL, TRX, USDC, USDT
amount	Amount <decimal (36,18)> Mandatory if `price_amount` is empty
recipient	Recipient <string> This field is mandatory if required by applicable law.
recipient_reference	Recipient reference (e.g. e-mail) <string>
recipient_country	Country of Recipient <string> This field is mandatory if required by applicable law.
recipient_address	Address of Recipient <string> This field is mandatory if required by applicable law.
start	Payment starts from (UTC) <date> Example: 2026-02-01 17:37:37
reference	Payment reference string provided by shop <string>
status	Set status: `pending` (by default), or `signed` (to send this payment manually later) <string> Available: pending, signed
callback_url	Webhook URL to send callback fields for this payment <string>

status	Response status <string> Available: success, fail
message	Response message <string>
data	Returned data <array>
Data fields <array \| nodeset>
uuid	Payment UUID <string>

Re-sending outgoing payment callback

https://dashboard.deltaplan.pro/api/v1/outgoing-payment/callback/

Methods: GET, POST

Head parameters
shop-uuid	Shop UUID (from `Shops` table) <string> Mandatory
api-key	API key for incoming payments (from `Shops` table) <string> Mandatory
Body parameters / Standard parameters
format	Output data format <string> Available: json, xml Default: json
uuid	Payment UUID <string> Mandatory

status	Response status <string> Available: success, fail
message	Response message <string>
data	Returned data <array>
Data fields <array \| nodeset>
uuid	Payment UUID <string>
callback_url	Callback URL <string>
notification	Message in the case of success <string>

Get service exchange rates

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

Methods: GET

Head parameters
shop-uuid	Shop UUID (from `Shops` table) <string> Mandatory
api-key	API key of general purpose (from `Shops` table) <string> Mandatory
Body parameters / Standard parameters
format	Output data format <string> Available: json, xml Default: json
source_currency	Code of currency to convert from (source currency) <string> Mandatory Available: BNB, CAD, ETH, EUR, INR, POL, TRX, USD, USDC, USDT
target_currency	Code of currency to convert to (target currency) <string> Available: BNB, CAD, ETH, EUR, INR, POL, TRX, USD, USDC, USDT Default: USD
source_amount	Amount of source currency <decimal (36,18)> Default: 1 Should be more than: 0

status	Response status <string> Available: success, fail
message	Response message <string>
data	Returned data <array>
Data fields <array \| nodeset>
source_currency	Source currency code <string> Available: BNB, CAD, ETH, EUR, INR, POL, TRX, USD, USDC, USDT
source_amount	Amount of source currency <decimal (36,18)>
target_currency	Target currency code <string> Available: BNB, CAD, ETH, EUR, INR, POL, TRX, USD, USDC, USDT
target_amount	Amount of target currency based on exchange rate <decimal (36,18)>

Callback for incoming payments

POST callbacks to the shop’s callback URL are sent on creation and any status change as application/json. Invoice links opened but unpaid are marked failed within one hour.

type	Type of callback <string> Available: incoming_payment, top_up
uuid	Payment UUID <string>
shop_uuid	Shop UUID <string>
shop	Shop name <string>
reference	Payment reference string provided by shop <string>
price_blockchain	Blockchain for price <string> Available: Binance Smart Chain, Ethereum, Fiat, Polygon, Tron
price_currency	Currency code for price <string> Available: BNB, CAD, ETH, EUR, INR, POL, TRX, USD, USDC, USDT
price	Price amount <decimal (36,18)>
fee	Fee paid <decimal (36,18)>
price_fee	Fee amount in the invoice currency <decimal (36,18)> For completed payments. Calculated at the time of payment
status	Payment status <string> Available: created, pending, completed, failed
from_wallet	Payer wallet address <string>
payment_blockchain	Blockchain of payment sent <string> Available: Binance Smart Chain, Ethereum, Polygon, Tron
payment_currency	Currency of payment sent <string> Available: BNB, ETH, POL, TRX, USDC, USDT
payment_amount	The amount, in the payment currency, that the user was required to pay <decimal (36,18)>
payment_amount_real	Amount really paid <decimal (36,18)>
payment_exchange_rate	Payment exchange rate (payment currency to price currency) <decimal (36,18)> For completed payments. Calculated at the time of payment
price_amount_real	Amount really paid, in the invoice currency <decimal (36,18)> For completed payments. Calculated at the time of payment
address	Address of wallet which receives the payment <decimal (36,18)>
tx	TX of completed payment <string>
userfields	Additional fields willed by payer <json>
prefilled	Arbitrary fields passed by your shop to be related to the payment and returned in callbacks <json>
success_url	Success URL to redirect payer after this payment <string>
fail_url	Fail URL to redirect payer after this payment <string>
date_created	Invoice creation date (UTC) <date> Example: 2026-02-01 17:37:37
date_payed	Payment creation date (UTC) <date> Example: 2026-02-01 17:37:37
date_expired	Payment expiration date (UTC) <date> Example: 2026-02-01 17:37:37
signature	Signature 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

POST callbacks to the shop’s callback URL are sent on creation and any status change as application/json. Outgoing payments or withdrawals are marked failed within 24 hours for insufficient balance or other reasons.

type	Type of callback <string> Available: outgoing_payment, withdrawal
uuid	Payment UUID <string>
shop_uuid	Shop UUID <string>
shop	Shop name <string>
reference	Payment reference string provided by shop <string>
to_wallet	Wallet address for payment <string>
price_blockchain	Quoted amount blockchain or network <string> Available: Binance Smart Chain, Ethereum, Fiat, Polygon, Tron
price_currency	Quoted amount currency code <string> Available: BNB, CAD, ETH, EUR, INR, POL, TRX, USD, USDC, USDT
price_amount	Quoted amount <decimal (36,18)>
blockchain	Blockchain <string> Available: Binance Smart Chain, Ethereum, Fiat, Polygon, Tron
currency	Currency code <string> Available: BNB, CAD, ETH, EUR, INR, POL, TRX, USD, USDC, USDT
amount	Amount <decimal (36,18)>
status	Payment status <string> Available: created, signed, pending, processing, completed, failed, canceled
fee	Fee paid <decimal (36,18)>
price_fee	Fee amount in the quoted amount currency <decimal (36,18)> For completed payments. Calculated at the time of payment
payment_exchange_rate	Payment exchange rate (payment currency to price currency) <decimal (36,18)> For completed payments. Calculated at the time of payment
tx	TX of completed payment <string>
date_created	Payment creation date (UTC) <date> Example: 2026-02-01 17:37:37
date_completed	Date when payment completed (UTC) <date> Example: 2026-02-01 17:37:37
signature	Signature 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>