Skip to main content

​
Account vs. Account Number

Account objects on Lead’s platform are a representation of bank accounts on Lead’s banking core; these platform account objects are each identified by an account_id. The account_id comes configured with a default account number object acting as a sub-object, identified by account_number_id. Additional account_numbers can be created with active entity_ids. Example Relationship Between an FBO and Operating Accounts Diagram showing the relationship between the FBO and operating accounts

​
Account Number Object

{
  "id": "account_number_123",
  "account_id": "account_xyz123",
  "entity_id": "entity_xyz123",
  "client_customer_id": "client_customer_abc123",
  "routing_number": "026073150",
  "account_number": "1234567890",
  "status": "active",
  "metadata": {},
  "ach_controls": {
    "originator_id": "originator_abc123",
    "incoming": {
      "accept_credit": true,
      "accept_debit": true,
      "counterparty_filter": "allowlist_only",
      "counterparty_company_ids_allowlist": [
        "1234567890"
      ]
    },
    "outgoing": {
      "counterparty_filter": "allowlist_only",
      "counterparty_account_numbers_allowlist": [
        {
          "type": "us_domestic",
          "account_number": "987654321",
          "routing_number": "026073150"
        }
      ]
    }
  },
  "wire_controls": {
    "incoming": {
      "counterparty_filter": "accept_all",
      "counterparty_account_numbers_allowlist": null
    },
    "outgoing": {
      "counterparty_filter": "allowlist_only",
      "counterparty_account_numbers_allowlist": [
        {
          "type": "us_domestic",
          "account_number": "987654321",
          "routing_number": "026073150"
        }
      ]
    }
  },
  "internal_transfer_controls": {
    "incoming": {
      "counterparty_filter": "allowlist_only",
      "counterparty_account_number_ids_allowlist": [
        "account_number_abc123"
      ]
    },
    "outgoing": {
      "counterparty_filter": "accept_all",
      "counterparty_account_number_ids_allowlist": null
    }
  },
  "created_at": "2025-08-14T20:26:47.960Z",
  "updated_at": "2025-08-14T20:26:47.960Z"
}

​
Attributes

AttributeTypeDescription
idstringUnique identifier for this Account Number object in Lead’s system.
account_idstringThe account_id this account number is associated with for settlement purposes.
entity_idstringThe associated entity_id in Lead’s system assigned for this account number. Used for API-based integrations.

Note: only one of client_customer_id OR entity_id should be set when setting an account number to active.
client_customer_idstringThe customer ID in the client’s system that matches the record in the Customer file. Used for file-based integrations.

Note: only one of client_customer_id OR entity_id should be set when setting an account number to active.
routing_numberstringThe routing number to provide to counterparties for ACH or Wire transfers.
account_numberstringNumeric value of the account number provided to counterparties for ACH and Wire transfers. If allocated by Lead, it will be a 12-digit value.
statusenumCurrent status of this account number. Possible values: unassigned: the account number was created without a valid customer assigned.

active: the account number is eligible for transfers.

inactive: the account number is temporarily ineligible for transfers.

canceled: the account number is closed and permanently ineligible for transfers.
metadataobjectA set of key-value pairs for storing additional information.

​
ACH Controls

AttributeTypeDescription
ach_controls.originator_idstringIdentifier of the ACH originator associated with this account number.
ach_controls.incoming.accept_creditbooleanIndicates whether this account number can receive ACH credits.
ach_controls.incoming.accept_debitbooleanIndicates whether this account number can receive ACH debits.
ach_controls.incoming.counterparty_filterenumSpecifies which counterparties are allowed to send ACH transfers to this account number.
Possible values:

accept_all: All counterparties are allowed.

allowlist_only : Only explicitly listed counterparties are allowed.

reject_all: All counterparties are blocked.
ach_controls.incoming.counterparty_company_ids_allowlistarrayList of Company IDs permitted to send incoming ACH transfers when counterparty_filter is allowlist_only.
ach_controls.outgoing.counterparty_filterenumSpecifies which counterparties this account number is allowed to send ACH transfers to.
Possible values:

accept_all: All counterparties are allowed.

allowlist_only: Only explicitly listed counterparties are allowed.

reject_all: All counterparties are blocked.
ach_controls.outgoing.counterparty_account_numbers_allowlistarray of objectsList of permitted outgoing ACH counterparties when counterparty_filter is allowlist_only.
Each entry includes:

type: Counterparty account type (e.g., us_domestic)

account_number: Counterparty account number

routing_number: Counterparty routing number

​
Wire Controls

AttributeTypeDescription
wire_controls.incoming.counterparty_filterenumSpecifies which counterparties are allowed to send wire transfers to this account number.
Possible values:

accept_all: All counterparties are allowed.

allowlist_only: Only explicitly listed counterparties are allowed.

reject_all: All counterparties are blocked.
wire_controls.incoming.counterparty_account_numbers_allowlistarray of objectsList of permitted incoming wire counterparties when counterparty_filter is allowlist_only.
Each entry includes:

type: Counterparty account type (e.g., us_domestic)

account_number: Counterparty account number

routing_number: Counterparty routing number
wire_controls.outgoing.counterparty_filterenumSpecifies which counterparties this account number is allowed to send wire transfers to.
Possible values:

accept_all: All counterparties are allowed.

allowlist_only: Only explicitly listed counterparties are allowed.

reject_all: All counterpartries are blocked.
wire_controls.outgoing.counterparty_account_numbers_allowlistarray of objectsList of permitted outgoing wire counterparties when counterparty_filter is allowlist_only.
Each entry includes:

type: Counterparty account type (e.g., us_domestic)

account_number: Counterparty account number routing_number: Counterparty routing number

​
Internal Transfer Controls

AttributeTypeDescription
internal_transfer_controls.incoming.counterparty_filterenumSpecifies which counterparties are allowed to send internal transfers to this account number.
Possible values:

accept_all: All counterparties are allowed.

allowlist_only: Only explicitly listed counterparties are allowed.

reject_all: All counterpartries are blocked.
internal_transfer_controls.incoming.counterparty_account_number_ids_allowlistarrayList of permitted sending account_number_id values when counterparty_filter is allowlist_only.
internal_transfer_controls.outgoing.counterparty_filterenumSpecifies which counterparties this account number is allowed to send internal transfers to.
Possible values:

accept_all: All counterparties are allowed.

allowlist_only: Only explicitly listed counterparties are allowed.

reject_all: All counterparties are blocked.
internal_transfer_controls.outgoing.counterparty_account_number_ids_allowlistarrayList of permitted receiving account_number_id values when counterparty_filter is allowlist_only.
created_atstringTimestamp the account number object was created, in ISO 8601 format.
updated_atstringTimestamp when the account number object was last updated, in ISO 8601 format.

​
Account Number Statuses & Lifecycle

Account Number Statuses And Lifecycle
StatusDescriptionNotes
unassignedAn Account Number is created but has not assigned with a valid customer through either entity_id or client_customer_id.Cannot send or receive any transfers.
activeAn Account Number is assigned or re-activated with a valid customer.Can receive and send (if enabled) transfers.
inactiveAn active Account Number being deactivated by client, or deactivated by Lead due to internal policies.Cannot receive or send any transfers.
canceledThis is a terminal status and can not be re-activated. Canceled Account Number will not be recycled for future usage.Cannot send or receive any transfers.