/payment-orders/cryptoGet Crypto Payment Orders
Outcome - Lists this vault's crypto payment orders, newest first by default.
Query Parameters
limitnumberdefault: 10nullableNumber of results per page, from 1 to 100.
cursorstringnullableCursor from a previous response (meta.nextCursor or meta.previousCursor). Omit it for the first page.
sortKeystringdefault: idnullableField to sort by. Allowed values: id, createdAt, status.
orderstringnullableSort direction: ASC or DESC.
searchstringnullableSearch by order id.
filtersobjectnullableFilters, passed as filters[field]=value. Only the fields listed below are accepted; any other field returns 422.
Show child parameters (3)
statusstringnullableINITIALIZING, PENDING, PAID, EXPIRED, CANCELLED or REFUNDED
assetIdnumbernullableAsset chosen for the order
isCollectedbooleannullableWhether the paid funds have been collected
Responses
Response attributes
messagestringSuccess message
dataarrayArray of payment vault orders
Show child attributes (12)
idstringOrder ID
vaultIdnumberVault ID
statusstringOrder status
amountInDollarstringAmount in USD
amountInFiatstringAmount in fiat currency
amountInAssetstringAmount in cryptocurrency
balancestringCurrent payment balance (amount received)
amountToBeCollectedstringAmount available for collection from the order wallet
walletobjectAssigned wallet details
Show child attributes (11)
idnumberWallet ID
balancestringCurrent wallet balance
pendingBalancestringPending balance
publicAddressstringBlockchain address for payment
transactionsCountstringNumber of transactions
targetIdstringTarget ID
protocolnumberProtocol number
assetobjectAsset details with network information
Show child attributes (13)
idnumberAsset ID
namestringAsset name
symbolstringAsset symbol
contractAddressstring | nullContract address (null for native coins)
decimalsnumberAsset decimals
networkobjectNetwork details
Show child attributes (11)
idnumberNetwork ID
namestringNetwork name
symbolstringNetwork symbol
categorystringNetwork category (EVM, Solana, etc.)
typestringNetwork type (PUBLIC, PRIVATE)
statusstringNetwork status
logostringNetwork logo URL
isSwappablebooleanWhether the network supports swapping
chainobjectChain configuration details
Show child attributes (5)
idnumberChain ID
namestringChain name
nativeCurrencyobjectNative currency details
Show child attributes (3)
namestringCurrency name
symbolstringCurrency symbol
decimalsnumberCurrency decimals
rpcUrlsobjectRPC URLs
Show child attributes (1)
defaultobjectDefault RPC configuration
Show child attributes (1)
httparrayHTTP RPC URLs
blockExplorersobjectBlock explorer details
Show child attributes (1)
defaultobjectDefault block explorer
Show child attributes (2)
namestringExplorer name
urlstringExplorer URL
createdAtstringNetwork creation timestamp
updatedAtstringNetwork update timestamp
typestringAsset type (COIN, TOKEN)
statusstringAsset status
logostringAsset logo URL
vaultStatusstringAsset status in vault
isHiddenbooleanWhether asset is hidden
createdAtstringAsset creation timestamp
updatedAtstringAsset update timestamp
typestringWallet type (ORDER)
createdAtstringWallet creation timestamp
updatedAtstringWallet update timestamp
transactionsarrayList of incoming transactions for this order
Show child attributes (5)
idnumberTransaction ID
amountstringTransaction amount
blockMinedAtstringBlock mining timestamp
blockchainTransactionIdstringBlockchain transaction hash
createdAtstringTransaction creation timestamp
globalIdstringGlobal unique identifier
paymentLinkstringPayment page URL
statusnumberHTTP status code
metaobjectCursor pagination. Pass meta.nextCursor as the cursor query parameter to get the next page, or meta.previousCursor to go back.
Show child attributes (5)
hasNextPagebooleantrue if there are more results after this page
hasPreviousPagebooleantrue if there are results before this page
nextCursorstring | nullCursor for the next page, or null on the last page
previousCursorstring | nullCursor for the previous page, or null on the first page
limitnumberPage size used for this request
Was this page helpful?