Skip to main content
POST
/
clients
/
me
/
integrations
/
noah
/
payins
Initiate payin
curl --request POST \
  --url https://api.portalhq.io/api/v3/clients/me/integrations/noah/payins \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "fiatCurrency": "<string>",
  "cryptoCurrency": "<string>",
  "network": "<string>",
  "destinationAddress": "<string>",
  "businessFees": {}
}
'
{
  "data": {
    "payinId": "<string>",
    "bankDetails": {
      "paymentMethodId": "<string>",
      "accountNumber": "<string>",
      "cryptoCurrency": "<string>",
      "network": "<string>",
      "fee": {
        "fiatCurrencyCode": "<string>",
        "totalFeePct": "<string>",
        "totalFeeBase": "<string>",
        "totalFeeMin": "<string>"
      },
      "accountHolderName": "<string>",
      "bankCode": "<string>",
      "bankName": "<string>",
      "bankAddress": {
        "street": "<string>",
        "city": "<string>",
        "postCode": "<string>",
        "state": "<string>",
        "country": "<string>",
        "street2": "<string>"
      },
      "reference": "<string>",
      "relatedPaymentMethods": [
        {
          "paymentMethodId": "<string>",
          "fee": {
            "fiatCurrencyCode": "<string>",
            "totalFeePct": "<string>",
            "totalFeeBase": "<string>",
            "totalFeeMin": "<string>"
          },
          "details": {
            "accountNumber": "<string>",
            "bankCode": "<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
​
fiatCurrency
string
required

Fiat currency code.

​
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.

​
network
string
required

CAIP-2 chain ID.

​
destinationAddress
string
required

Onchain destination address.

​
businessFees
object

Optional per-PaymentMethodType business fee overrides (e.g. BankAch, BankFedwire, BankSepa). Each entry defines the business fee applied to customer transactions using that payment method.

Response

Payin workflow created successfully

​
data
object