Notus API
Fiat

Create a fiat withdrawal quote

This endpoint creates a fiat withdrawal quote.

POST
/api/v1/fiat/withdraw/quote
x-api-key<token>

In: header

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. Supported EVM chains:

  • Arbitrum One: 42161
  • Avalanche: 43114
  • Base: 8453
  • BNB Smart Chain: 56
  • Ethereum: 1
  • Gnosis: 100
  • OP Mainnet: 10
  • Polygon: 137
paymentMethodToReceiveDetailsobject | object | object | object | object | object

Choice for how to receive the fiat currency

typestring

Type of method being used for withdrawing.

Value in"PIX"
pixKeystring

PIX key that will receive the fiat currency

typestring
Value in"ACH"
routingNumberstring
Length9 <= length <= 9
accountNumberstring
Length10 <= length <= 10
accountTypestring
Value in"CHECKING" | "SAVING"
beneficiaryNamestring
typestring
Value in"WIRE"
routingNumberstring
Length9 <= length <= 9
accountNumberstring
Length10 <= length <= 10
beneficiaryNamestring
addressLine1string
countrystring
Value in"AF" | "AL" | "DZ" | "AS" | "AD" | "AO" | "AI" | "AQ" | "AG" | "AR" | "AM" | "AW" | "AU" | "AT" | "AZ" | "BS" | "BH" | "BD" | "BB" | "BY" | "BE" | "BZ" | "BJ" | "BM" | "BT" | "BO" | "BQ" | "BA" | "BW" | "BV" | "BR" | "IO" | "BN" | "BG" | "BF" | "BI" | "CV" | "KH" | "CM" | "CA" | "KY" | "CF" | "TD" | "CL" | "CN" | "CX" | "CC" | "CO" | "KM" | "CD" | "CG" | "CK" | "CR" | "HR" | "CU" | "CW" | "CY" | "CZ" | "CI" | "DK" | "DJ" | "DM" | "DO" | "EC" | "EG" | "SV" | "GQ" | "ER" | "EE" | "SZ" | "ET" | "FK" | "FO" | "FJ" | "FI" | "FR" | "GF" | "PF" | "TF" | "GA" | "GM" | "GE" | "DE" | "GH" | "GI" | "GR" | "GL" | "GD" | "GP" | "GU" | "GT" | "GG" | "GN" | "GW" | "GY" | "HT" | "HM" | "VA" | "HN" | "HK" | "HU" | "IS" | "IN" | "ID" | "IR" | "IQ" | "IE" | "IM" | "IL" | "IT" | "JM" | "JP" | "JE" | "JO" | "KZ" | "KE" | "KI" | "KP" | "KR" | "KW" | "KG" | "LA" | "LV" | "LB" | "LS" | "LR" | "LY" | "LI" | "LT" | "LU" | "MO" | "MG" | "MW" | "MY" | "MV" | "ML" | "MT" | "MH" | "MQ" | "MR" | "MU" | "YT" | "MX" | "FM" | "MD" | "MC" | "MN" | "ME" | "MS" | "MA" | "MZ" | "MM" | "NA" | "NR" | "NP" | "NL" | "NC" | "NZ" | "NI" | "NE" | "NG" | "NU" | "NF" | "MP" | "NO" | "OM" | "PK" | "PW" | "PS" | "PA" | "PG" | "PY" | "PE" | "PH" | "PN" | "PL" | "PT" | "PR" | "QA" | "MK" | "RO" | "RU" | "RW" | "RE" | "BL" | "SH" | "KN" | "LC" | "MF" | "PM" | "VC" | "WS" | "SM" | "ST" | "SA" | "SN" | "RS" | "SC" | "SL" | "SG" | "SX" | "SK" | "SI" | "SB" | "SO" | "ZA" | "GS" | "SS" | "ES" | "LK" | "SD" | "SR" | "SJ" | "SE" | "CH" | "SY" | "TW" | "TJ" | "TZ" | "TH" | "TL" | "TG" | "TK" | "TO" | "TT" | "TN" | "TR" | "TM" | "TC" | "TV" | "UG" | "UA" | "AE" | "GB" | "UM" | "US" | "UY" | "UZ" | "VU" | "VE" | "VN" | "VG" | "VI" | "WF" | "EH" | "YE" | "ZM" | "ZW"
citystring
stateProvinceRegionstring
postalCodestring
typestring
Value in"SPEI"
clabestring
beneficiaryNamestring
protocolstring
Value in"CLABE" | "DEBIT_CARD" | "PHONE"
institutionCodestring
typestring
Value in"ACH_COP"
beneficiaryFirstNamestring
beneficiaryLastNamestring
documentIdstring
documentTypestring
Value in"CC" | "CE" | "NIT" | "PASS" | "PEP"
emailstring
bankCodestring
bankAccountstring
accountTypestring
Value in"CHECKING" | "SAVING"
typestring
Value in"TRANSFERS"
transfersTypestring
Value in"CVU" | "CBU" | "ALIAS"
beneficiaryNamestring
transfersAccountstring
amountToSendInCryptoCurrencystring
cryptoCurrencyToSendstring
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.

