transaction_create_request

FintechPaymentsACHWiresTreasury

Properties

Name	Type	Description
amount	integer	Value in specified currency's smallest unit. e.g. $10 would be represented as 1000.
direction	string	Either `credit` or `debit`.
vendor_description	string	The transaction detail text that often appears in on your bank statement and in your banking portal.
vendor_code	string	When applicable, the bank-given code that determines the transaction's category. For most banks this is the BAI2/BTRS transaction code.
vendor_code_type	string	The type of `vendor_code` being reported. Can be one of `bai2`, `bankprov`, `bnk_dev`, `cleartouch`, `currencycloud`, `cross_river`, `dc_bank`, `dwolla`, `evolve`, `goldman_sachs`, `iso20022`, `jpmc`,
vendor_customer_id	string	An identifier given to this transaction by the bank, often `null`.
as_of_date	string	The date on which the transaction occurred.
internal_account_id	string	The ID of the relevant Internal Account.
metadata	object	Additional data represented as key-value pairs. Both the key and value must be strings.
posted	boolean	This field will be `true` if the transaction has posted to the account.
type	string	The type of the transaction. Examples could be `card, `ach`, `wire`, `check`, `rtp`, `book`, or `sen`.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/transaction_create_request",
  "title": "transaction_create_request",
  "type": "object",
  "properties": {
    "amount": {
      "type": "integer",
      "description": "Value in specified currency's smallest unit. e.g. $10 would be represented as 1000."
    },
    "direction": {
      "type": "string",
      "description": "Either `credit` or `debit`."
    },
    "vendor_description": {
      "type": "string",
      "nullable": true,
      "description": "The transaction detail text that often appears in on your bank statement and in your banking portal."
    },
    "vendor_code": {
      "type": "string",
      "description": "When applicable, the bank-given code that determines the transaction's category. For most banks this is the BAI2/BTRS transaction code.",
      "nullable": true
    },
    "vendor_code_type": {
      "type": "string",
      "description": "The type of `vendor_code` being reported. Can be one of `bai2`, `bankprov`, `bnk_dev`, `cleartouch`, `currencycloud`, `cross_river`, `dc_bank`, `dwolla`, `evolve`, `goldman_sachs`, `iso20022`, `jpmc`, `mx`, `signet`, `silvergate`, `swift`, `us_bank`, or others.",
      "nullable": true
    },
    "vendor_customer_id": {
      "type": "string",
      "description": "An identifier given to this transaction by the bank, often `null`.",
      "nullable": true
    },
    "as_of_date": {
      "type": "string",
      "nullable": true,
      "format": "date",
      "description": "The date on which the transaction occurred."
    },
    "internal_account_id": {
      "type": "string",
      "format": "uuid",
      "description": "The ID of the relevant Internal Account."
    },
    "metadata": {
      "type": "object",
      "description": "Additional data represented as key-value pairs. Both the key and value must be strings.",
      "additionalProperties": {
        "type": "string"
      },
      "example": {
        "key": "value",
        "foo": "bar",
        "modern": "treasury"
      }
    },
    "posted": {
      "type": "boolean",
      "description": "This field will be `true` if the transaction has posted to the account."
    },
    "type": {
      "type": "string",
      "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",
        "other"
      ],
      "description": "The type of the transaction. Examples could be `card, `ach`, `wire`, `check`, `rtp`, `book`, or `sen`.",
      "nullable": true
    }
  },
  "required": [
    "amount",
    "direction",
    "vendor_code",
    "vendor_code_type",
    "as_of_date",
    "internal_account_id"
  ]
}