Skip to main content
POST
/
clients
/
me
/
integrations
/
noah
/
payouts
Initiate payout
curl --request POST \
  --url https://api.portalhq.io/api/v3/clients/me/integrations/noah/payouts \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "payoutId": "<string>",
  "sourceAddress": "<string>",
  "expiry": "2023-11-07T05:31:56Z",
  "nonce": "<string>",
  "network": "<string>",
  "fiatAmount": "<string>",
  "businessFee": {
    "FeeBase": "<string>",
    "FeePct": "<string>",
    "FiatCurrency": "<string>"
  }
}
'
{
  "data": {
    "destinationAddress": "<string>",
    "conditions": [
      {
        "amountConditions": [
          {
            "comparisonOperator": "<string>",
            "value": "<string>"
          }
        ],
        "cryptoCurrency": "<string>",
        "network": "<string>",
        "destinationAddress": "<string>"
      }
    ]
  }
}

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
​
payoutId
string
required
​
sourceAddress
string
required
​
expiry
string<date-time>
required
​
nonce
string
required

Unique idempotency nonce for the payout request. Must not be reused across different transactions.

Maximum string length: 36
​
network
string
required

CAIP-2 chain ID.

​
fiatAmount
string

Fiat amount for the payout. Only applicable when trigger.Type is SingleOnchainDepositSourceTriggerInput.

​
trigger
object

Defines when and how the automated sell rule fires. Three variants discriminated by Type (each with slightly different shape):

  • SingleOnchainDepositSourceTriggerInput — executes once. Conditions[*] must include AmountConditions. The persisted fiatAmount from the quote is forwarded.
  • PermanentOnchainDepositSourceTriggerInput — fires on every matching deposit; the entire deposited crypto amount is always sold. Conditions[*] carries Network only — AmountConditions must be omitted. Optional NetworkAgnostic flag matches any network.
  • QuotedOnchainDepositSourceTriggerInput — executes once and locks the conversion rate from a prior SellQuote. Requires SignedQuote (from quote.signedQuote on POST /payouts/quote). Conditions[*] carries Network only — AmountConditions must be omitted. Expiry is optional and defaults to the bound quote's expiry.
​
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 initiated successfully

​
data
object