Skip to main content

Prepare Sell Transaction

POST 
/transactions/sell/prepare

Calculates inputs required for sell endpoint.

Request​

Header Parameters

    Api-Signature string

    Digitally signed JWT.

Body

required
    ChannelID uuidrequired

    Unique identifier for the channel.

    Possible values: >= 36 characters and <= 36 characters

    PaymentMethodID FiatPaymentMethodID (string)

    Existing payment method id to be used.

    Possible values: non-empty and <= 150 characters

    CryptoCurrency CryptoCurrencyCode (string)required

    Cryptocurrency code:

    • BTC
    • USDC
    Example: BTC
    CustomerID CustomerID (string)

    A unique ID which identifies the customer in the Business' internal system and in NOAH.

    Possible values: non-empty and <= 36 characters

    Example: 550e8400-e29b-41d4-a716-446655440000
    FiatAmount PositiveDecimal (string)required

    Positive decimal number in string format

    Possible values: non-empty and <= 38 characters, Value must match regular expression ^[+]?([.]\d+|\d+[.]?\d*)$

    Example: 10.1
    Formobject

    Form input to be submitted based on returned FormSchema

    property name* any

    Form input to be submitted based on returned FormSchema

    DelayedSell boolean

    Set this if Sell is called at a later time after prepare.

Responses​

Sell request data
Schema
    TotalFee PositiveDecimal (string)required

    Positive decimal number in string format

    Possible values: non-empty and <= 38 characters, Value must match regular expression ^[+]?([.]\d+|\d+[.]?\d*)$

    Example: 10.1
    CryptoAmountEstimate PositiveDecimal (string)required

    Positive decimal number in string format

    Possible values: non-empty and <= 38 characters, Value must match regular expression ^[+]?([.]\d+|\d+[.]?\d*)$

    Example: 10.1
    CryptoAuthorizedAmount PositiveDecimal (string)required

    Positive decimal number in string format

    Possible values: non-empty and <= 38 characters, Value must match regular expression ^[+]?([.]\d+|\d+[.]?\d*)$

    Example: 10.1
    FormSessionID uuidrequired

    Unique identifier for the Form Session. Form Session allows ramping using provided form data.

Loading...