Skip to main content
POST
/
clients
/
me
/
integrations
/
noah
/
payouts
/
quote
Quote payout
curl --request POST \
  --url https://api.portalhq.io/api/v3/clients/me/integrations/noah/payouts/quote \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "channelId": "<string>",
  "cryptoCurrency": "<string>",
  "fiatAmount": "<string>",
  "cryptoAmount": "<string>",
  "quoted": false,
  "fiatCurrency": "<string>",
  "form": {},
  "formSessionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "paymentMethodId": "<string>",
  "businessFee": {
    "FeeBase": "<string>",
    "FeePct": "<string>",
    "FiatCurrency": "<string>"
  }
}
'
{
  "data": {
    "payoutId": "<string>",
    "formSessionId": "<string>",
    "cryptoAmountEstimate": "<string>",
    "cryptoAuthorizedAmount": "<string>",
    "totalFee": "<string>",
    "cryptoCurrency": "<string>",
    "fiatCurrency": "<string>",
    "fiatAmount": "<string>",
    "rate": "<string>",
    "breakdown": [
      {
        "amount": "<string>"
      }
    ],
    "quote": {
      "signedQuote": "<string>",
      "expiry": "2023-11-07T05:31:56Z"
    },
    "nextStep": {}
  }
}

Authorizations

​
Authorization
string
header
required

Client API Key or Client Session Token (CST). Pass as a Bearer token in the Authorization header.

Body

application/json

Exactly one of fiatAmount or cryptoAmount must be provided. They are mutually exclusive — passing both (or neither) returns 400.

​
channelId
string
required
​
cryptoCurrency
string
required

Crypto currency symbol. In Noah sandbox, tickers must be suffixed with _TEST (e.g. USDC_TEST); use the unsuffixed ticker in production. See Noah's sandbox naming convention.

​
fiatAmount
string
required

Fiat amount to receive. Mutually exclusive with cryptoAmount.

​
cryptoAmount
string

Exact crypto amount the depositor will send. Mutually exclusive with fiatAmount.

​
quoted
boolean
default:false

When true and all form steps are complete, the response includes a quote whose signedQuote locks the conversion rate and recipient payout for the resulting payout transaction.

​
fiatCurrency
string
​
form
object
​
formSessionId
string<uuid>

Optional form session ID continuing a multi-step form.

​
paymentMethodId
string
​
businessFee
object

Per-transaction business fee configuration. When supplied, this fee is applied to the customer's transaction on behalf of the business.

Response

Payout quote created successfully

​
data
object