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>",
  "trigger": {
    "Type": "SingleOnchainDepositSourceTriggerInput",
    "Conditions": [
      {
        "AmountConditions": [
          {
            "ComparisonOperator": "<string>",
            "Value": "<string>"
          }
        ],
        "Network": "<string>"
      }
    ],
    "SourceAddress": "<string>",
    "Expiry": "2023-11-07T05:31:56Z",
    "Nonce": "<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.

trigger
object

Response

Payout initiated successfully

data
object