Path parameters

• orderId string Required

  single order ID

Query parameters

• walletAddress string Required

  The wallet address supposedly associated with the order. This is used as a security measure preventing random order browsing.

Responses

• 200 application/json

  Successful operation

  Hide response attributes Show response attributes object

  • id string
  • customId string

    If the "order custom ID" is enabled in the /configuration endpoint, an ID provided by StablyRamp allowing to retrieve the order.

  • userId string
  • link string

    An URI pointing to Stably Ramp page displaying the order details.

  • crypto object
    Hide crypto attributes Show crypto attributes object

    • id string
    • address string
    • network string
  • fiatAmountInUsd string
  • fiat string

    The ISO 4217 code of the fiat currency used to pay for the order.

  • payment string

    The payment method used to buy the crypto. The ID defined in the configuration.

  • providerPayment string

    A provider-defined payment method, providing more details than the payment field. For example, if a VISA credit card was used with with the "debit-credit-card" payment method, this field may contain "VISA".

  • cryptoAmountOut string
  • fiatAmountIn string
  • exchangeRate string

    The exchange rate used to get the amount of crypto

  • processingFees array[object]
    Hide processingFees attributes Show processingFees attributes object

    • label string
    • fiatAmount: string

      Amount of the fee taken, as an amount of the order fiat currency

  • networkFees array[object]
    Hide networkFees attributes Show networkFees attributes object

    • label string
    • fiatAmount: string

      Amount of the fee taken, as an amount of the order fiat currency

  • partnerFees array[object]
    Hide partnerFees attributes Show partnerFees attributes object

    • label string
    • fiatAmount: string

      Amount of the fee taken, as an amount of the order fiat currency

  • createdAt string
  • updatedAt string
  • transactionHash string

    The hash of the transaction transfering the crypto to the user wallet. Depending on Stably Ramp behavior, transfers could be bundled and a single transaction could be linked to multiple orders.

  • walletAddress string

    The wallet address of the user. When the order is completed, crypto funds are sent to this address.

  • status string

    The status of the order. Pending orders are periodically polled by StablyRamp. Completed, failed or cancelled orders are never polled again once StablyRamp detects one of these statuses

    Values are PENDING, COMPLETED, FAILED, or CANCELLED.

  • statusCode string

    If applicable, a code defined by Stably Ramp, providing more details than the StablyRamp-defined status field.

  • statusReason string

    If applicable, information explaining how the order has its current status.

  • partnerAccountId string

    An value identifying Consensys/StablyRamp as the partner associated with the transaction

  • orderType string

    The type of the order. "BUY" for a buy order, "SELL" for a sell order.

    Values are BUY or SELL.

• 500 application/json

  An unexpected error

  Hide response attributes Show response attributes object

  • error string

    A description of the unexpected error.

  • code integer

    The error code associated with the unexpected error.

  • message string

    A detailed error message explaining the issue.