Get automation rule by ID

curl --request GET \
  --url https://api.fernhq.com/automation-rules/{ruleId} \
  --header 'Authorization: Bearer <token>'

{
  "id": "rule_ghi789",
  "name": "Sweep when over 5000 USDC",
  "customerId": "da1f853f-b083-40f3-b729-30c99826e4ed",
  "transactionTemplate": {
    "source": {
      "sourcePaymentAccountId": "072a8b7b-38c7-429a-a6cf-35dae7f2fb77",
      "sourcePaymentMethod": "ACH",
      "sourceCurrency": {
        "label": "USDC",
        "chain": "ETHEREUM",
        "contractAddress": "0x123456789abcd123456789abcd123456789abcd",
        "currencyDecimals": 18
      }
    },
    "destination": {
      "destinationPaymentAccountId": "072a8b7b-38c7-429a-a6cf-35dae7f2fb77",
      "destinationPaymentMethod": "ETHEREUM",
      "destinationCurrency": {
        "label": "USDC",
        "chain": "ETHEREUM",
        "contractAddress": "0x123456789abcd123456789abcd123456789abcd",
        "currencyDecimals": 18
      }
    },
    "amount": {
      "type": "FLAT",
      "value": "<string>"
    },
    "developerFee": {
      "developerFeeType": "USD",
      "developerFeeAmount": "5.45"
    }
  },
  "trigger": {
    "type": "THRESHOLD_BASED",
    "cronSchedule": "* * * * *",
    "thresholdAmount": "5000"
  },
  "createdAt": "2025-09-12T12:00:00Z"
}

GET

automation-rules

{ruleId}

Get automation rule by ID

curl --request GET \
  --url https://api.fernhq.com/automation-rules/{ruleId} \
  --header 'Authorization: Bearer <token>'

{
  "id": "rule_ghi789",
  "name": "Sweep when over 5000 USDC",
  "customerId": "da1f853f-b083-40f3-b729-30c99826e4ed",
  "transactionTemplate": {
    "source": {
      "sourcePaymentAccountId": "072a8b7b-38c7-429a-a6cf-35dae7f2fb77",
      "sourcePaymentMethod": "ACH",
      "sourceCurrency": {
        "label": "USDC",
        "chain": "ETHEREUM",
        "contractAddress": "0x123456789abcd123456789abcd123456789abcd",
        "currencyDecimals": 18
      }
    },
    "destination": {
      "destinationPaymentAccountId": "072a8b7b-38c7-429a-a6cf-35dae7f2fb77",
      "destinationPaymentMethod": "ETHEREUM",
      "destinationCurrency": {
        "label": "USDC",
        "chain": "ETHEREUM",
        "contractAddress": "0x123456789abcd123456789abcd123456789abcd",
        "currencyDecimals": 18
      }
    },
    "amount": {
      "type": "FLAT",
      "value": "<string>"
    },
    "developerFee": {
      "developerFeeType": "USD",
      "developerFeeAmount": "5.45"
    }
  },
  "trigger": {
    "type": "THRESHOLD_BASED",
    "cronSchedule": "* * * * *",
    "thresholdAmount": "5000"
  },
  "createdAt": "2025-09-12T12:00:00Z"
}

Authorizations

Authorization

string

header

required

To authenticate server-side requests

Path Parameters

ruleId

string

required

Response

200 - application/json

Response schema for retrieving an automation rule

Configuration for automated transaction execution

string

required

Unique identifier for the automation rule

Example:

"rule_ghi789"

name

string

required

Human-readable name for the automation rule

Example:

"Sweep when over 5000 USDC"

customerId

string<uuid>

required

ID of the customer who owns this automation rule

Example:

"da1f853f-b083-40f3-b729-30c99826e4ed"

transactionTemplate

Transaction Template Response Schema · object

required

Template configuration for transactions created by automation rule

Show child attributes

transactionTemplate.source

Automation Rule Transaction Source Response Schema · object

required

Source details for a transaction in an automation rule

Show child attributes

transactionTemplate.source.sourcePaymentAccountId

string<uuid>

required

The sending Payment Account Id.

Example:

"072a8b7b-38c7-429a-a6cf-35dae7f2fb77"

transactionTemplate.source.sourcePaymentMethod

required

The payment method for the source transaction

Available options:

ACH,

WIRE,

SEPA,

AE_UAEFTS,

AR_TRANSFERS_3,

AU_BECS,

BD_BEFTN,

BO_RTGS,

BR_TED_DOC_PIX,

CA_INTERAC,

CL_TEF,

CN_CNAPS,

CO_ACH,

CR_SINPE,

CZ_CERTIS,

DK_NEMKONTO_FI,

DO_ACH,

EC_LOCAL,

EG_RTGS_IPN,

GB_BACS_CHAPS_FPS,

GH_GHIPSS,

GT_ACH,

HK_HKICL_CHATS_ECG,

HU_GIRO,

ID_SKN_RTGS,

IL_ZAHAV,

IN_NEFT_RTGS_IMPS,

JM_LOCAL,

JO_ACH,

JP_ZENGIN,

KE_KIBBS_PESALINK,

KR_LOCAL,

LK_LOCAL,

MX_SPEI,

MY_IBG_RENTAS,

NG_NIBSS_NEFT,

NO_NICS,

NP_LOCAL,

NZ_LOCAL,

PE_CCE,

PH_INSTAPAY_PESONET,

PK_RAAST_IBFT,

PL_ELIXIR_BLUE_CASH,

QA_QPS,

RO_RTGS,