Rangevalue <= 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": 42161,
    "paymentMethodToReceiveDetails": {
      "type": "PIX",
      "pixKey": "[email protected]"
    },
    "amountToSendInCryptoCurrency": "string",
    "cryptoCurrencyToSend": "USDC"
  }'
const body = JSON.stringify({
  "individualId": "12345678901",
  "chainId": 42161,
  "paymentMethodToReceiveDetails": {
    "type": "PIX",
    "pixKey": "[email protected]"
  },
  "amountToSendInCryptoCurrency": "string",
  "cryptoCurrencyToSend": "USDC"
})

fetch("https://api.notus.team/api/v1/fiat/withdraw/quote", {
  body
})
package main

import (
  "fmt"
  "net/http"
  "io/ioutil"
  "strings"
)

func main() {
  url := "https://api.notus.team/api/v1/fiat/withdraw/quote"
  body := strings.NewReader(`{
    "individualId": "12345678901",
    "chainId": 42161,
    "paymentMethodToReceiveDetails": {
      "type": "PIX",
      "pixKey": "[email protected]"
    },
    "amountToSendInCryptoCurrency": "string",
    "cryptoCurrencyToSend": "USDC"
  }`)
  req, _ := http.NewRequest("POST", url, body)
  req.Header.Add("Content-Type", "application/json")
  res, _ := http.DefaultClient.Do(req)
  defer res.Body.Close()
  body, _ := ioutil.ReadAll(res.Body)

  fmt.Println(res)
  fmt.Println(string(body))
}
import requests

url = "https://api.notus.team/api/v1/fiat/withdraw/quote"
body = {
  "individualId": "12345678901",
  "chainId": 42161,
  "paymentMethodToReceiveDetails": {
    "type": "PIX",
    "pixKey": "[email protected]"
  },
  "amountToSendInCryptoCurrency": "string",
  "cryptoCurrencyToSend": "USDC"
}
response = requests.request("POST", url, json = body, headers = {
  "Content-Type": "application/json"
})

print(response.text)
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
import java.net.http.HttpResponse.BodyHandlers;
import java.time.Duration;
import java.net.http.HttpRequest.BodyPublishers;

var body = BodyPublishers.ofString("""{
  "individualId": "12345678901",
  "chainId": 42161,
  "paymentMethodToReceiveDetails": {
    "type": "PIX",
    "pixKey": "[email protected]"
  },
  "amountToSendInCryptoCurrency": "string",
  "cryptoCurrencyToSend": "USDC"
}""");
HttpClient client = HttpClient.newBuilder()
  .connectTimeout(Duration.ofSeconds(10))
  .build();

HttpRequest.Builder requestBuilder = HttpRequest.newBuilder()
  .uri(URI.create("https://api.notus.team/api/v1/fiat/withdraw/quote"))
  .header("Content-Type", "application/json")
  .POST(body)
  .build();

try {
  HttpResponse<String> response = client.send(requestBuilder.build(), BodyHandlers.ofString());
  System.out.println("Status code: " + response.statusCode());
  System.out.println("Response body: " + response.body());
} catch (Exception e) {
  e.printStackTrace();
}
using System;
using System.Net.Http;
using System.Text;

var body = new StringContent("""
{
  "individualId": "12345678901",
  "chainId": 42161,
  "paymentMethodToReceiveDetails": {
    "type": "PIX",
    "pixKey": "[email protected]"
  },
  "amountToSendInCryptoCurrency": "string",
  "cryptoCurrencyToSend": "USDC"
}
""", Encoding.UTF8, "application/json");

var client = new HttpClient();
var response = await client.PostAsync("https://api.notus.team/api/v1/fiat/withdraw/quote", body);
var responseBody = await response.Content.ReadAsStringAsync();
{
  "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": 500,
  "id": "FAILED_TO_GET_FIAT_QUOTE",
  "message": "string"
}