Notus API
Fiat

Create Fiat Withdrawal Quote

This endpoint creates a fiat withdrawal quote.

POST
/api/v1/fiat/withdraw/quote

Authorization

x-api-key<token>

In: header

Request Body

individualIdstring

An ID used for KYC and verification of ownership of the receiving fiat currency system. This value depends on the country and type of payment method.

chainIdnumber

Chain where the token will be sent from.

  • Polygon: 137
  • Arbitrum One: 42161
  • Base: 8453
  • Ethereum: 1
paymentMethodToReceiveDetailsobject

Choice for how to receive the fiat currency

amountToSendInCryptoCurrencystring
cryptoCurrencyToSendstring

Cryptocurrency to send.

Supported chains by cryptocurrency:

  • USDC: [1, 137, 8453, 42161]
  • BRZ: [137]
Value in"USDC" | "BRZ"
transactionFeePercent?number

Percentage fee to be charged (0 to 99%). The fee is deducted from the input token and sent to the treasuryAddress, if configured.

Range0 <= value <= 99.99

Response Body

curl -X POST "https://api.notus.team/api/v1/fiat/withdraw/quote" \  -H "Content-Type: application/json" \  -d '{    "individualId": "12345678901",    "chainId": 0,    "paymentMethodToReceiveDetails": {      "type": "PIX",      "pixKey": "[email protected]"    },    "amountToSendInCryptoCurrency": "string",    "cryptoCurrencyToSend": "USDC"  }'
{
  "withdrawQuote": {
    "quoteId": "123e4567-e89b-12d3-a456-426614174000",
    "cryptoCurrencyToSend": "USDC",
    "fiatCurrencyToReceive": "BRL",
    "amountToSendInCryptoCurrency": "100",
    "amountToReceiveInFiatCurrency": "100",
    "transactionFeeInCryptoCurrency": "10",
    "estimatedGasFeeInCryptoCurrency": "10",
    "expiresAt": "2021-01-01T00:00:00.000Z"
  }
}
{
  "statusCode": 400,
  "id": "CRYPTO_TOKEN_NOT_SUPPORTED_ON_CHAIN_WITH_ALTERNATIVES",
  "message": "The token 'undefined' is not supported on any fiat chains"
}
{
  "statusCode": 500,
  "id": "FAILED_TO_GET_FIAT_QUOTE",
  "message": "string"
}

Create Fiat Withdrawal Order POST

This endpoint creates a fiat withdrawal order for a given quote id.

Create an enhanced individual verification session POST

Creates a new KYC enhanced verification session for an individual. If the individual already exists (upgrade), only enhanced documents are required. If not (direct-to-enhanced), all documents are required.