BVbvnk
Trading and Conversions

Get quote

:::warning Transfers v.3 recommended For conversions created through the Transfers v.3 API, query status with GET /payment/v3/transfers/{transferId} instead. The flow differs from the legacy Quote API: v.3 reports a single status field rather than separate quoteStatus and paymentStatus values.

This endpoint remains available for retrieving quotes created via the legacy Quote API. See the migration guide for details. :::

Retrieves a specific quote.

get/api/v1/quote/{uuid}

Request

Path parameters

uuidstring required
Example:0a12a214-1619-43fa-9be1-0029f6a440a0

UUID of the quote you are retrieving.

Response

OK

idinteger

The ID of the quote.

fromstring

The currency to convert from.

tostring

The currency to convert to.

amountInnumber

The amount converted to.

amountDuenumber

The amount due to be converted.

amountOutnumber

The amount being converted out.

pricenumber

The price quoted.

quoteStatus'ESTIMATE' | 'PENDING' | 'ACCEPTED' | 'PAYMENT_IN_FAILED' | 'PAYMENT_OUT_PROCESSED' | 'CONVERSION_FAILED' | 'PAYMENT_OUT_FAILED' | 'REFUNDED'

The status of the quote.

You can expect it to remain in the PENDING status until you call /api/v1/quote/accept/{uuid} and the quote is accepted.

paymentStatus'PENDING' | 'SUCCESS' | 'CANCELLED' | 'FAILED' | 'REFUND_PENDING' | 'REFUNDED' | 'REFUND_FAILED'

The payment status that reflects the progress of the conversion.

You can expect it to remain in the PENDING status until you call /api/v1/quote/accept/{uuid} and the quote is accepted.

acceptanceExpiryDateinteger

The date and time, encoded into UNIX epoch timestamps.

acceptanceDateinteger

The date and time, encoded into UNIX epoch timestamps.

paymentExpiryDateinteger

The date and time, encoded into UNIX epoch timestamps.

paymentReceiptDateinteger

The date and time, encoded into UNIX epoch timestamps.

uuidstring

The UUID of the quote.

payOutInstructionstring
feenumber

The fee for the quote.

processingFeenumber

The processing fee.

type'FIXED' | 'MARKET'

The type of quote.

netPricenumber

The net price fo the quote.

grossPricenumber

The gross price of the quote.

amountInGrossnumber

The price of the quote in gross.

amountInNetnumber

The price of the quote in net.

dateCreatedinteger

The date and time, encoded into UNIX epoch timestamps.

lastUpdatedinteger

The date and time, encoded into UNIX epoch timestamps.

Example response

{
  "id": 1432,
  "from": "EUR",
  "to": "ETH",
  "amountIn": 500,
  "amountDue": 500,
  "amountOut": 1.12,
  "price": 446.43,
  "acceptanceExpiryDate": 1566198657000,
  "acceptanceDate": 1566198657000,
  "paymentExpiryDate": 1566198657000,
  "paymentReceiptDate": 1566198657000,
  "payInLegs": [
    {
      "id": 1432,
      "amount": 100.32,
      "dateCreated": 1566198657000,
      "reference": "65b46950-d4b7-11ee-a174-39a638922745",
      "currency": "EUR"
    }
  ],
  "payInMethod": {
    "id": 5,
    "code": "wallet",
    "settlementCurrency": "USD",
    "requestedCurrency": "EUR",
    "estimatedExchangeRate": 0.923
  },
  "payOutMethod": {
    "id": 1432,
    "code": "gateway",
    "currency": "EUR"
  },
  "uuid": "B6670497-D139-47E8-9F4A-F97A5D977057",
  "payInInstruction": {
    "action": "NONE"
  },
  "usePayInMethod": {
    "id": 1432,
    "display": "null"
  },
  "usePayOutMethod": {
    "id": 1432,
    "display": "null"
  },
  "fee": 1.02,
  "processingFee": 1.02,
  "netPrice": 1234.02,
  "grossPrice": 1134.02,
  "amountInGross": 102,
  "amountInNet": 104,
  "dateCreated": 1566198657000,
  "lastUpdated": 1566198657000
}

Changes

No recorded changes to this operation across all 3 revisions of this API.