Prepare Sell Transaction
POST/transactions/sell/prepare
Calculates the inputs required for the Sell endpoint, intended to be used as a preliminary step for validating transaction details before execution. This allows the business to review estimated fees and limits prior to initiating the actual sell transaction.
Request
Header Parameters
Digitally signed JWT.
- application/json
Body
required
- BTC/BTC_TEST
- USDC/USDC_TEST
Unique identifier for the channel.
Possible values: >= 36 characters
and <= 36 characters
Existing payment method id to be used.
Possible values: non-empty
and <= 150 characters
Cryptocurrency (main/sandbox):
BTC
A unique ID which identifies the customer in the Business' internal system and in NOAH.
Possible values: non-empty
and <= 36 characters
550e8400-e29b-41d4-a716-446655440000
Amount sent to customer's payment method.
Possible values: non-empty
and <= 38 characters
, Value must match regular expression ^[+]?([.]\d+|\d+[.]?\d*)$
10.1
Formobject
Form input to be submitted based on returned FormSchema
Form input to be submitted based on returned FormSchema
When enabled, balance checks are deferred until the final sell request, allowing the order to be prepared now and executed later.
Responses
- 200
- 400
- 401
- 500
- application/json
- Schema
- Example (from schema)
Schema
The total fee that will be charged for using the specific channel, always specified in the same currency as the requested fiat segment of the transaction.
Possible values: non-empty
and <= 38 characters
, Value must match regular expression ^[+]?([.]\d+|\d+[.]?\d*)$
10.1
The maximum amount of cryptocurrency that is authorized to be charged.
Possible values: non-empty
and <= 38 characters
, Value must match regular expression ^[+]?([.]\d+|\d+[.]?\d*)$
10.1
Recommended amount limit to be used in your subsequent /transactions/sell
request
Possible values: non-empty
and <= 38 characters
, Value must match regular expression ^[+]?([.]\d+|\d+[.]?\d*)$
10.1
Unique identifier for the Form Session. Form Session allows ramping using provided form data.
{
"TotalFee": "10.1",
"CryptoAmountEstimate": "10.1",
"CryptoAuthorizedAmount": "10.1",
"FormSessionID": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
}
- application/json
- Schema
- Example (from schema)
Schema
- InvalidMessage
- Unexpected
- ResourceNotFound
- Unauthorized
- Forbidden
- InsufficientBalance
Array [
]
Type of error:
InvalidMessage
A unique reference that identifies the specific occurrence of the problem
Action taking place which resulted in error.
Details about the error.
Extensionsobject
Additional information about the error.
Details about invalid request properties.
Featuresobject
Details about the disabled feature flags
property name*
string[]
List of reasons
string
{
"Type": "InvalidMessage",
"Instance": "string",
"Action": "string",
"Detail": "string",
"Extensions": {
"Request": {},
"Features": {}
}
}
- application/json
- Schema
- Example (from schema)
Schema
- InvalidMessage
- Unexpected
- ResourceNotFound
- Unauthorized
- Forbidden
- InsufficientBalance
Array [
]
Type of error:
InvalidMessage
A unique reference that identifies the specific occurrence of the problem
Action taking place which resulted in error.
Details about the error.
Extensionsobject
Additional information about the error.
Details about invalid request properties.
Featuresobject
Details about the disabled feature flags
property name*
string[]
List of reasons
string
{
"Type": "InvalidMessage",
"Instance": "string",
"Action": "string",
"Detail": "string",
"Extensions": {
"Request": {},
"Features": {}
}
}
- application/json
- Schema
- Example (from schema)
Schema
- InvalidMessage
- Unexpected
- ResourceNotFound
- Unauthorized
- Forbidden
- InsufficientBalance
Array [
]
Type of error:
InvalidMessage
A unique reference that identifies the specific occurrence of the problem
Action taking place which resulted in error.
Details about the error.
Extensionsobject
Additional information about the error.
Details about invalid request properties.
Featuresobject
Details about the disabled feature flags
property name*
string[]
List of reasons
string
{
"Type": "InvalidMessage",
"Instance": "string",
"Action": "string",
"Detail": "string",
"Extensions": {
"Request": {},
"Features": {}
}
}