Rox CustodyDocs
HomeAPI ReferencePayment Vault OrderGet Payment Vault Orders
GET/payment-orders

Get Payment Vault Orders

Outcome - Retrieves all payment vault orders for the current vault with pagination and filtering support.

Query Parameters

pagenumbernullable

Page number for pagination

limitnumbernullable

Number of results per page

sortKeystringnullable

Field to sort by (createdAt)

orderstringnullable

Sort order (asc or desc)

searchstringnullable

Search by order ID or expiration

filtersobjectnullable

Filter criteria

Show child parameters (3)
statusstringnullable

Filter by order status (PENDING, COMPLETED, CANCELLED, PARTIALLY_PAID, EXPIRED)

assetIdnumbernullable

Filter by asset ID

isCollectedbooleannullable

Filter by collection status (true for collected, false for uncollected)

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

metaobject

Pagination metadata

Show child attributes (6)
totalItemsnumber

Total number of items

itemsPerPagenumber

Items per page

totalPagesnumber

Total pages

currentPagenumber

Current page

hasPreviousPageboolean

Has previous page

hasNextPageboolean

Has next page

statusnumber

HTTP status code

Was this page helpful?

PreviousSelect Payment Vault Order AssetNextGet Payment Vault Order