Modern Treasury · Schema

reconciliation_rule_variable

FintechPaymentsACHWiresTreasury

Properties

Name Type Description
amount_upper_bound integer The highest amount this expected payment may be equal to. Value in specified currency's smallest unit. e.g. $10 would be represented as 1000.
amount_lower_bound integer The lowest amount this expected payment may be equal to. Value in specified currency's smallest unit. e.g. $10 would be represented as 1000.
direction string One of credit or debit. When you are receiving money, use credit. When you are being charged, use debit.
internal_account_id string The ID of the Internal Account for the expected payment
type string One of ach, au_becs, bacs, book, check, eft, interac, provxchange, rtp, sen, sepa, signet wire
currency object Must conform to ISO 4217. Defaults to the currency of the internal account
date_upper_bound string The latest date the payment may come in. Format is yyyy-mm-dd
date_lower_bound string The earliest date the payment may come in. Format is yyyy-mm-dd
counterparty_id string The ID of the counterparty you expect for this payment
custom_identifiers object A hash of custom identifiers for this payment
View JSON Schema on GitHub

JSON Schema

modern-treasury-reconciliation-rule-variable-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/reconciliation_rule_variable",
  "title": "reconciliation_rule_variable",
  "type": "object",
  "properties": {
    "amount_upper_bound": {
      "type": "integer",
      "description": "The highest amount this expected payment may be equal to. Value in specified currency's smallest unit. e.g. $10 would be represented as 1000."
    },
    "amount_lower_bound": {
      "type": "integer",
      "description": "The lowest amount this expected payment may be equal to. Value in specified currency's smallest unit. e.g. $10 would be represented as 1000."
    },
    "direction": {
      "type": "string",
      "enum": [
        "credit",
        "debit"
      ],
      "description": "One of credit or debit. When you are receiving money, use credit. When you are being charged, use debit."
    },
    "internal_account_id": {
      "type": "string",
      "format": "uuid",
      "description": "The ID of the Internal Account for the expected payment"
    },
    "type": {
      "type": "string",
      "nullable": true,
      "enum": [
        "ach",
        "au_becs",
        "bacs",
        "book",
        "card",
        "chats",
        "check",
        "cross_border",
        "dk_nets",
        "eft",
        "gb_fps",
        "hu_ics",
        "interac",
        "masav",
        "mx_ccen",
        "neft",
        "nics",
        "nz_becs",
        "pl_elixir",
        "provxchange",
        "ro_sent",
        "rtp",
        "se_bankgirot",
        "sen",
        "sepa",
        "sg_giro",
        "sic",
        "signet",
        "sknbi",
        "stablecoin",
        "wire",
        "zengin"
      ],
      "description": "One of ach, au_becs, bacs, book, check, eft, interac, provxchange, rtp, sen, sepa, signet wire"
    },
    "currency": {
      "$ref": "#/components/schemas/currency",
      "description": "Must conform to ISO 4217. Defaults to the currency of the internal account"
    },
    "date_upper_bound": {
      "type": "string",
      "format": "date",
      "nullable": true,
      "description": "The latest date the payment may come in. Format is yyyy-mm-dd"
    },
    "date_lower_bound": {
      "type": "string",
      "format": "date",
      "nullable": true,
      "description": "The earliest date the payment may come in. Format is yyyy-mm-dd"
    },
    "counterparty_id": {
      "type": "string",
      "format": "uuid",
      "nullable": true,
      "description": "The ID of the counterparty you expect for this payment"
    },
    "custom_identifiers": {
      "type": "object",
      "description": "A hash of custom identifiers for this payment",
      "nullable": true,
      "additionalProperties": {
        "type": "string"
      }
    }
  },
  "additionalProperties": false,
  "minProperties": 10,
  "required": [
    "amount_upper_bound",
    "amount_lower_bound",
    "direction",
    "internal_account_id"
  ]
}