GET/payment-orders/{orderId}

Get Payment Vault Order

Outcome - Retrieves a single payment vault order by its ID.

Path Parameters

orderIdstring

The ID of the payment order to retrieve

Responses

Response attributes

messagestring

Success message

dataobject

Payment vault order details

Show child attributes (19)
idstring

Order ID

vaultIdnumber

Vault ID

clientNamestring

Client name

itemNamestring

Item name

statusstring

Order status (PENDING, COMPLETED, CANCELLED, PARTIALLY_PAID, EXPIRED, PAID)

amountInDollarstring

Amount in USD

amountInFiatstring

Amount in vault's fiat currency

emailstring

Customer email

expirationstring

Order expiration time

walletIdstring

Wallet ID

vaultobject

Vault configuration details

Show child attributes (4)
idnumber

Vault ID

namestring

Vault name

fiatCurrencyobject

Fiat currency details

Show child attributes (4)
idnumber

Currency ID

namestring

Currency name

symbolstring

Currency symbol

pricingIdstring

Pricing identifier

photostring | null

Vault photo URL

walletobject

Wallet details with asset and network information

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 (15)
idnumber

Asset ID

networkIdnumber

Network ID

pricingIdstring

Pricing 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

amountToBeCollectedstring

Amount available for collection

transactionsarray

Array of completed incoming transactions

Show child attributes (5)
idnumber

Transaction ID

amountstring

Transaction amount

blockMinedAtstring

Block mining timestamp

blockchainTransactionIdstring

Blockchain transaction hash

createdAtstring

Transaction creation timestamp

balancestring

Total amount received from transactions

expirationWithTolerancestring

Expiration time with tolerance period

paymentLinkstring

Payment page URL

globalIdstring

Global unique identifier

amountInAssetstring

Amount in cryptocurrency

statusnumber

HTTP status code

Was this page helpful?