openapi: 3.0.1 info: title: Modern Treasury AccountCapability BulkRequest API version: v1 contact: name: Modern Treasury Engineering Team url: https://moderntreasury.com description: The Modern Treasury REST API. Please see https://docs.moderntreasury.com for more details. servers: - url: http://localhost:3000 - url: https://app.moderntreasury.com tags: - name: BulkRequest paths: /api/bulk_requests: get: summary: list bulk_requests tags: - BulkRequest operationId: listBulkRequests security: - basic_auth: [] parameters: - name: after_cursor in: query schema: type: string nullable: true required: false - name: per_page in: query required: false schema: type: integer - name: status in: query schema: type: string enum: - pending - processing - completed required: false description: One of pending, processing, or completed. - name: resource_type in: query schema: type: string enum: - payment_order - ledger_account - ledger_transaction - expected_payment - transaction - transaction_line_item - entity_link required: false description: One of payment_order, expected_payment, or ledger_transaction. - name: action_type in: query schema: type: string enum: - create - update - delete required: false description: One of create, or update. - $ref: '#/components/parameters/metadata_query' responses: '200': description: successful headers: X-After-Cursor: schema: type: string nullable: true required: false description: The cursor for the next page. Including this in a call as `after_cursor` will return the next page. X-Per-Page: schema: type: integer nullable: true description: The current `per_page`. content: application/json: schema: type: array items: $ref: '#/components/schemas/bulk_request' '401': description: unsuccessful content: application/json: schema: $ref: '#/components/schemas/error_message' '403': description: unsuccessful content: application/json: schema: $ref: '#/components/schemas/error_message' post: summary: create bulk_request tags: - BulkRequest operationId: createBulkRequest security: - basic_auth: [] parameters: - name: Idempotency-Key in: header required: false description: This key should be something unique, preferably something like an UUID. schema: type: string responses: '201': description: successful content: application/json: schema: $ref: '#/components/schemas/bulk_request' '401': description: unsuccessful content: application/json: schema: $ref: '#/components/schemas/error_message' '403': description: unsuccessful content: application/json: schema: $ref: '#/components/schemas/error_message' '422': description: unsuccessful content: application/json: schema: $ref: '#/components/schemas/error_message' requestBody: content: application/json: schema: $ref: '#/components/schemas/bulk_request_create_request' /api/bulk_requests/{id}: parameters: - name: id in: path description: id required: true schema: type: string get: summary: get bulk_request tags: - BulkRequest operationId: getBulkRequest security: - basic_auth: [] responses: '200': description: successful content: application/json: schema: $ref: '#/components/schemas/bulk_request' '401': description: unsuccessful content: application/json: schema: $ref: '#/components/schemas/error_message' '403': description: unsuccessful content: application/json: schema: $ref: '#/components/schemas/error_message' '404': description: not found content: application/json: schema: $ref: '#/components/schemas/error_message' components: schemas: payment_order_subtype: type: string enum: - 0C - 0N - 0S - CCD - CIE - CTX - IAT - PPD - TEL - WEB - au_becs - bacs - base - chats - dk_nets - eft - ethereum - hu_ics - masav - mx_ccen - neft - nics - nz_becs - pl_elixir - polygon - ro_sent - se_bankgirot - sepa - sg_giro - sic - sknbi - solana - zengin nullable: true description: An additional layer of classification for the type of payment order you are doing. This field is only used for `ach` payment orders currently. For `ach` payment orders, the `subtype` represents the SEC code. We currently support `CCD`, `PPD`, `IAT`, `CTX`, `WEB`, `CIE`, and `TEL`. x-stainless-renameMap: bacs_new_instruction: 0C bacs_cancellation_instruction: 0N bacs_conversion_instruction: 0S 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 external_account_type: type: string enum: - base_wallet - cash - checking - crypto_wallet - ethereum_wallet - general_ledger - loan - non_resident - other - overdraft - polygon_wallet - savings - solana_wallet description: Can be `checking`, `savings` or `other`. 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 ledger_transaction_update_request: type: object properties: description: type: string description: An optional description for internal use. nullable: true status: type: string enum: - archived - pending - posted description: To post a ledger transaction at creation, use `posted`. 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 effective_at: type: string format: date-time description: The timestamp (ISO8601 format) at which the ledger transaction happened for reporting purposes. ledger_entries: type: array items: $ref: '#/components/schemas/ledger_entry_create_request' description: An array of ledger entry objects. ledgerable_type: type: string enum: - expected_payment - incoming_payment_detail - payment_order - return - reversal description: If the ledger transaction can be reconciled to another object in Modern Treasury, the type will be populated here, otherwise null. This can be one of payment_order, incoming_payment_detail, expected_payment, return, or reversal. ledgerable_id: type: string format: uuid description: If the ledger transaction can be reconciled to another object in Modern Treasury, the id will be populated here, otherwise null. external_id: type: string description: A unique string to represent the ledger transaction. Only one pending or posted ledger transaction may have this ID in the ledger. nullable: true ledger_account_create_request: type: object properties: name: type: string description: The name of the ledger account. description: type: string description: The description of the ledger account. nullable: true normal_balance: type: string enum: - credit - debit description: The normal balance of the ledger account. _x-stainless-modelDefPath: $shared.transaction_direction ledger_id: type: string format: uuid description: The id of the ledger that this account belongs to. currency: type: string description: The currency of the ledger account. currency_exponent: type: integer description: The currency exponent of the ledger account. nullable: true ledger_account_category_ids: type: array items: type: string format: uuid description: The array of ledger account category ids that this ledger account should be a child of. ledgerable_id: type: string format: uuid description: If the ledger account links to another object in Modern Treasury, the id will be populated here, otherwise null. ledgerable_type: type: string enum: - counterparty - external_account - internal_account - virtual_account description: If the ledger account links to another object in Modern Treasury, the type will be populated here, otherwise null. The value is one of internal_account or external_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 external_id: type: string nullable: true description: An optional user-defined 180 character unique identifier. required: - name - normal_balance - ledger_id - currency currency: type: string enum: - AED - AFN - ALL - AMD - ANG - AOA - ARS - AUD - AWG - AZN - BAM - BBD - BCH - BDT - BGN - BHD - BIF - BMD - BND - BOB - BRL - BSD - BTC - BTN - BWP - BYN - BYR - BZD - CAD - CDF - CHF - CLF - CLP - CNH - CNY - COP - CRC - CUC - CUP - CVE - CZK - DJF - DKK - DOP - DZD - EEK - EGP - ERN - ETB - ETH - EUR - EURC - FJD - FKP - GBP - GBX - GEL - GGP - GHS - GIP - GMD - GNF - GTQ - GYD - HKD - HNL - HRK - HTG - HUF - IDR - ILS - IMP - INR - IQD - IRR - ISK - JEP - JMD - JOD - JPY - KES - KGS - KHR - KMF - KPW - KRW - KWD - KYD - KZT - LAK - LBP - LKR - LRD - LSL - LTL - LVL - LYD - MAD - MDL - MGA - MKD - MMK - MNT - MOP - MRO - MRU - MTL - MUR - MVR - MWK - MXN - MYR - MZN - NAD - NGN - NIO - NOK - NPR - NZD - OMR - OP - PAB - PEN - PGK - PHP - PKR - PLN - PYG - PYUSD - QAR - RON - RSD - RUB - RWF - SAR - SBD - SCR - SDG - SEK - SGD - SHP - SKK - SLE - SLL - SOS - SRD - SSP - STD - STN - SVC - SYP - SZL - THB - TJS - TMM - TMT - TND - TOP - TRY - TTD - TWD - TZS - UAH - UGX - USD - USDB - USDC - USDG - USDP - USDT - UYU - UZS - VEF - VES - VND - VUV - WST - XAF - XAG - XAU - XBA - XBB - XBC - XBD - XCD - XCG - XDR - XFU - XOF - XPD - XPF - XPT - XTS - YER - ZAR - ZMK - ZMW - ZWD - ZWG - ZWL - ZWN - ZWR description: Three-letter ISO currency code. error_message: type: object properties: errors: type: object properties: code: type: string enum: - parameter_invalid - parameter_missing - resource_not_found - not_found - forbidden - invalid_ip - invalid_key - header_invalid - expired_key - conflict - too_many_requests message: type: string parameter: type: string required: - errors address_request: type: object properties: line1: type: string nullable: true line2: type: string nullable: true locality: type: string nullable: true description: Locality or City. region: type: string nullable: true description: Region or State. postal_code: type: string description: The postal code of the address. nullable: true country: type: string description: Country code conforms to [ISO 3166-1 alpha-2] nullable: true expected_payment_create_request: type: object properties: external_id: type: string nullable: true description: An optional user-defined 180 character unique identifier. amount_upper_bound: type: integer nullable: true 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 nullable: true 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 nullable: true 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 nullable: true format: uuid description: The ID of the Internal Account for the expected payment. type: $ref: '#/components/schemas/expected_payment_type' currency: $ref: '#/components/schemas/currency' nullable: true 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: yyyy-mm-dd' date_lower_bound: type: string format: date nullable: true description: 'The earliest date the payment may come in. Format: yyyy-mm-dd' description: type: string nullable: true description: An optional description for internal use. statement_descriptor: type: string nullable: true description: The statement description you expect to see on the transaction. For ACH payments, this will be the full line item passed from the bank. For wire payments, this will be the OBI field on the wire. For check payments, this will be the memo field. 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 counterparty_id: type: string format: uuid description: The ID of the counterparty you expect for this payment. nullable: true remittance_information: type: string nullable: true description: For `ach`, this field will be passed through on an addenda record. For `wire` payments the field will be passed through as the "Originator to Beneficiary Information", also known as OBI or Fedwire tag 6000. reconciliation_groups: type: object nullable: true description: The reconciliation groups you have for this payment. reconciliation_filters: type: object nullable: true description: The reconciliation filters you have for this payment. reconciliation_rule_variables: type: array nullable: true items: $ref: '#/components/schemas/reconciliation_rule_variable' description: An array of reconciliation rule variables for this payment. amount_reconciled: type: integer nullable: true description: The amount reconciled for this expected payment. Value in specified currency's smallest unit. e.g. $10 would be represented as 1000. amount_reconciled_direction: type: string nullable: true enum: - credit - debit description: One of credit or debit. Indicates whether amount_reconciled is a credit or debit amount. amount_unreconciled: type: integer nullable: true description: The amount that remains unreconciled for this expected payment. Value in specified currency's smallest unit. e.g. $10 would be represented as 1000. amount_unreconciled_direction: type: string nullable: true enum: - credit - debit description: One of credit or debit. Indicates whether amount_unreconciled is a credit or debit amount. line_items: type: array items: $ref: '#/components/schemas/line_item_request' ledger_transaction: $ref: '#/components/schemas/ledger_transaction_create_request' description: Specifies a ledger transaction object that will be created with the expected payment. If the ledger transaction cannot be created, then the expected payment creation will fail. The resulting ledger transaction will mirror the status of the expected payment. ledger_transaction_id: type: string format: uuid description: Either ledger_transaction or ledger_transaction_id can be provided. Only a pending ledger transaction can be attached upon expected payment creation. Once the expected payment is created, the status of the ledger transaction tracks the expected payment automatically. payment_order_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 description: One of `ach`, `se_bankgirot`, `eft`, `wire`, `check`, `sen`, `book`, `rtp`, `sepa`, `bacs`, `au_becs`, `interac`, `neft`, `nics`, `nz_national_clearing_code`, `sic`, `signet`, `provexchange`, `zengin`. expected_payment_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 nullable: true description: 'One of: ach, au_becs, bacs, book, check, eft, interac, provxchange, rtp, sen, sepa, signet, wire.' payment_order_update_request: type: object properties: type: $ref: '#/components/schemas/payment_order_type' subtype: $ref: '#/components/schemas/payment_order_subtype' amount: type: integer description: Value in specified currency's smallest unit. e.g. $10 would be represented as 1000 (cents). For RTP, the maximum amount allowed by the network is $100,000. direction: type: string enum: - credit - debit description: One of `credit`, `debit`. Describes the direction money is flowing in the transaction. A `credit` moves money from your account to someone else's. A `debit` pulls money from someone else's account to your own. Note that wire, rtp, and check payments will always be `credit`. priority: type: string enum: - high - normal description: Either `normal` or `high`. For ACH and EFT payments, `high` represents a same-day ACH or EFT transfer, respectively. For check payments, `high` can mean an overnight check rather than standard mail. originating_account_id: type: string format: uuid description: The ID of one of your organization's internal accounts. receiving_account_id: type: string format: uuid description: Either `receiving_account` or `receiving_account_id` must be present. When using `receiving_account_id`, you may pass the id of an external account or an internal account. currency: $ref: '#/components/schemas/currency' description: Defaults to the currency of the originating account. accounting: $ref: '#/components/schemas/accounting' accounting_category_id: type: string format: uuid nullable: true description: The ID of one of your accounting categories. Note that these will only be accessible if your accounting system has been connected. deprecated: true accounting_ledger_class_id: type: string format: uuid nullable: true description: The ID of one of your accounting ledger classes. Note that these will only be accessible if your accounting system has been connected. deprecated: true effective_date: type: string format: date description: 'Date transactions are to be posted to the participants'' account. Defaults to the current business day or the next business day if the current day is a bank holiday or weekend. Format: yyyy-mm-dd.' description: type: string nullable: true description: An optional description for internal use. statement_descriptor: type: string nullable: true description: An optional descriptor which will appear in the receiver's statement. For `check` payments this field will be used as the memo line. For `ach` the maximum length is 10 characters. Note that for ACH payments, the name on your bank account will be included automatically by the bank, so you can use the characters for other useful information. For `eft` the maximum length is 15 characters. remittance_information: type: string nullable: true description: For `ach`, this field will be passed through on an addenda record. For `wire` payments the field will be passed through as the "Originator to Beneficiary Information", also known as OBI or Fedwire tag 6000. process_after: type: string format: date-time nullable: true description: If present, Modern Treasury will not process the payment until after this time. If `process_after` is past the cutoff for `effective_date`, `process_after` will take precedence and `effective_date` will automatically update to reflect the earliest possible sending date after `process_after`. Format is ISO8601 timestamp. purpose: type: string nullable: true description: For `wire`, this is usually the purpose which is transmitted via the "InstrForDbtrAgt" field in the ISO20022 file. For `eft`, this field is the 3 digit CPA Code that will be attached to the payment. metadata: type: object additionalProperties: type: string example: key: value foo: bar modern: treasury description: Additional data represented as key-value pairs. Both the key and value must be strings. charge_bearer: type: string enum: - shared - sender - receiver nullable: true description: The party that will pay the fees for the payment order. See https://docs.moderntreasury.com/payments/docs/charge-bearer to understand the differences between the options. foreign_exchange_indicator: type: string enum: - fixed_to_variable - variable_to_fixed nullable: true description: Indicates the type of FX transfer to initiate, can be either `variable_to_fixed`, `fixed_to_variable`, or `null` if the payment order currency matches the originating account currency. foreign_exchange_contract: type: string nullable: true description: If present, indicates a specific foreign exchange contract number that has been generated by your financial institution. nsf_protected: type: boolean description: A boolean to determine if NSF Protection is enabled for this payment order. Note that this setting must also be turned on in your organization settings page. originating_party_name: type: string nullable: true description: If present, this will replace your default company name on receiver's bank statement. This field can only be used for ACH payments currently. For ACH, only the first 16 characters of this string will be used. Any additional characters will be truncated. ultimate_originating_party_name: type: string nullable: true description: This represents the name of the person that the payment is on behalf of when using the CIE subtype for ACH payments. Only the first 15 characters of this string will be used. Any additional characters will be truncated. ultimate_originating_party_identifier: type: string nullable: true description: This represents the identifier by which the person is known to the receiver when using the CIE subtype for ACH payments. Only the first 22 characters of this string will be used. Any additional characters will be truncated. ultimate_receiving_party_name: type: string nullable: true description: This represents the identifier by which the merchant is known to the person initiating an ACH payment with CIE subtype. Only the first 15 characters of this string will be used. Any additional characters will be truncated. ultimate_receiving_party_identifier: type: string nullable: true description: This represents the name of the merchant that the payment is being sent to when using the CIE subtype for ACH payments. Only the first 22 characters of this string will be used. Any additional characters will be truncated. send_remittance_advice: type: boolean nullable: true description: Send an email to the counterparty when the payment order is sent to the bank. If `null`, `send_remittance_advice` on the Counterparty is used. expires_at: type: string format: date-time nullable: true description: RFP payments require an expires_at. This value must be past the effective_date. reconciliation_status: type: string enum: - unreconciled - tentatively_reconciled - reconciled description: One of `unreconciled`, `tentatively_reconciled` or `reconciled`. external_id: type: string description: An optional user-defined 180 character unique identifier. nullable: true status: type: string enum: - approved - cancelled - completed - denied - failed - held - needs_approval - pending - processing - returned - reversed - sent - stopped description: To cancel a payment order, use `cancelled`. To redraft a returned payment order, use `approved`. To undo approval on a denied or approved payment order, use `needs_approval`. counterparty_id: type: string format: uuid description: Required when receiving_account_id is passed the ID of an external account. nullable: true fallback_type: type: string enum: - ach description: A payment type to fallback to if the original type is not valid for the receiving account. Currently, this only supports falling back from RTP to ACH (type=rtp and fallback_type=ach) receiving_account: type: object properties: account_type: $ref: '#/components/schemas/external_account_type' party_type: type: string enum: - business - individual nullable: true description: Either `individual` or `business`. party_address: $ref: '#/components/schemas/address_request' description: Required if receiving wire payments. name: type: string nullable: true description: A nickname for the external account. This is only for internal usage and won't affect any payments account_details: type: array items: type: object properties: account_number: type: string account_number_type: type: string enum: - au_number - base_address - card_token - clabe - ethereum_address - hk_number - iban - id_number - nz_number - other - pan - polygon_address - sg_number - solana_address - wallet_address required: - account_number routing_details: type: array items: type: object properties: routing_number: type: string routing_number_type: type: string enum: - aba - au_bsb - br_codigo - ca_cpa - chips - cnaps - dk_interbank_clearing_code - gb_sort_code - hk_interbank_clearing_code - hu_interbank_clearing_code - id_sknbi_code - il_bank_code - in_ifsc - jp_zengin_code - my_branch_code - mx_bank_identifier - nz_national_clearing_code - pl_national_clearing_code - se_bankgiro_clearing_code - sg_interbank_clearing_code - swift - za_national_clearing_code payment_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 required: - routing_number - routing_number_type external_id: type: string nullable: true description: An optional user-defined 180 character unique identifier. metadata: type: object additionalProperties: type: string example: key: value foo: bar modern: treasury description: Additional data represented as key-value pairs. Both the key and value must be strings. party_name: type: string description: If this value isn't provided, it will be inherited from the counterparty's name. party_identifier: type: string ledger_account: $ref: '#/components/schemas/ledger_account_create_request' description: Specifies a ledger account object that will be created with the external account. The resulting ledger account is linked to the external account for auto-ledgering Payment objects. See https://docs.moderntreasury.com/docs/linking-to-other-modern-treasury-objects for more details. plaid_processor_token: type: string description: If you've enabled the Modern Treasury + Plaid integration in your Plaid account, you can pass the processor token in this field. contact_details: type: array items: $ref: '#/components/schemas/contact_detail_create_request' description: Either `receiving_account` or `receiving_account_id` must be present. When using `receiving_account_id`, you may pass the id of an external account or an internal account. line_items: type: array items: $ref: '#/components/schemas/line_item_request' description: An array of line items that must sum up to the amount of the payment order. accounting: type: object deprecated: true properties: account_id: type: string format: uuid nullable: true deprecated: true description: The ID of one of your accounting categories. Note that these will only be accessible if your accounting system has been connected. class_id: type: string format: uuid nullable: true deprecated: true description: The ID of one of the class objects in your accounting system. Class objects track segments of your business independent of client or project. Note that these will only be accessible if your accounting system has been connected. ledger_entry_create_request: type: object properties: amount: type: integer description: Value in specified currency's smallest unit. e.g. $10 would be represented as 1000. Can be any integer up to 36 digits. effective_at: type: string format: date-time description: The timestamp (ISO8601 format) at which the ledger transaction happened for reporting purposes. direction: type: string enum: - credit - debit description: One of `credit`, `debit`. Describes the direction money is flowing in the transaction. A `credit` moves money from your account to someone else's. A `debit` pulls money from someone else's account to your own. Note that wire, rtp, and check payments will always be `credit`. _x-stainless-modelDefPath: $shared.transaction_direction ledger_account_id: type: string format: uuid description: The ledger account that this ledger entry is associated with. lock_version: type: integer description: Lock version of the ledger account. This can be passed when creating a ledger transaction to only succeed if no ledger transactions have posted since the given version. See our post about Designing the Ledgers API with Optimistic Locking for more details. nullable: true pending_balance_amount: type: object additionalProperties: type: integer description: Use `gt` (>), `gte` (>=), `lt` (<), `lte` (<=), or `eq` (=) to lock on the account’s pending balance. If any of these conditions would be false after the transaction is created, the entire call will fail with error code 422. nullable: true posted_balance_amount: type: object additionalProperties: type: integer description: Use `gt` (>), `gte` (>=), `lt` (<), `lte` (<=), or `eq` (=) to lock on the account’s posted balance. If any of these conditions would be false after the transaction is created, the entire call will fail with error code 422. nullable: true available_balance_amount: type: object additionalProperties: type: integer description: Use `gt` (>), `gte` (>=), `lt` (<), `lte` (<=), or `eq` (=) to lock on the account’s available balance. If any of these conditions would be false after the transaction is created, the entire call will fail with error code 422. nullable: true show_resulting_ledger_account_balances: type: boolean description: If true, response will include the balance of the associated ledger account for the entry. nullable: true 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 required: - amount - direction - ledger_account_id ledger_transaction_create_request: type: object properties: description: type: string description: An optional description for internal use. nullable: true status: type: string enum: - archived - pending - posted description: To post a ledger transaction at creation, use `posted`. 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 effective_at: type: string format: date-time description: The timestamp (ISO8601 format) at which the ledger transaction happened for reporting purposes. effective_date: type: string format: date description: The date (YYYY-MM-DD) on which the ledger transaction happened for reporting purposes. ledger_entries: type: array items: $ref: '#/components/schemas/ledger_entry_create_request' description: An array of ledger entry objects. external_id: type: string description: A unique string to represent the ledger transaction. Only one pending or posted ledger transaction may have this ID in the ledger. ledgerable_type: type: string enum: - expected_payment - incoming_payment_detail - payment_order - return - reversal description: If the ledger transaction can be reconciled to another object in Modern Treasury, the type will be populated here, otherwise null. This can be one of payment_order, incoming_payment_detail, expected_payment, return, or reversal. ledgerable_id: type: string format: uuid description: If the ledger transaction can be reconciled to another object in Modern Treasury, the id will be populated here, otherwise null. required: - ledger_entries contact_detail_create_request: type: object properties: contact_identifier: type: string contact_identifier_type: type: string enum: - email - phone_number - website bulk_request: type: object properties: id: type: string format: uuid object: type: string live_mode: type: boolean description: This field will be true if this object exists in the live environment or false if it exists in the test environment. created_at: type: string format: date-time updated_at: type: string format: date-time action_type: type: string enum: - create - update - delete description: One of create, or update. resource_type: type: string enum: - payment_order - ledger_account - ledger_transaction - expected_payment - transaction - transaction_line_item - entity_link description: One of payment_order, expected_payment, or ledger_transaction. status: type: string enum: - pending - processing - completed description: One of pending, processing, or completed. total_resource_count: type: integer description: Total number of items in the `resources` array. Once a bulk request is completed, `success_result_count` + `failed_result_count` will be equal to `total_result_count`. success_result_count: type: integer description: Total number of successful bulk results so far for this request failed_result_count: type: integer description: Total number of failed bulk results so far for this request 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 additionalProperties: false minProperties: 12 required: - id - object - live_mode - created_at - updated_at - action_type - resource_type - status - total_resource_count - success_result_count - failed_result_count - metadata payment_order_async_create_request: type: object properties: type: $ref: '#/components/schemas/payment_order_type' subtype: $ref: '#/components/schemas/payment_order_subtype' amount: type: integer description: Value in specified currency's smallest unit. e.g. $10 would be represented as 1000 (cents). For RTP, the maximum amount allowed by the network is $100,000. direction: type: string enum: - credit - debit description: One of `credit`, `debit`. Describes the direction money is flowing in the transaction. A `credit` moves money from your account to someone else's. A `debit` pulls money from someone else's account to your own. Note that wire, rtp, and check payments will always be `credit`. priority: type: string enum: - high - normal description: Either `normal` or `high`. For ACH and EFT payments, `high` represents a same-day ACH or EFT transfer, respectively. For check payments, `high` can mean an overnight check rather than standard mail. originating_account_id: type: string format: uuid description: The ID of one of your organization's internal accounts. receiving_account_id: type: string format: uuid description: Either `receiving_account` or `receiving_account_id` must be present. When using `receiving_account_id`, you may pass the id of an external account or an internal account. currency: $ref: '#/components/schemas/currency' description: Defaults to the currency of the originating account. accounting: $ref: '#/components/schemas/accounting' accounting_category_id: type: string format: uuid nullable: true description: The ID of one of your accounting categories. Note that these will only be accessible if your accounting system has been connected. deprecated: true accounting_ledger_class_id: type: string format: uuid nullable: true description: The ID of one of your accounting ledger classes. Note that these will only be accessible if your accounting system has been connected. deprecated: true effective_date: type: string format: date description: 'Date transactions are to be posted to the participants'' account. Defaults to the current business day or the next business day if the current day is a bank holiday or weekend. Format: yyyy-mm-dd.' description: type: string nullable: true description: An optional description for internal use. statement_descriptor: type: string nullable: true description: An optional descriptor which will appear in the receiver's statement. For `check` payments this field will be used as the memo line. For `ach` the maximum length is 10 characters. Note that for ACH payments, the name on your bank account will be included automatically by the bank, so you can use the characters for other useful information. For `eft` the maximum length is 15 characters. remittance_information: type: string nullable: true description: For `ach`, this field will be passed through on an addenda record. For `wire` payments the field will be passed through as the "Originator to Beneficiary Information", also known as OBI or Fedwire tag 6000. process_after: type: string format: date-time nullable: true description: If present, Modern Treasury will not process the payment until after this time. If `process_after` is past the cutoff for `effective_date`, `process_after` will take precedence and `effective_date` will automatically update to reflect the earliest possible sending date after `process_after`. Format is ISO8601 timestamp. purpose: type: string nullable: true description: For `wire`, this is usually the purpose which is transmitted via the "InstrForDbtrAgt" field in the ISO20022 file. For `eft`, this field is the 3 digit CPA Code that will be attached to the payment. metadata: type: object additionalProperties: type: string example: key: value foo: bar modern: treasury description: Additional data represented as key-value pairs. Both the key and value must be strings. charge_bearer: type: string enum: - shared - sender - receiver nullable: true description: The party that will pay the fees for the payment order. See https://docs.moderntreasury.com/payments/docs/charge-bearer to understand the differences between the options. foreign_exchange_indicator: type: string enum: - fixed_to_variable - variable_to_fixed nullable: true description: Indicates the type of FX transfer to initiate, can be either `variable_to_fixed`, `fixed_to_variable`, or `null` if the payment order currency matches the originating account currency. foreign_exchange_contract: type: string nullable: true description: If present, indicates a specific foreign exchange contract number that has been generated by your financial institution. nsf_protected: type: boolean description: A boolean to determine if NSF Protection is enabled for this payment order. Note that this setting must also be turned on in your organization settings page. originating_party_name: type: string nullable: true description: If present, this will replace your default company name on receiver's bank statement. This field can only be used for ACH payments currently. For ACH, only the first 16 characters of this string will be used. Any additional characters will be truncated. ultimate_originating_party_name: type: string nullable: true description: Name of the ultimate originator of the payment order. ultimate_originating_party_identifier: type: string nullable: true description: Identifier of the ultimate originator of the payment order. ultimate_receiving_party_name: type: string nullable: true description: Name of the ultimate funds recipient. ultimate_receiving_party_identifier: type: string nullable: true description: Identifier of the ultimate funds recipient. send_remittance_advice: type: boolean nullable: true description: Send an email to the counterparty when the payment order is sent to the bank. If `null`, `send_remittance_advice` on the Counterparty is used. expires_at: type: string format: date-time nullable: true description: RFP payments require an expires_at. This value must be past the effective_date. reconciliation_status: type: string enum: - unreconciled - tentatively_reconciled - reconciled description: One of `unreconciled`, `tentatively_reconciled` or `reconciled`. external_id: type: string description: An optional user-defined 180 character unique identifier. nullable: true fallback_type: type: string enum: - ach description: A payment type to fallback to if the original type is not valid for the receiving account. Currently, this only supports falling back from RTP to ACH (type=rtp and fallback_type=ach) receiving_account: type: object properties: account_type: $ref: '#/components/schemas/external_account_type' party_type: type: string enum: - business - individual nullable: true description: Either `individual` or `business`. party_address: $ref: '#/components/schemas/address_request' description: Required if receiving wire payments. name: type: string nullable: true description: A nickname for the external account. This is only for internal usage and won't affect any payments account_details: type: array items: type: object properties: account_number: type: string account_number_type: type: string enum: - au_number - base_address - card_token - clabe - ethereum_address - hk_number - iban - id_number - nz_number - other - pan - polygon_address - sg_number - solana_address - wallet_address required: - account_number routing_details: type: array items: type: object properties: routing_number: type: string routing_number_type: type: string enum: - aba - au_bsb - br_codigo - ca_cpa - chips - cnaps - dk_interbank_clearing_code - gb_sort_code - hk_interbank_clearing_code - hu_interbank_clearing_code - id_sknbi_code - il_bank_code - in_ifsc - jp_zengin_code - my_branch_code - mx_bank_identifier - nz_national_clearing_code - pl_national_clearing_code - se_bankgiro_clearing_code - sg_interbank_clearing_code - swift - za_national_clearing_code payment_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 required: - routing_number - routing_number_type external_id: type: string nullable: true description: An optional user-defined 180 character unique identifier. metadata: type: object additionalProperties: type: string example: key: value foo: bar modern: treasury description: Additional data represented as key-value pairs. Both the key and value must be strings. party_name: type: string description: If this value isn't provided, it will be inherited from the counterparty's name. party_identifier: type: string ledger_account: $ref: '#/components/schemas/ledger_account_create_request' description: Specifies a ledger account object that will be created with the external account. The resulting ledger account is linked to the external account for auto-ledgering Payment objects. See https://docs.moderntreasury.com/docs/linking-to-other-modern-treasury-objects for more details. plaid_processor_token: type: string description: If you've enabled the Modern Treasury + Plaid integration in your Plaid account, you can pass the processor token in this field. contact_details: type: array items: $ref: '#/components/schemas/contact_detail_create_request' description: Either `receiving_account` or `receiving_account_id` must be present. When using `receiving_account_id`, you may pass the id of an external account or an internal account. ledger_transaction: $ref: '#/components/schemas/ledger_transaction_create_request' description: Specifies a ledger transaction object that will be created with the payment order. If the ledger transaction cannot be created, then the payment order creation will fail. The resulting ledger transaction will mirror the status of the payment order. ledger_transaction_id: type: string format: uuid description: Either ledger_transaction or ledger_transaction_id can be provided. Only a pending ledger transaction can be attached upon payment order creation. Once the payment order is created, the status of the ledger transaction tracks the payment order automatically. line_items: type: array items: $ref: '#/components/schemas/line_item_request' description: An array of line items that must sum up to the amount of the payment order. transaction_monitoring_enabled: type: boolean deprecated: true description: A flag that determines whether a payment order should go through transaction monitoring. ultimate_originating_account_id: type: string format: uuid description: The ultimate originating account ID. Can be a `virtual_account` or `internal_account`. ultimate_originating_party_address: type: object nullable: true description: Address of the ultimate originator of the payment order. properties: line1: type: string line2: type: string locality: type: string description: Locality or City. region: type: string description: Region or State. postal_code: type: string description: The postal code of the address. country: type: string description: Country code conforms to [ISO 3166-1 alpha-2] vendor_attributes: type: object description: Additional vendor specific fields for this payment. Data must be represented as key-value pairs. required: - type - amount - direction - originating_account_id transaction_update_request: type: object properties: metadata: type: object additionalProperties: type: string description: Additional data in the form of key-value pairs. Pairs can be removed by passing an empty string or `null` as the value. expected_payment_update_request: type: object properties: external_id: type: string nullable: true description: An optional user-defined 180 character unique identifier. amount_upper_bound: type: integer nullable: true 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 nullable: true 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 nullable: true 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 nullable: true format: uuid description: The ID of the Internal Account for the expected payment. type: $ref: '#/components/schemas/expected_payment_type' currency: $ref: '#/components/schemas/currency' nullable: true 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: yyyy-mm-dd' date_lower_bound: type: string format: date nullable: true description: 'The earliest date the payment may come in. Format: yyyy-mm-dd' description: type: string nullable: true description: An optional description for internal use. statement_descriptor: type: string nullable: true description: The statement description you expect to see on the transaction. For ACH payments, this will be the full line item passed from the bank. For wire payments, this will be the OBI field on the wire. For check payments, this will be the memo field. 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 counterparty_id: type: string format: uuid description: The ID of the counterparty you expect for this payment. nullable: true remittance_information: type: string nullable: true description: For `ach`, this field will be passed through on an addenda record. For `wire` payments the field will be passed through as the "Originator to Beneficiary Information", also known as OBI or Fedwire tag 6000. reconciliation_groups: type: object nullable: true description: The reconciliation groups you have for this payment. reconciliation_filters: type: object nullable: true description: The reconciliation filters you have for this payment. reconciliation_rule_variables: type: array nullable: true items: $ref: '#/components/schemas/reconciliation_rule_variable' description: An array of reconciliation rule variables for this payment. amount_reconciled: type: integer nullable: true description: The amount reconciled for this expected payment. Value in specified currency's smallest unit. e.g. $10 would be represented as 1000. amount_reconciled_direction: type: string nullable: true enum: - credit - debit description: One of credit or debit. Indicates whether amount_reconciled is a credit or debit amount. amount_unreconciled: type: integer nullable: true description: The amount that remains unreconciled for this expected payment. Value in specified currency's smallest unit. e.g. $10 would be represented as 1000. amount_unreconciled_direction: type: string nullable: true enum: - credit - debit description: One of credit or debit. Indicates whether amount_unreconciled is a credit or debit amount. status: type: string nullable: true enum: - reconciled description: The Expected Payment's status can be updated from partially_reconciled to reconciled. line_item_request: type: object properties: amount: type: integer description: Value in specified currency's smallest unit. e.g. $10 would be represented as 1000. 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 description: type: string description: A free-form description of the line item. nullable: true accounting_category_id: type: string description: The ID of one of your accounting categories. Note that these will only be accessible if your accounting system has been connected. nullable: true required: - amount bulk_request_create_request: type: object properties: action_type: type: string enum: - create - update - delete description: One of create, or update. resource_type: type: string enum: - payment_order - ledger_account - ledger_transaction - expected_payment - transaction - transaction_line_item - entity_link description: One of payment_order, expected_payment, or ledger_transaction. 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 resources: type: array description: An array of objects where each object contains the input params for a single `action_type` request on a `resource_type` resource items: anyOf: - $ref: '#/components/schemas/payment_order_async_create_request' - $ref: '#/components/schemas/expected_payment_create_request' - $ref: '#/components/schemas/ledger_transaction_create_request' - $ref: '#/components/schemas/ledger_account_create_request' - $ref: '#/components/schemas/transaction_create_request' - type: object properties: id: type: string format: uuid - allOf: - $ref: '#/components/schemas/payment_order_update_request' - type: object properties: id: type: string format: uuid x-stainless-variantName: payment_order_update_request_with_id - allOf: - $ref: '#/components/schemas/expected_payment_update_request' - type: object properties: id: type: string format: uuid x-stainless-variantName: expected_payment_update_request_with_id - allOf: - $ref: '#/components/schemas/transaction_update_request' - type: object properties: id: type: string format: uuid x-stainless-variantName: transaction_update_request_with_id - allOf: - $ref: '#/components/schemas/ledger_transaction_update_request' - type: object properties: id: type: string format: uuid x-stainless-variantName: ledger_transaction_update_request_with_id required: - action_type - resource_type - resources parameters: metadata_query: name: metadata in: query schema: type: object additionalProperties: type: string style: deepObject explode: true required: false description: For example, if you want to query for records with metadata key `Type` and value `Loan`, the query would be `metadata%5BType%5D=Loan`. This encodes the query parameters. securitySchemes: basic_auth: type: http scheme: basic