SA_MADA,

SE_BANKGIROT,

SG_FAST_MEPS,

SV_LOCAL,

SWIFT,

TH_BAHTNET_PROMPTPAY,

TR_FAST_EFT,

TZ_RTGS,

VN_IBPS,

ZA_RTGS_EFT,

ACH_SAME_DAY

Example:

"ACH"

transactionTemplate.source.sourceCurrency

Currency Schema · object

required

Schema representing either a fiat or crypto currency

Currency Schema
Currency Schema

Show child attributes

transactionTemplate.source.sourceCurrency.label

string

required

transactionTemplate.source.sourceCurrency.chain

enum<string>

The chain the crypto currency is on

Available options:

ARBITRUM,

BASE,

ETHEREUM,

OPTIMISM,

POLYGON,

SOLANA

transactionTemplate.source.sourceCurrency.contractAddress

string

transactionTemplate.source.sourceCurrency.currencyDecimals

number

Example:

{
  "label": "USDC",
  "chain": "ETHEREUM",
  "contractAddress": "0x123456789abcd123456789abcd123456789abcd",
  "currencyDecimals": 18
}

transactionTemplate.destination

Automation Rule Transaction Destination Response Schema · object

required

Destination details for a transaction in an automation rule

Show child attributes

transactionTemplate.destination.destinationPaymentAccountId

string<uuid>

required

The receiving Payment Account Id.

Example:

"072a8b7b-38c7-429a-a6cf-35dae7f2fb77"

transactionTemplate.destination.destinationPaymentMethod

required

The payment method for the destination transaction

Available options:

ACH,

WIRE,

SEPA,

AE_UAEFTS,

AR_TRANSFERS_3,

AU_BECS,

BD_BEFTN,

BO_RTGS,

BR_TED_DOC_PIX,

CA_INTERAC,

CL_TEF,

CN_CNAPS,

CO_ACH,

CR_SINPE,

CZ_CERTIS,

DK_NEMKONTO_FI,

DO_ACH,

EC_LOCAL,

EG_RTGS_IPN,

GB_BACS_CHAPS_FPS,

GH_GHIPSS,

GT_ACH,

HK_HKICL_CHATS_ECG,

HU_GIRO,

ID_SKN_RTGS,

IL_ZAHAV,

IN_NEFT_RTGS_IMPS,

JM_LOCAL,

JO_ACH,

JP_ZENGIN,

KE_KIBBS_PESALINK,

KR_LOCAL,

LK_LOCAL,

MX_SPEI,

MY_IBG_RENTAS,

NG_NIBSS_NEFT,

NO_NICS,

NP_LOCAL,

NZ_LOCAL,

PE_CCE,

PH_INSTAPAY_PESONET,

PK_RAAST_IBFT,

PL_ELIXIR_BLUE_CASH,

QA_QPS,

RO_RTGS,

SA_MADA,

SE_BANKGIROT,

SG_FAST_MEPS,

SV_LOCAL,

SWIFT,

TH_BAHTNET_PROMPTPAY,

TR_FAST_EFT,

TZ_RTGS,

VN_IBPS,

ZA_RTGS_EFT,

ACH_SAME_DAY

Example:

"ETHEREUM"

transactionTemplate.destination.destinationCurrency

Currency Schema · object

required

Schema representing either a fiat or crypto currency

Currency Schema
Currency Schema

Show child attributes

transactionTemplate.destination.destinationCurrency.label

string

required

transactionTemplate.destination.destinationCurrency.chain

enum<string>

The chain the crypto currency is on

Available options:

ARBITRUM,

BASE,

ETHEREUM,

OPTIMISM,

POLYGON,

SOLANA

transactionTemplate.destination.destinationCurrency.contractAddress

string

transactionTemplate.destination.destinationCurrency.currencyDecimals

number

Example:

{
  "label": "USDC",
  "chain": "ETHEREUM",
  "contractAddress": "0x123456789abcd123456789abcd123456789abcd",
  "currencyDecimals": 18
}

transactionTemplate.amount

Flat Amount Schema · object

required

Configuration for transaction amount (flat or percentage)

Flat Amount Schema
Percentage Amount Schema

Show child attributes

transactionTemplate.amount.type

enum<string>

required

Type of amount configuration

Available options:

FLAT,

PCT

transactionTemplate.amount.value

string

required

Fixed amount to transfer

transactionTemplate.developerFee

Developer Fees Schema · object

The fee amount you would like Fern to deduct from the transaction. For Builder tier, developer fee must be greater than or equal to the fernFee.

Show child attributes

transactionTemplate.developerFee.developerFeeType

enum<string>

required

The Developer Fee type

Available options:

USD,

SOURCE_CURRENCY

transactionTemplate.developerFee.developerFeeAmount

string

required

Amount of this fee that was applied

Example:

"5.45"

trigger

Trigger Schema · object

required

Trigger configuration for automation rules

Show child attributes

trigger.type

enum<string>

required

Available options:

THRESHOLD_BASED,

TIME_BASED

trigger.cronSchedule

string

Cron expression or time schedule that triggers the automation rule

Example:

"* * * * *"

trigger.thresholdAmount

string

Threshold value that triggers the automation rule

Example:

"5000"

createdAt

string

ISO timestamp when this automation rule was created

Example:

"2025-09-12T12:00:00Z"

Create automation rule Update automation rule

⌘I

Customers

Transactions

Quotes

Payment Accounts

Automation Rules

Webhooks

Get automation rule by ID

Authorizations

Path Parameters

Response