Rox CustodyDocs
HomeAPI ReferencePayment Vault OrderCreate Payment Vault Order
POST/payment-orders

Create Payment Vault Order

Outcome - Creates a new payment vault order for processing crypto payments. The order will be created with PENDING status and a payment link will be generated.

Body Parameters

amountInFiatnumberrequiredmax(1,000,000,000)

Amount to be paid in fiat currency

idstringmax(42)

Custom order ID (if not provided, a ULID will be generated)

clientNamestringmax(255)

Name of the client making the payment

itemNamestringmax(255)

Name of the item being purchased

assetIdnumber

ID of the asset to receive payment in. If provided, a wallet will be immediately assigned.

emailstringemail format

Customer email address for payment notifications

Responses

Response attributes

messagestring

Success message

dataobject

Created payment vault order details

Show child attributes (18)
idstring

Order ID

vaultIdnumber

Vault ID associated with this order

walletIdnumber

ID of the assigned wallet (null if no asset selected)

clientNamestring

Name of the client

itemNamestring

Name of the item being purchased

statusstring

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

amountInDollarstring

Amount converted to USD

amountInFiatnumber

Original amount in fiat currency

emailstring

Customer email

walletobject

Assigned wallet details (null if no asset selected)

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

assetobject

Selected asset details

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

balancestring

Current order balance

paymentLinkstring

URL for the payment page

globalIdstring

Global unique identifier (ULID)

amountInAssetstring

Amount to be paid in the selected cryptocurrency

expirationstring

Order expiration timestamp

createdAtstring

Order creation timestamp

updatedAtstring

Order last updated timestamp

statusnumber

HTTP status code

Was this page helpful?

PreviousTransfer NFT TokenNextSelect Payment Vault Order Asset