Create Sell Transaction

POST 
/transactions/sell

Initiate a transaction to sell the specified crypto currency and send the requested fiat currency to the specified payout method. Allows for sending form data to submit a payment method.

Request

Header Parameters

Api-Signature string

Digitally signed JWT.

application/json

Body

required

CryptoCurrency CryptoCurrencyCode (string)required
Cryptocurrency code:
• BTC
• USDC
Example: BTC
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
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.

Nonce Nonce (string)required
A string which must be unique each time a new transaction is created, like a UUID or operation sequence number. Request can be idempotently retried by using the same Nonce.
Possible values: non-empty and <= 36 characters
Example: dc879b38-494b-4de7-98a9-068703144328
ExternalID ExternalID (string)

Unique identifier in user's system.

Possible values: non-empty and <= 36 characters

Responses

202

Sell request successful

application/json

Schema

Schema

Transactionobjectrequired

ID uuidrequired

PublicID string

Network Network (string)required

Payments network:

• Bitcoin
• Lightning
• Ethereum
• PolygonPos
• OffNetwork

Example: Bitcoin

Created date-timerequired

When was this transaction created

Example: 2024-04-16T08:00:55Z

Status TransactionStatus (string)required

Statuses for transactions.

Possible values: [Pending, Failed, Settled]

Example: Settled

Direction TransactionDirection (string)required

Whether the transactions was a credit (in) or a debit (out) in your account

Possible values: [In, Out]

Example: In

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

ExternalID ExternalID (string)

Unique identifier in user's system.

Possible values: non-empty and <= 36 characters

Amount PositiveDecimal (string)

Positive decimal number in string format

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

Example: 10.1

NetworkFee PositiveDecimal (string)

Positive decimal number in string format

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

Example: 10.1

CryptoCurrency CryptoCurrencyCode (string)required

Cryptocurrency code:

• BTC
• USDC

Example: BTC

FiatPayment

object

• For buy transactions, Transaction.Amount = (FiatPayment.Amount - FiatPayment.FeeAmount) / FiatPayment.Rate
• For sell transactions, Transaction.Amount = (FiatPayment.Amount + FiatPayment.FeeAmount) / FiatPayment.Rate

Amount 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

FeeAmount 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

Rate PositiveDecimal (string)

Positive decimal number in string format

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

Example: 10.1

FiatCurrency FiatCurrencyCode (string)required

Supported fiat ISO_4217 3 letter currency codes.

Example: USD

Orchestration

object

Orchestration details for the transaction.

RuleID stringrequired

Unique identifier for the rule that is matched for the transaction.

RuleExecutionID stringrequired

Unique identifier for the execution of the rules that is matched for the transaction.

Example (from schema)

{
  "Transaction": {
    "ID": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "PublicID": "string",
    "Network": "Bitcoin",
    "Created": "2024-04-16T08:00:55Z",
    "Status": "Settled",
    "Direction": "In",
    "CustomerID": "550e8400-e29b-41d4-a716-446655440000",
    "ExternalID": "string",
    "Amount": "10.1",
    "NetworkFee": "10.1",
    "CryptoCurrency": "BTC",
    "FiatPayment": {
      "Amount": "10.1",
      "FeeAmount": "10.1",
      "Rate": "10.1",
      "FiatCurrency": "USD"
    },
    "Orchestration": {
      "RuleID": "string",
      "RuleExecutionID": "string"
    }
  }
}

400

Bad request

application/json

Schema

Schema

Type ErrorType (string)
Type of error:
• InvalidMessage
• Unexpected
• ResourceNotFound
• Unauthorized
• Forbidden
• InsufficientBalance
Example: InvalidMessage
Instance string

A unique reference that identifies the specific occurrence of the problem

Action string

Action taking place which resulted in error.

Detail string

Details about the error.

Extensionsobject

Additional information about the error.

Request object

Details about invalid request properties.

Featuresobject

Details about the disabled feature flags

property name*

string[]

List of reasons

Array [

string

]

Example (from schema)

{
  "Type": "InvalidMessage",
  "Instance": "string",
  "Action": "string",
  "Detail": "string",
  "Extensions": {
    "Request": {},
    "Features": {}
  }
}

401

Client is not authorized to perform this action

application/json

Schema

Schema

Type ErrorType (string)
Type of error:
• InvalidMessage
• Unexpected
• ResourceNotFound
• Unauthorized
• Forbidden
• InsufficientBalance
Example: InvalidMessage
Instance string

A unique reference that identifies the specific occurrence of the problem

Action string

Action taking place which resulted in error.

Detail string

Details about the error.

Extensionsobject

Additional information about the error.

Request object

Details about invalid request properties.

Featuresobject

Details about the disabled feature flags

property name*

string[]

List of reasons

Array [

string

]

Example (from schema)

{
  "Type": "InvalidMessage",
  "Instance": "string",
  "Action": "string",
  "Detail": "string",
  "Extensions": {
    "Request": {},
    "Features": {}
  }
}

500

Internal server error

application/json

Schema

Schema

