GET/api/v2/crypto-virtual-accounts/transfers/{id}

Get a the crypto on/off-ramp transfer workflow

Returns funding, quote, approval, exchange, settlement, payout, return-fee, and completion state for one transfer.

Authentication

Send your API key in the x-api-key header on every request.

Parameters

Request parameters
FieldTypeRequiredDescription
id (path)integer (int32)Yes
userId (query)unknownNo

Responses

200 — OK

Response 200 fields
FieldTypeRequiredDescription
IdunknownNo
StatusstringNo
BoomFiVirtualAccountIdstringNo
CryptoCurrencystringNo
CryptoAmountstringNo
ChainIdunknownNo
FiatCurrencystringNo
BoomFiOrderIdstringNo
BoomFiQuoteIdstringNo
BoomFiOrderStatusstringNo
BoomFiSettlementStatusstringNo
ToAmountstringNo
EffectiveRatestringNo
FailureMessagestringNo
SlackChannelIdstringNo
SlackThreadTsstringNo
SlackPermalinkstringNo
CompletedAtstring (date-time)No
CompletionMessagestringNo
TransferDirectionstringNo
InitialExchangeRatestringNo
InitialFeeAmountstringNo
InitialFeeCurrencystringNo
CurrentFeeAmountstringNo
CurrentFeeCurrencystringNo
RateDeviationPercentunknownNo
AutoExecutionTolerancePercentunknownNo
QuoteDecisionStatusstringNo
QuoteExpiresAtstring (date-time)No
FundsDecisionstringNo
ReturnFeeAmountstringNo
ReturnFeeCurrencystringNo
SourceTransferIdstringNo

400 — Bad Request

Response 400 fields
FieldTypeRequiredDescription
MessagestringNo
CodestringNo
StatusunknownNo
ValidationErrorsobjectNo
DetailsstringNo

404 — Not Found

Response 404 fields
FieldTypeRequiredDescription
MessagestringNo
CodestringNo
StatusunknownNo
ValidationErrorsobjectNo
DetailsstringNo

Example request

curl -X GET "https://{base_url}/api/v2/crypto-virtual-accounts/transfers/{id}" \
  -H "x-api-key: YOUR_API_KEY"

This page is generated from the live OpenAPI specification and always matches the current API.