Sign in
Introduction/References

References

Network codes, currency-network mappings, and payment status values used across the 2328.io API.

This page lists all the reference values used across API requests and responses.

Network codes

These codes are used wherever a network field is present:

CodeNetwork
TRX-TRC20Tron TRC-20
BSC-BEP20BNB Smart Chain
ETH-ERC20Ethereum (ERC-20)
AVAX-CAvalanche C-Chain
POL-MATICPolygon (Matic)
TONTON
BTCBitcoin
LTCLitecoin
DASHDash
SOLSolana
DOGEDogecoin

Currency-network mapping

Each currency is only available on a subset of networks. Use this table to pick a valid combination:

CurrencyAllowed networks
USDTTRX-TRC20, BSC-BEP20, ETH-ERC20, AVAX-C, POL-MATIC, TON, SOL
USDCBSC-BEP20, ETH-ERC20, AVAX-C, POL-MATIC, SOL
BTCBTC
ETHETH-ERC20
BNBBSC-BEP20
TRXTRX-TRC20
LTCLTC
DASHDASH
TONTON
AVAXAVAX-C
POLPOL-MATIC
SOLSOL
DOGEDOGE

Payment statuses

The payment_status field on payments and /v1/payment/list filter takes the following values:

StatusDescription
pendingCreated, awaiting initialization
checkAwaiting payment from customer
paidPaid successfully
underpaid_checkUnderpaid (can top up)
underpaidUnderpaid
overpaidOverpaid (credited)
cancelCancelled / expired
aml_lockTransaction blocked due to AML

When listening for a successful payment, you should treat both paid and overpaid as successful states and credit the customer's order.

Payout statuses

The status field on /v1/payout and /v1/payout/status/{uuid} takes one of:

StatusDescription
pendingCreated, awaiting processing
completedCompleted successfully — txid is set
failedSending error — see error_type
cancelledCancelled

Payout error types

When a payout has status = failed, the error_type field describes why:

CodeDescription
aml_riskPayout blocked by AML risk checks (recipient address flagged as high-risk)