Type ErrorType (string)
Type of error:
• InvalidMessage
• Unexpected
• ResourceNotFound
• Unauthorized
• Forbidden
• InsufficientBalance
Example: InvalidMessage
Instance string

A unique reference that identifies the specific occurrence of the problem

Action string

Action taking place which resulted in error.

Detail string

Details about the error.

Extensionsobject

Additional information about the error.

Request object

Details about invalid request properties.

Featuresobject

Details about the disabled feature flags

property name*

string[]

List of reasons

Array [

string

]

Example (from schema)

{
  "Type": "InvalidMessage",
  "Instance": "string",
  "Action": "string",
  "Detail": "string",
  "Extensions": {
    "Request": {},
    "Features": {}
  }
}

Callbacks

POST Status Update

POST 
/

Send a callback to the specified URL when the payment status updates.

application/json

Body

required

EventType stringrequired
Type of the event being sent:
• Transaction
• FiatDeposit
EventVersion integerrequired
Version of the event
Example: 0
Occurred date-timerequired
Time the event occurred
Example: 2024-04-16T08:00:55Z
Dataobjectrequired
Data specific to the event.
oneOf
Transaction
ID uuidrequired
PublicID string
Network Network (string)required
Payments network:
• Bitcoin
• Lightning
• Ethereum
• PolygonPos
• OffNetwork
Example: Bitcoin
Created date-timerequired
When was this transaction created
Example: 2024-04-16T08:00:55Z
Status TransactionStatus (string)required
Statuses for transactions.
Possible values: [Pending, Failed, Settled]
Example: Settled
Direction TransactionDirection (string)required
Whether the transactions was a credit (in) or a debit (out) in your account
Possible values: [In, Out]
Example: In
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
ExternalID ExternalID (string)
Unique identifier in user's system.
Possible values: non-empty and <= 36 characters
Amount PositiveDecimal (string)
Positive decimal number in string format
Possible values: non-empty and <= 38 characters, Value must match regular expression ^[+]?([.]\d+|\d+[.]?\d*)$
Example: 10.1
NetworkFee PositiveDecimal (string)
Positive decimal number in string format
Possible values: non-empty and <= 38 characters, Value must match regular expression ^[+]?([.]\d+|\d+[.]?\d*)$
Example: 10.1
CryptoCurrency CryptoCurrencyCode (string)required
Cryptocurrency code:
• BTC
• USDC
Example: BTC
FiatPayment
object
• For buy transactions, `Transaction.Amount = (FiatPayment.Amount
• FiatPayment.FeeAmount) / FiatPayment.Rate* For sell transactions,Transaction.Amount = (FiatPayment.Amount + FiatPayment.FeeAmount) / FiatPayment.Rate`
Amount 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
FeeAmount 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
Rate PositiveDecimal (string)
Positive decimal number in string format
Possible values: non-empty and <= 38 characters, Value must match regular expression ^[+]?([.]\d+|\d+[.]?\d*)$
Example: 10.1
FiatCurrency FiatCurrencyCode (string)required
Supported fiat ISO_4217 3 letter currency codes.
Example: USD
Orchestration
object
Orchestration details for the transaction.
RuleID stringrequired
Unique identifier for the rule that is matched for the transaction.
RuleExecutionID stringrequired
Unique identifier for the execution of the rules that is matched for the transaction.
FiatDeposit
Details of a fiat deposit received by Noah.
ID stringrequired
Unique identifier of the fiat deposit.
Created date-timerequired
When was this fiat deposit created.
Example: 2024-04-16T08:00:55Z
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
FiatCurrency FiatCurrencyCode (string)required
Supported fiat ISO_4217 3 letter currency codes.
Example: USD
Reference string
Reference of the deposit.
Status FiatDepositStatus (string)required
Status of the deposit.
Possible values: [Pending, Failed, Settled, Reversed]
Example: Settled
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
PaymentMethodID FiatPaymentMethodID (string)required
Existing payment method id to be used.
Possible values: non-empty and <= 150 characters
PaymentMethodType PaymentMethodType (string)required
Specific type of payment method:
• BankSepa
• BankLocal
• BankFedwire
• TokenizedCard
• IdentifierPix
Example: BankLocal
Senderobjectrequired
Sender's fiat payment method.
FullName string
Details
objectrequired
oneOf
FiatPaymentMethodBankDisplay
Type stringrequired
Possible values: [FiatPaymentMethodBankDisplay]
AccountNumber stringrequired
FiatPaymentMethodCardDisplay
Type stringrequired
Possible values: [FiatPaymentMethodCardDisplay]
Last4 stringrequired
Scheme FiatPaymentCardScheme (string)required
The card scheme:
• Mastercard
• Visa
Example: Visa
FiatPaymentMethodIdentifierDisplay
Type stringrequired
Possible values: [FiatPaymentMethodIdentifierDisplay]
IdentifierType PaymentMethodIdentifierType (string)required
Identifier type:
• PhoneNumber
• Email
• TaxID
Example: PhoneNumber
Identifier stringrequired
UserID stringrequired

User ID of the event.

Callbacks Responses

200

Callback received successfully

Loading...