GET/payment-orders/crypto

Get Crypto Payment Orders

Outcome - Lists this vault's crypto payment orders, newest first by default.

Query Parameters

limitnumberdefault: 10nullable

Number of results per page, from 1 to 100.

cursorstringnullable

Cursor from a previous response (meta.nextCursor or meta.previousCursor). Omit it for the first page.

sortKeystringdefault: idnullable

Field to sort by. Allowed values: id, createdAt, status.

orderstringnullable

Sort direction: ASC or DESC.

searchstringnullable

Search by order id.

filtersobjectnullable

Filters, passed as filters[field]=value. Only the fields listed below are accepted; any other field returns 422.

Show child parameters (3)
statusstringnullable

INITIALIZING, PENDING, PAID, EXPIRED, CANCELLED or REFUNDED

assetIdnumbernullable

Asset chosen for the order

isCollectedbooleannullable

Whether the paid funds have been collected

Responses

Response attributes

messagestring

Success message

dataarray

Array of payment vault orders

Show child attributes (12)
idstring

Order ID

vaultIdnumber

Vault ID

statusstring

Order status

amountInDollarstring

Amount in USD

amountInFiatstring

Amount in fiat currency

amountInAssetstring

Amount in cryptocurrency

balancestring

Current payment balance (amount received)

amountToBeCollectedstring

Amount available for collection from the order wallet

walletobject

Assigned wallet details

Show child attributes (11)
idnumber

Wallet ID

balancestring

Current wallet balance

pendingBalancestring

Pending balance

publicAddressstring

Blockchain address for payment

transactionsCountstring

Number of transactions

targetIdstring

Target ID

protocolnumber

Protocol number

assetobject

Asset details with network information

Show child attributes (13)
idnumber

Asset ID

namestring

Asset name

symbolstring

Asset symbol

contractAddressstring | null

Contract address (null for native coins)

decimalsnumber

Asset decimals

networkobject

Network details

Show child attributes (11)
idnumber

Network ID

namestring

Network name

symbolstring

Network symbol

categorystring

Network category (EVM, Solana, etc.)

typestring

Network type (PUBLIC, PRIVATE)

statusstring

Network status

logostring

Network logo URL

isSwappableboolean

Whether the network supports swapping

chainobject

Chain configuration details

Show child attributes (5)
idnumber

Chain ID

namestring

Chain name

nativeCurrencyobject

Native currency details

Show child attributes (3)
namestring

Currency name

symbolstring

Currency symbol

decimalsnumber

Currency decimals

rpcUrlsobject

RPC URLs

Show child attributes (1)
defaultobject

Default RPC configuration

Show child attributes (1)
httparray

HTTP RPC URLs

blockExplorersobject

Block explorer details

Show child attributes (1)
defaultobject

Default block explorer

Show child attributes (2)
namestring

Explorer name

urlstring

Explorer URL

createdAtstring

Network creation timestamp

updatedAtstring

Network update timestamp

typestring

Asset type (COIN, TOKEN)

statusstring

Asset status

logostring

Asset logo URL

vaultStatusstring

Asset status in vault

isHiddenboolean

Whether asset is hidden

createdAtstring

Asset creation timestamp

updatedAtstring

Asset update timestamp

typestring

Wallet type (ORDER)

createdAtstring

Wallet creation timestamp

updatedAtstring

Wallet update timestamp

transactionsarray

List of incoming transactions for this order

Show child attributes (5)
idnumber

Transaction ID

amountstring

Transaction amount

blockMinedAtstring

Block mining timestamp

blockchainTransactionIdstring

Blockchain transaction hash

createdAtstring

Transaction creation timestamp

globalIdstring

Global unique identifier

paymentLinkstring

Payment page URL

statusnumber

HTTP status code

metaobject

Cursor pagination. Pass meta.nextCursor as the cursor query parameter to get the next page, or meta.previousCursor to go back.

Show child attributes (5)
hasNextPageboolean

true if there are more results after this page

hasPreviousPageboolean

true if there are results before this page

nextCursorstring | null

Cursor for the next page, or null on the last page

previousCursorstring | null

Cursor for the previous page, or null on the first page

limitnumber

Page size used for this request

Was this page helpful?