modern-treasury 0.0.1

package/resources/payment-orders/payment-orders.ts

@@ -0,0 +1,2486 @@
+// File generated from our OpenAPI spec by Stainless.
+
+import * as Core from '~/core';
+import { APIResource } from '~/resource';
+import { isRequestOptions } from '~/core';
+import { Reversals } from './reversals';
+import { Page, PageParams } from '~/pagination';
+import * as Returns from '~/resources/returns';
+
+export class PaymentOrders extends APIResource {
+  reversals: Reversals = new Reversals(this.client);
+
+  /**
+   * Create a new Payment Order
+   */
+  create(
+    body: PaymentOrderCreateParams,
+    options?: Core.RequestOptions,
+  ): Promise<Core.APIResponse<PaymentOrder>> {
+    return this.post('/api/payment_orders', { body, ...options });
+  }
+
+  /**
+   * Get details on a single payment order
+   */
+  retrieve(id: string, options?: Core.RequestOptions): Promise<Core.APIResponse<PaymentOrder>> {
+    return this.get(`/api/payment_orders/${id}`, options);
+  }
+
+  /**
+   * Update a payment order
+   */
+  update(
+    id: string,
+    body?: PaymentOrderUpdateParams,
+    options?: Core.RequestOptions,
+  ): Promise<Core.APIResponse<PaymentOrder>>;
+  update(id: string, options?: Core.RequestOptions): Promise<Core.APIResponse<PaymentOrder>>;
+  update(
+    id: string,
+    body: PaymentOrderUpdateParams | Core.RequestOptions = {},
+    options?: Core.RequestOptions,
+  ): Promise<Core.APIResponse<PaymentOrder>> {
+    if (isRequestOptions(body)) {
+      return this.update(id, {}, body);
+    }
+
+    return this.patch(`/api/payment_orders/${id}`, { body, ...options });
+  }
+
+  /**
+   * Get a list of all payment orders
+   */
+  list(query?: PaymentOrderListParams, options?: Core.RequestOptions): Core.PagePromise<PaymentOrdersPage>;
+  list(options?: Core.RequestOptions): Core.PagePromise<PaymentOrdersPage>;
+  list(
+    query: PaymentOrderListParams | Core.RequestOptions = {},
+    options?: Core.RequestOptions,
+  ): Core.PagePromise<PaymentOrdersPage> {
+    if (isRequestOptions(query)) {
+      return this.list({}, query);
+    }
+
+    return this.getAPIList('/api/payment_orders', PaymentOrdersPage, { query, ...options });
+  }
+
+  /**
+   * Create a new payment order asynchronously
+   */
+  createAsync(body: PaymentOrderCreateAsyncParams, options?: Core.RequestOptions): Promise<void> {
+    return this.post('/api/payment_orders/create_async', {
+      body,
+      ...options,
+      headers: { Accept: '', ...options?.headers },
+    });
+  }
+}
+
+export class PaymentOrdersPage extends Page<PaymentOrder> {}
+
+export interface PaymentOrder {
+  /**
+   * The ID of one of your accounting categories. Note that these will only be
+   * accessible if your accounting system has been connected.
+   */
+  accounting_category_id?: string | null;
+
+  /**
+   * The ID of one of your accounting ledger classes. Note that these will only be
+   * accessible if your accounting system has been connected.
+   */
+  accounting_ledger_class_id?: string | null;
+
+  /**
+   * 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.
+   */
+  amount?: number;
+
+  /**
+   * The party that will pay the fees for the payment order. Only applies to wire
+   * payment orders. Can be one of shared, sender, or receiver, which correspond
+   * respectively with the SWIFT 71A values `SHA`, `OUR`, `BEN`.
+   */
+  charge_bearer?: 'shared' | 'sender' | 'receiver' | null;
+
+  /**
+   * If the payment order is tied to a specific Counterparty, their id will appear,
+   * otherwise `null`.
+   */
+  counterparty_id?: string | null;
+
+  created_at?: string;
+
+  /**
+   * Defaults to the currency of the originating account.
+   */
+  currency?:
+    | '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'
+    | 'EUR'
+    | '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'
+    | 'PAB'
+    | 'PEN'
+    | 'PGK'
+    | 'PHP'
+    | 'PKR'
+    | 'PLN'
+    | 'PYG'
+    | 'QAR'
+    | 'RON'
+    | 'RSD'
+    | 'RUB'
+    | 'RWF'
+    | 'SAR'
+    | 'SBD'
+    | 'SCR'
+    | 'SDG'
+    | 'SEK'
+    | 'SGD'
+    | 'SHP'
+    | 'SKK'
+    | 'SLL'
+    | 'SOS'
+    | 'SRD'
+    | 'SSP'
+    | 'STD'
+    | 'SVC'
+    | 'SYP'
+    | 'SZL'
+    | 'THB'
+    | 'TJS'
+    | 'TMM'
+    | 'TMT'
+    | 'TND'
+    | 'TOP'
+    | 'TRY'
+    | 'TTD'
+    | 'TWD'
+    | 'TZS'
+    | 'UAH'
+    | 'UGX'
+    | 'USD'
+    | 'UYU'
+    | 'UZS'
+    | 'VEF'
+    | 'VES'
+    | 'VND'
+    | 'VUV'
+    | 'WST'
+    | 'XAF'
+    | 'XAG'
+    | 'XAU'
+    | 'XBA'
+    | 'XBB'
+    | 'XBC'
+    | 'XBD'
+    | 'XCD'
+    | 'XDR'
+    | 'XFU'
+    | 'XOF'
+    | 'XPD'
+    | 'XPF'
+    | 'XPT'
+    | 'XTS'
+    | 'YER'
+    | 'ZAR'
+    | 'ZMK'
+    | 'ZMW'
+    | 'ZWD'
+    | 'ZWL'
+    | 'ZWN'
+    | 'ZWR';
+
+  /**
+   * If the payment order's status is `returned`, this will include the return
+   * object's data.
+   */
+  current_return?: Returns.ReturnObject | null;
+
+  /**
+   * The ID of the compliance decision for the payment order, if transaction
+   * monitoring is enabled.
+   */
+  decision_id?: string | null;
+
+  /**
+   * An optional description for internal use.
+   */
+  description?: string | null;
+
+  /**
+   * 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`.
+   */
+  direction?: 'credit' | 'debit';
+
+  /**
+   * 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.
+   */
+  effective_date?: string;
+
+  /**
+   * If present, indicates a specific foreign exchange contract number that has been
+   * generated by your financial institution.
+   */
+  foreign_exchange_contract?: string | null;
+
+  /**
+   * 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_indicator?: 'fixed_to_variable' | 'variable_to_fixed' | null;
+
+  id?: string;
+
+  /**
+   * The ID of the ledger transaction linked to the payment order.
+   */
+  ledger_transaction_id?: string | null;
+
+  /**
+   * This field will be true if this object exists in the live environment or false
+   * if it exists in the test environment.
+   */
+  live_mode?: boolean;
+
+  /**
+   * Additional data represented as key-value pairs. Both the key and value must be
+   * strings.
+   */
+  metadata?: Record<string, string>;
+
+  /**
+   * 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.
+   */
+  nsf_protected?: boolean;
+
+  object?: string;
+
+  /**
+   * The ID of one of your organization's internal accounts.
+   */
+  originating_account_id?: string;
+
+  /**
+   * 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.
+   */
+  originating_party_name?: string | null;
+
+  /**
+   * 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.
+   */
+  priority?: 'high' | 'normal';
+
+  /**
+   * For `wire`, this is usually the purpose which is transmitted via the
+   * "InstrForDbtrAgt" field in the ISO20022 file. If you are using Currencycloud,
+   * this is the `payment.purpose_code` field. For `eft`, this field is the 3 digit
+   * CPA Code that will be attached to the payment.
+   */
+  purpose?: string | null;
+
+  /**
+   * The receiving account ID. Can be an `external_account` or `internal_account`.
+   */
+  receiving_account_id?: string;
+
+  receiving_account_type?: 'internal_account' | 'external_account';
+
+  reference_numbers?: Array<PaymentOrder.ReferenceNumbers>;
+
+  /**
+   * 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.
+   */
+  remittance_information?: string | null;
+
+  /**
+   * 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.
+   */
+  send_remittance_advice?: boolean | null;
+
+  /**
+   * 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.
+   */
+  statement_descriptor?: string | null;
+
+  /**
+   * The current status of the payment order.
+   */
+  status?:
+    | 'approved'
+    | 'cancelled'
+    | 'completed'
+    | 'denied'
+    | 'failed'
+    | 'needs_approval'
+    | 'pending'
+    | 'processing'
+    | 'returned'
+    | 'reversed'
+    | 'sent';
+
+  /**
+   * 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`.
+   */
+  subtype?: 'CCD' | 'CIE' | 'CTX' | 'IAT' | 'PPD' | 'TEL' | 'WEB' | null;
+
+  /**
+   * The IDs of all the transactions associated to this payment order. Usually, you
+   * will only have a single transaction ID. However, if a payment order initially
+   * results in a Return, but gets redrafted and is later successfully completed, it
+   * can have many transactions.
+   */
+  transaction_ids?: Array<string>;
+
+  /**
+   * A flag that determines whether a payment order should go through transaction
+   * monitoring.
+   */
+  transaction_monitoring_enabled?: boolean;
+
+  /**
+   * One of `ach`, `eft`, `wire`, `check`, `sen`, `book`, `rtp`, `sepa`, `bacs`,
+   * `au_becs`, `interac`, `signet`, `provexchange`.
+   */
+  type?:
+    | 'ach'
+    | 'au_becs'
+    | 'bacs'
+    | 'book'
+    | 'card'
+    | 'check'
+    | 'eft'
+    | 'interac'
+    | 'provxchange'
+    | 'rtp'
+    | 'sen'
+    | 'sepa'
+    | 'signet'
+    | 'wire';
+
+  /**
+   * Identifier of the ultimate originator of the payment order.
+   */
+  ultimate_originating_party_identifier?: string | null;
+
+  /**
+   * Name of the ultimate originator of the payment order.
+   */
+  ultimate_originating_party_name?: string | null;
+
+  ultimate_receiving_party_identifier?: string | null;
+
+  ultimate_receiving_party_name?: string | null;
+
+  updated_at?: string;
+
+  /**
+   * This field will be populated if a vendor (e.g. Currencycloud) failure occurs.
+   * Logic shouldn't be built on its value as it is free-form.
+   */
+  vendor_failure_reason?: string | null;
+}
+
+export namespace PaymentOrder {
+  export interface ReferenceNumbers {
+    created_at?: string;
+
+    id?: string;
+
+    /**
+     * This field will be true if this object exists in the live environment or false
+     * if it exists in the test environment.
+     */
+    live_mode?: boolean;
+
+    object?: string;
+
+    /**
+     * The vendor reference number.
+     */
+    reference_number?: string;
+
+    /**
+     * The type of the reference number. Referring to the vendor payment id.
+     */
+    reference_number_type?:
+      | 'ach_original_trace_number'
+      | 'ach_trace_number'
+      | 'bankprov_payment_id'
+      | 'bnk_dev_prenotification_id'
+      | 'bnk_dev_transfer_id'
+      | 'bofa_end_to_end_id'
+      | 'bofa_transaction_id'
+      | 'check_number'
+      | 'cross_river_payment_id'
+      | 'cross_river_transaction_id'
+      | 'currencycloud_conversion_id'
+      | 'currencycloud_payment_id'
+      | 'dwolla_transaction_id'
+      | 'eft_trace_number'
+      | 'fedwire_imad'
+      | 'fedwire_omad'
+      | 'first_republic_internal_id'
+      | 'goldman_sachs_collection_request_id'
+      | 'goldman_sachs_end_to_end_id'
+      | 'goldman_sachs_payment_request_id'
+      | 'goldman_sachs_request_id'
+      | 'goldman_sachs_unique_payment_id'
+      | 'jpmc_ccn'
+      | 'jpmc_end_to_end_id'
+      | 'jpmc_firm_root_id'
+      | 'jpmc_p3_id'
+      | 'jpmc_payment_information_id'
+      | 'lob_check_id'
+      | 'other'
+      | 'partial_swift_mir'
+      | 'pnc_clearing_reference'
+      | 'pnc_instruction_id'
+      | 'pnc_multipayment_id'
+      | 'pnc_payment_trace_id'
+      | 'rtp_instruction_id'
+      | 'signet_api_reference_id'
+      | 'signet_confirmation_id'
+      | 'signet_request_id'
+      | 'silvergate_payment_id'
+      | 'swift_mir'
+      | 'swift_uetr'
+      | 'usbank_transaction_id'
+      | 'wells_fargo_payment_id'
+      | 'wells_fargo_trace_number';
+
+    updated_at?: string;
+  }
+}
+
+export interface PaymentOrderCreateParams {
+  /**
+   * 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.
+   */
+  amount: number;
+
+  /**
+   * 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`.
+   */
+  direction: 'credit' | 'debit';
+
+  /**
+   * The ID of one of your organization's internal accounts.
+   */
+  originating_account_id: string;
+
+  /**
+   * One of `ach`, `eft`, `wire`, `check`, `sen`, `book`, `rtp`, `sepa`, `bacs`,
+   * `au_becs`, `interac`, `signet`, `provexchange`.
+   */
+  type:
+    | 'ach'
+    | 'au_becs'
+    | 'bacs'
+    | 'book'
+    | 'card'
+    | 'check'
+    | 'eft'
+    | 'interac'
+    | 'provxchange'
+    | 'rtp'
+    | 'sen'
+    | 'sepa'
+    | 'signet'
+    | 'wire';
+
+  /**
+   * The ID of one of your accounting categories. Note that these will only be
+   * accessible if your accounting system has been connected.
+   */
+  accounting_category_id?: string | null;
+
+  /**
+   * The ID of one of your accounting ledger classes. Note that these will only be
+   * accessible if your accounting system has been connected.
+   */
+  accounting_ledger_class_id?: string | null;
+
+  /**
+   * The party that will pay the fees for the payment order. Only applies to wire
+   * payment orders. Can be one of shared, sender, or receiver, which correspond
+   * respectively with the SWIFT 71A values `SHA`, `OUR`, `BEN`.
+   */
+  charge_bearer?: 'shared' | 'sender' | 'receiver' | null;
+
+  /**
+   * Defaults to the currency of the originating account.
+   */
+  currency?:
+    | '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'
+    | 'EUR'
+    | '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'
+    | 'PAB'
+    | 'PEN'
+    | 'PGK'
+    | 'PHP'
+    | 'PKR'
+    | 'PLN'
+    | 'PYG'
+    | 'QAR'
+    | 'RON'
+    | 'RSD'
+    | 'RUB'
+    | 'RWF'
+    | 'SAR'
+    | 'SBD'
+    | 'SCR'
+    | 'SDG'
+    | 'SEK'
+    | 'SGD'
+    | 'SHP'
+    | 'SKK'
+    | 'SLL'
+    | 'SOS'
+    | 'SRD'
+    | 'SSP'
+    | 'STD'
+    | 'SVC'
+    | 'SYP'
+    | 'SZL'
+    | 'THB'
+    | 'TJS'
+    | 'TMM'
+    | 'TMT'
+    | 'TND'
+    | 'TOP'
+    | 'TRY'
+    | 'TTD'
+    | 'TWD'
+    | 'TZS'
+    | 'UAH'
+    | 'UGX'
+    | 'USD'
+    | 'UYU'
+    | 'UZS'
+    | 'VEF'
+    | 'VES'
+    | 'VND'
+    | 'VUV'
+    | 'WST'
+    | 'XAF'
+    | 'XAG'
+    | 'XAU'
+    | 'XBA'
+    | 'XBB'
+    | 'XBC'
+    | 'XBD'
+    | 'XCD'
+    | 'XDR'
+    | 'XFU'
+    | 'XOF'
+    | 'XPD'
+    | 'XPF'
+    | 'XPT'
+    | 'XTS'
+    | 'YER'
+    | 'ZAR'
+    | 'ZMK'
+    | 'ZMW'
+    | 'ZWD'
+    | 'ZWL'
+    | 'ZWN'
+    | 'ZWR';
+
+  /**
+   * An optional description for internal use.
+   */
+  description?: string | null;
+
+  /**
+   * An array of documents to be attached to the payment order. Note that if you
+   * attach documents, the request's content type must be `multipart/form-data`.
+   */
+  documents?: Array<PaymentOrderCreateParams.Documents>;
+
+  /**
+   * 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.
+   */
+  effective_date?: string;
+
+  /**
+   * 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)
+   */
+  fallback_type?: 'ach';
+
+  /**
+   * If present, indicates a specific foreign exchange contract number that has been
+   * generated by your financial institution.
+   */
+  foreign_exchange_contract?: string | null;
+
+  /**
+   * 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_indicator?: 'fixed_to_variable' | 'variable_to_fixed' | null;
+
+  /**
+   * 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?: PaymentOrderCreateParams.LedgerTransaction;
+
+  /**
+   * An array of line items that must sum up to the amount of the payment order.
+   */
+  line_items?: Array<PaymentOrderCreateParams.LineItems>;
+
+  /**
+   * Additional data represented as key-value pairs. Both the key and value must be
+   * strings.
+   */
+  metadata?: Record<string, string>;
+
+  /**
+   * 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.
+   */
+  nsf_protected?: boolean;
+
+  /**
+   * 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.
+   */
+  originating_party_name?: string | null;
+
+  /**
+   * 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.
+   */
+  priority?: 'high' | 'normal';
+
+  /**
+   * For `wire`, this is usually the purpose which is transmitted via the
+   * "InstrForDbtrAgt" field in the ISO20022 file. If you are using Currencycloud,
+   * this is the `payment.purpose_code` field. For `eft`, this field is the 3 digit
+   * CPA Code that will be attached to the payment.
+   */
+  purpose?: string | null;
+
+  /**
+   * 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.
+   */
+  receiving_account?: PaymentOrderCreateParams.ReceivingAccount;
+
+  /**
+   * 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.
+   */
+  receiving_account_id?: string;
+
+  /**
+   * 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.
+   */
+  remittance_information?: string | null;
+
+  /**
+   * 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.
+   */
+  send_remittance_advice?: boolean | null;
+
+  /**
+   * 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.
+   */
+  statement_descriptor?: string | null;
+
+  /**
+   * 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`.
+   */
+  subtype?: 'CCD' | 'CIE' | 'CTX' | 'IAT' | 'PPD' | 'TEL' | 'WEB' | null;
+
+  /**
+   * A flag that determines whether a payment order should go through transaction
+   * monitoring.
+   */
+  transaction_monitoring_enabled?: boolean;
+
+  /**
+   * Identifier of the ultimate originator of the payment order.
+   */
+  ultimate_originating_party_identifier?: string | null;
+
+  /**
+   * Name of the ultimate originator of the payment order.
+   */
+  ultimate_originating_party_name?: string | null;
+
+  /**
+   * Identifier of the ultimate funds recipient.
+   */
+  ultimate_receiving_party_identifier?: string | null;
+
+  /**
+   * Name of the ultimate funds recipient.
+   */
+  ultimate_receiving_party_name?: string | null;
+}
+
+export namespace PaymentOrderCreateParams {
+  export interface ReceivingAccount {
+    account_details?: Array<ReceivingAccount.AccountDetails>;
+
+    /**
+     * Can be `checking`, `savings` or `other`.
+     */
+    account_type?: 'checking' | 'other' | 'savings';
+
+    contact_details?: Array<ReceivingAccount.ContactDetails>;
+
+    /**
+     * Additional data represented as key-value pairs. Both the key and value must be
+     * strings.
+     */
+    metadata?: Record<string, string>;
+
+    /**
+     * A nickname for the external account. This is only for internal usage and won't
+     * affect any payments
+     */
+    name?: string | null;
+
+    /**
+     * Required if receiving wire payments.
+     */
+    party_address?: ReceivingAccount.PartyAddress;
+
+    party_identifier?: string;
+
+    /**
+     * If this value isn't provided, it will be inherited from the counterparty's name.
+     */
+    party_name?: string;
+
+    /**
+     * Either `individual` or `business`.
+     */
+    party_type?: 'business' | 'individual' | null;
+
+    /**
+     * If you've enabled the Modern Treasury + Plaid integration in your Plaid account,
+     * you can pass the processor token in this field.
+     */
+    plaid_processor_token?: string;
+
+    routing_details?: Array<ReceivingAccount.RoutingDetails>;
+  }
+
+  export namespace ReceivingAccount {
+    export interface PartyAddress {
+      /**
+       * Country code conforms to [ISO 3166-1 alpha-2]
+       */
+      country?: string | null;
+
+      line1?: string | null;
+
+      line2?: string | null;
+
+      /**
+       * Locality or City.
+       */
+      locality?: string | null;
+
+      /**
+       * The postal code of the address.
+       */
+      postal_code?: string | null;
+
+      /**
+       * Region or State.
+       */
+      region?: string | null;
+    }
+
+    export interface AccountDetails {
+      account_number: string;
+
+      account_number_type?: 'iban' | 'clabe' | 'wallet_address' | 'pan' | 'other';
+    }
+
+    export interface RoutingDetails {
+      routing_number: string;
+
+      routing_number_type:
+        | 'aba'
+        | 'swift'
+        | 'au_bsb'
+        | 'ca_cpa'
+        | 'cnaps'
+        | 'gb_sort_code'
+        | 'in_ifsc'
+        | 'my_branch_code'
+        | 'br_codigo';
+
+      payment_type?:
+        | 'ach'
+        | 'au_becs'
+        | 'bacs'
+        | 'book'
+        | 'card'
+        | 'check'
+        | 'eft'
+        | 'interac'
+        | 'provxchange'
+        | 'rtp'
+        | 'sen'
+        | 'sepa'
+        | 'signet'
+        | 'wire';
+    }
+
+    export interface ContactDetails {
+      contact_identifier?: string;
+
+      contact_identifier_type?: 'email' | 'phone_number';
+    }
+  }
+
+  export interface LedgerTransaction {
+    /**
+     * Format: yyyy-mm-dd.
+     */
+    effective_date: string;
+
+    /**
+     * Must be unique within the ledger.
+     */
+    external_id: string;
+
+    ledger_entries: Array<LedgerTransaction.LedgerEntries>;
+
+    description?: string;
+
+    ledgerable_id?: string;
+
+    ledgerable_type?:
+      | 'counterparty'
+      | 'expected_payment'
+      | 'incoming_payment_detail'
+      | 'internal_account'
+      | 'line_item'
+      | 'paper_item'
+      | 'payment_order'
+      | 'payment_order_attempt'
+      | 'return'
+      | 'reversal';
+
+    /**
+     * Additional data represented as key-value pairs. Both the key and value must be
+     * strings.
+     */
+    metadata?: Record<string, string>;
+
+    /**
+     * To post a ledger transaction at creation, use `posted`.
+     */
+    status?: 'archived' | 'pending' | 'posted';
+  }
+
+  export namespace LedgerTransaction {
+    export interface LedgerEntries {
+      amount?: number;
+
+      /**
+       * 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`.
+       */
+      direction?: 'credit' | 'debit';
+
+      ledger_account_id?: string;
+
+      /**
+       * 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.
+       */
+      lock_version?: number;
+    }
+  }
+
+  export interface LineItems {
+    /**
+     * Value in specified currency's smallest unit. e.g. $10 would be represented
+     * as 1000.
+     */
+    amount: number;
+
+    /**
+     * The ID of one of your accounting categories. Note that these will only be
+     * accessible if your accounting system has been connected.
+     */
+    accounting_category_id?: string | null;
+
+    /**
+     * A free-form description of the line item.
+     */
+    description?: string | null;
+
+    /**
+     * Additional data represented as key-value pairs. Both the key and value must be
+     * strings.
+     */
+    metadata?: Record<string, string>;
+  }
+
+  export interface Documents {
+    file: string;
+
+    /**
+     * A category given to the document, can be `null`.
+     */
+    document_type?: string;
+  }
+}
+
+export interface PaymentOrderUpdateParams {
+  /**
+   * The ID of one of your accounting categories. Note that these will only be
+   * accessible if your accounting system has been connected.
+   */
+  accounting_category_id?: string | null;
+
+  /**
+   * The ID of one of your accounting ledger classes. Note that these will only be
+   * accessible if your accounting system has been connected.
+   */
+  accounting_ledger_class_id?: string | null;
+
+  /**
+   * 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.
+   */
+  amount?: number;
+
+  /**
+   * The party that will pay the fees for the payment order. Only applies to wire
+   * payment orders. Can be one of shared, sender, or receiver, which correspond
+   * respectively with the SWIFT 71A values `SHA`, `OUR`, `BEN`.
+   */
+  charge_bearer?: 'shared' | 'sender' | 'receiver' | null;
+
+  /**
+   * Required when receiving_account_id is passed the ID of an external account.
+   */
+  counterparty_id?: string | null;
+
+  /**
+   * Defaults to the currency of the originating account.
+   */
+  currency?:
+    | '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'
+    | 'EUR'
+    | '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'
+    | 'PAB'
+    | 'PEN'
+    | 'PGK'
+    | 'PHP'
+    | 'PKR'
+    | 'PLN'
+    | 'PYG'
+    | 'QAR'
+    | 'RON'
+    | 'RSD'
+    | 'RUB'
+    | 'RWF'
+    | 'SAR'
+    | 'SBD'
+    | 'SCR'
+    | 'SDG'
+    | 'SEK'
+    | 'SGD'
+    | 'SHP'
+    | 'SKK'
+    | 'SLL'
+    | 'SOS'
+    | 'SRD'
+    | 'SSP'
+    | 'STD'
+    | 'SVC'
+    | 'SYP'
+    | 'SZL'
+    | 'THB'
+    | 'TJS'
+    | 'TMM'
+    | 'TMT'
+    | 'TND'
+    | 'TOP'
+    | 'TRY'
+    | 'TTD'
+    | 'TWD'
+    | 'TZS'
+    | 'UAH'
+    | 'UGX'
+    | 'USD'
+    | 'UYU'
+    | 'UZS'
+    | 'VEF'
+    | 'VES'
+    | 'VND'
+    | 'VUV'
+    | 'WST'
+    | 'XAF'
+    | 'XAG'
+    | 'XAU'
+    | 'XBA'
+    | 'XBB'
+    | 'XBC'
+    | 'XBD'
+    | 'XCD'
+    | 'XDR'
+    | 'XFU'
+    | 'XOF'
+    | 'XPD'
+    | 'XPF'
+    | 'XPT'
+    | 'XTS'
+    | 'YER'
+    | 'ZAR'
+    | 'ZMK'
+    | 'ZMW'
+    | 'ZWD'
+    | 'ZWL'
+    | 'ZWN'
+    | 'ZWR';
+
+  /**
+   * An optional description for internal use.
+   */
+  description?: string | null;
+
+  /**
+   * 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`.
+   */
+  direction?: 'credit' | 'debit';
+
+  /**
+   * 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.
+   */
+  effective_date?: string;
+
+  /**
+   * 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)
+   */
+  fallback_type?: 'ach';
+
+  /**
+   * If present, indicates a specific foreign exchange contract number that has been
+   * generated by your financial institution.
+   */
+  foreign_exchange_contract?: string | null;
+
+  /**
+   * 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_indicator?: 'fixed_to_variable' | 'variable_to_fixed' | null;
+
+  /**
+   * An array of line items that must sum up to the amount of the payment order.
+   */
+  line_items?: Array<PaymentOrderUpdateParams.LineItems>;
+
+  /**
+   * Additional data represented as key-value pairs. Both the key and value must be
+   * strings.
+   */
+  metadata?: Record<string, string>;
+
+  /**
+   * 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.
+   */
+  nsf_protected?: boolean;
+
+  /**
+   * The ID of one of your organization's internal accounts.
+   */
+  originating_account_id?: string;
+
+  /**
+   * 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.
+   */
+  originating_party_name?: string | null;
+
+  /**
+   * 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.
+   */
+  priority?: 'high' | 'normal';
+
+  /**
+   * For `wire`, this is usually the purpose which is transmitted via the
+   * "InstrForDbtrAgt" field in the ISO20022 file. If you are using Currencycloud,
+   * this is the `payment.purpose_code` field. For `eft`, this field is the 3 digit
+   * CPA Code that will be attached to the payment.
+   */
+  purpose?: string | null;
+
+  /**
+   * 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.
+   */
+  receiving_account?: PaymentOrderUpdateParams.ReceivingAccount;
+
+  /**
+   * 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.
+   */
+  receiving_account_id?: string;
+
+  /**
+   * 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.
+   */
+  remittance_information?: string | null;
+
+  /**
+   * 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.
+   */
+  send_remittance_advice?: boolean | null;
+
+  /**
+   * 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.
+   */
+  statement_descriptor?: string | null;
+
+  /**
+   * 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`.
+   */
+  status?:
+    | 'approved'
+    | 'cancelled'
+    | 'completed'
+    | 'denied'
+    | 'failed'
+    | 'needs_approval'
+    | 'pending'
+    | 'processing'
+    | 'returned'
+    | 'reversed'
+    | 'sent';
+
+  /**
+   * 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`.
+   */
+  subtype?: 'CCD' | 'CIE' | 'CTX' | 'IAT' | 'PPD' | 'TEL' | 'WEB' | null;
+
+  /**
+   * One of `ach`, `eft`, `wire`, `check`, `sen`, `book`, `rtp`, `sepa`, `bacs`,
+   * `au_becs`, `interac`, `signet`, `provexchange`.
+   */
+  type?:
+    | 'ach'
+    | 'au_becs'
+    | 'bacs'
+    | 'book'
+    | 'card'
+    | 'check'
+    | 'eft'
+    | 'interac'
+    | 'provxchange'
+    | 'rtp'
+    | 'sen'
+    | 'sepa'
+    | 'signet'
+    | 'wire';
+
+  /**
+   * 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_originating_party_identifier?: string | null;
+
+  /**
+   * 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_name?: string | null;
+
+  /**
+   * 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.
+   */
+  ultimate_receiving_party_identifier?: string | null;
+
+  /**
+   * 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_name?: string | null;
+}
+
+export namespace PaymentOrderUpdateParams {
+  export interface ReceivingAccount {
+    account_details?: Array<ReceivingAccount.AccountDetails>;
+
+    /**
+     * Can be `checking`, `savings` or `other`.
+     */
+    account_type?: 'checking' | 'other' | 'savings';
+
+    contact_details?: Array<ReceivingAccount.ContactDetails>;
+
+    /**
+     * Additional data represented as key-value pairs. Both the key and value must be
+     * strings.
+     */
+    metadata?: Record<string, string>;
+
+    /**
+     * A nickname for the external account. This is only for internal usage and won't
+     * affect any payments
+     */
+    name?: string | null;
+
+    /**
+     * Required if receiving wire payments.
+     */
+    party_address?: ReceivingAccount.PartyAddress;
+
+    party_identifier?: string;
+
+    /**
+     * If this value isn't provided, it will be inherited from the counterparty's name.
+     */
+    party_name?: string;
+
+    /**
+     * Either `individual` or `business`.
+     */
+    party_type?: 'business' | 'individual' | null;
+
+    /**
+     * If you've enabled the Modern Treasury + Plaid integration in your Plaid account,
+     * you can pass the processor token in this field.
+     */
+    plaid_processor_token?: string;
+
+    routing_details?: Array<ReceivingAccount.RoutingDetails>;
+  }
+
+  export namespace ReceivingAccount {
+    export interface PartyAddress {
+      /**
+       * Country code conforms to [ISO 3166-1 alpha-2]
+       */
+      country?: string | null;
+
+      line1?: string | null;
+
+      line2?: string | null;
+
+      /**
+       * Locality or City.
+       */
+      locality?: string | null;
+
+      /**
+       * The postal code of the address.
+       */
+      postal_code?: string | null;
+
+      /**
+       * Region or State.
+       */
+      region?: string | null;
+    }
+
+    export interface AccountDetails {
+      account_number: string;
+
+      account_number_type?: 'iban' | 'clabe' | 'wallet_address' | 'pan' | 'other';
+    }
+
+    export interface RoutingDetails {
+      routing_number: string;
+
+      routing_number_type:
+        | 'aba'
+        | 'swift'
+        | 'au_bsb'
+        | 'ca_cpa'
+        | 'cnaps'
+        | 'gb_sort_code'
+        | 'in_ifsc'
+        | 'my_branch_code'
+        | 'br_codigo';
+
+      payment_type?:
+        | 'ach'
+        | 'au_becs'
+        | 'bacs'
+        | 'book'
+        | 'card'
+        | 'check'
+        | 'eft'
+        | 'interac'
+        | 'provxchange'
+        | 'rtp'
+        | 'sen'
+        | 'sepa'
+        | 'signet'
+        | 'wire';
+    }
+
+    export interface ContactDetails {
+      contact_identifier?: string;
+
+      contact_identifier_type?: 'email' | 'phone_number';
+    }
+  }
+
+  export interface LineItems {
+    /**
+     * Value in specified currency's smallest unit. e.g. $10 would be represented
+     * as 1000.
+     */
+    amount: number;
+
+    /**
+     * The ID of one of your accounting categories. Note that these will only be
+     * accessible if your accounting system has been connected.
+     */
+    accounting_category_id?: string | null;
+
+    /**
+     * A free-form description of the line item.
+     */
+    description?: string | null;
+
+    /**
+     * Additional data represented as key-value pairs. Both the key and value must be
+     * strings.
+     */
+    metadata?: Record<string, string>;
+  }
+}
+
+export interface PaymentOrderListParams extends PageParams {
+  counterparty_id?: string;
+
+  direction?: 'credit' | 'debit';
+
+  /**
+   * An inclusive upper bound for searching effective_date
+   */
+  effective_date_end?: string;
+
+  /**
+   * An inclusive lower bound for searching effective_date
+   */
+  effective_date_start?: string;
+
+  /**
+   * 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.
+   */
+  metadata?: Record<string, string>;
+
+  originating_account_id?: string;
+
+  /**
+   * Query for records with the provided reference number
+   */
+  reference_number?: string;
+
+  status?:
+    | 'approved'
+    | 'cancelled'
+    | 'completed'
+    | 'denied'
+    | 'failed'
+    | 'needs_approval'
+    | 'pending'
+    | 'processing'
+    | 'returned'
+    | 'reversed'
+    | 'sent';
+
+  /**
+   * The ID of a transaction that the payment order has been reconciled to.
+   */
+  transaction_id?: string;
+
+  type?:
+    | 'ach'
+    | 'au_becs'
+    | 'bacs'
+    | 'book'
+    | 'card'
+    | 'check'
+    | 'eft'
+    | 'interac'
+    | 'provxchange'
+    | 'rtp'
+    | 'sen'
+    | 'sepa'
+    | 'signet'
+    | 'wire';
+}
+
+export interface PaymentOrderCreateAsyncParams {
+  /**
+   * 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.
+   */
+  amount: number;
+
+  /**
+   * 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`.
+   */
+  direction: 'credit' | 'debit';
+
+  /**
+   * The ID of one of your organization's internal accounts.
+   */
+  originating_account_id: string;
+
+  /**
+   * One of `ach`, `eft`, `wire`, `check`, `sen`, `book`, `rtp`, `sepa`, `bacs`,
+   * `au_becs`, `interac`, `signet`, `provexchange`.
+   */
+  type:
+    | 'ach'
+    | 'au_becs'
+    | 'bacs'
+    | 'book'
+    | 'card'
+    | 'check'
+    | 'eft'
+    | 'interac'
+    | 'provxchange'
+    | 'rtp'
+    | 'sen'
+    | 'sepa'
+    | 'signet'
+    | 'wire';
+
+  /**
+   * The ID of one of your accounting categories. Note that these will only be
+   * accessible if your accounting system has been connected.
+   */
+  accounting_category_id?: string | null;
+
+  /**
+   * The ID of one of your accounting ledger classes. Note that these will only be
+   * accessible if your accounting system has been connected.
+   */
+  accounting_ledger_class_id?: string | null;
+
+  /**
+   * The party that will pay the fees for the payment order. Only applies to wire
+   * payment orders. Can be one of shared, sender, or receiver, which correspond
+   * respectively with the SWIFT 71A values `SHA`, `OUR`, `BEN`.
+   */
+  charge_bearer?: 'shared' | 'sender' | 'receiver' | null;
+
+  /**
+   * Defaults to the currency of the originating account.
+   */
+  currency?:
+    | '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'
+    | 'EUR'
+    | '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'
+    | 'PAB'
+    | 'PEN'
+    | 'PGK'
+    | 'PHP'
+    | 'PKR'
+    | 'PLN'
+    | 'PYG'
+    | 'QAR'
+    | 'RON'
+    | 'RSD'
+    | 'RUB'
+    | 'RWF'
+    | 'SAR'
+    | 'SBD'
+    | 'SCR'
+    | 'SDG'
+    | 'SEK'
+    | 'SGD'
+    | 'SHP'
+    | 'SKK'
+    | 'SLL'
+    | 'SOS'
+    | 'SRD'
+    | 'SSP'
+    | 'STD'
+    | 'SVC'
+    | 'SYP'
+    | 'SZL'
+    | 'THB'
+    | 'TJS'
+    | 'TMM'
+    | 'TMT'
+    | 'TND'
+    | 'TOP'
+    | 'TRY'
+    | 'TTD'
+    | 'TWD'
+    | 'TZS'
+    | 'UAH'
+    | 'UGX'
+    | 'USD'
+    | 'UYU'
+    | 'UZS'
+    | 'VEF'
+    | 'VES'
+    | 'VND'
+    | 'VUV'
+    | 'WST'
+    | 'XAF'
+    | 'XAG'
+    | 'XAU'
+    | 'XBA'
+    | 'XBB'
+    | 'XBC'
+    | 'XBD'
+    | 'XCD'
+    | 'XDR'
+    | 'XFU'
+    | 'XOF'
+    | 'XPD'
+    | 'XPF'
+    | 'XPT'
+    | 'XTS'
+    | 'YER'
+    | 'ZAR'
+    | 'ZMK'
+    | 'ZMW'
+    | 'ZWD'
+    | 'ZWL'
+    | 'ZWN'
+    | 'ZWR';
+
+  /**
+   * An optional description for internal use.
+   */
+  description?: string | null;
+
+  /**
+   * An array of documents to be attached to the payment order. Note that if you
+   * attach documents, the request's content type must be `multipart/form-data`.
+   */
+  documents?: Array<PaymentOrderCreateAsyncParams.Documents>;
+
+  /**
+   * 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.
+   */
+  effective_date?: string;
+
+  /**
+   * 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)
+   */
+  fallback_type?: 'ach';
+
+  /**
+   * If present, indicates a specific foreign exchange contract number that has been
+   * generated by your financial institution.
+   */
+  foreign_exchange_contract?: string | null;
+
+  /**
+   * 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_indicator?: 'fixed_to_variable' | 'variable_to_fixed' | null;
+
+  /**
+   * 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?: PaymentOrderCreateAsyncParams.LedgerTransaction;
+
+  /**
+   * An array of line items that must sum up to the amount of the payment order.
+   */
+  line_items?: Array<PaymentOrderCreateAsyncParams.LineItems>;
+
+  /**
+   * Additional data represented as key-value pairs. Both the key and value must be
+   * strings.
+   */
+  metadata?: Record<string, string>;
+
+  /**
+   * 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.
+   */
+  nsf_protected?: boolean;
+
+  /**
+   * 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.
+   */
+  originating_party_name?: string | null;
+
+  /**
+   * 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.
+   */
+  priority?: 'high' | 'normal';
+
+  /**
+   * For `wire`, this is usually the purpose which is transmitted via the
+   * "InstrForDbtrAgt" field in the ISO20022 file. If you are using Currencycloud,
+   * this is the `payment.purpose_code` field. For `eft`, this field is the 3 digit
+   * CPA Code that will be attached to the payment.
+   */
+  purpose?: string | null;
+
+  /**
+   * 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.
+   */
+  receiving_account?: PaymentOrderCreateAsyncParams.ReceivingAccount;
+
+  /**
+   * 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.
+   */
+  receiving_account_id?: string;
+
+  /**
+   * 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.
+   */
+  remittance_information?: string | null;
+
+  /**
+   * 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.
+   */
+  send_remittance_advice?: boolean | null;
+
+  /**
+   * 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.
+   */
+  statement_descriptor?: string | null;
+
+  /**
+   * 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`.
+   */
+  subtype?: 'CCD' | 'CIE' | 'CTX' | 'IAT' | 'PPD' | 'TEL' | 'WEB' | null;
+
+  /**
+   * A flag that determines whether a payment order should go through transaction
+   * monitoring.
+   */
+  transaction_monitoring_enabled?: boolean;
+
+  /**
+   * Identifier of the ultimate originator of the payment order.
+   */
+  ultimate_originating_party_identifier?: string | null;
+
+  /**
+   * Name of the ultimate originator of the payment order.
+   */
+  ultimate_originating_party_name?: string | null;
+
+  /**
+   * Identifier of the ultimate funds recipient.
+   */
+  ultimate_receiving_party_identifier?: string | null;
+
+  /**
+   * Name of the ultimate funds recipient.
+   */
+  ultimate_receiving_party_name?: string | null;
+}
+
+export namespace PaymentOrderCreateAsyncParams {
+  export interface ReceivingAccount {
+    account_details?: Array<ReceivingAccount.AccountDetails>;
+
+    /**
+     * Can be `checking`, `savings` or `other`.
+     */
+    account_type?: 'checking' | 'other' | 'savings';
+
+    contact_details?: Array<ReceivingAccount.ContactDetails>;
+
+    /**
+     * Additional data represented as key-value pairs. Both the key and value must be
+     * strings.
+     */
+    metadata?: Record<string, string>;
+
+    /**
+     * A nickname for the external account. This is only for internal usage and won't
+     * affect any payments
+     */
+    name?: string | null;
+
+    /**
+     * Required if receiving wire payments.
+     */
+    party_address?: ReceivingAccount.PartyAddress;
+
+    party_identifier?: string;
+
+    /**
+     * If this value isn't provided, it will be inherited from the counterparty's name.
+     */
+    party_name?: string;
+
+    /**
+     * Either `individual` or `business`.
+     */
+    party_type?: 'business' | 'individual' | null;
+
+    /**
+     * If you've enabled the Modern Treasury + Plaid integration in your Plaid account,
+     * you can pass the processor token in this field.
+     */
+    plaid_processor_token?: string;
+
+    routing_details?: Array<ReceivingAccount.RoutingDetails>;
+  }
+
+  export namespace ReceivingAccount {
+    export interface PartyAddress {
+      /**
+       * Country code conforms to [ISO 3166-1 alpha-2]
+       */
+      country?: string | null;
+
+      line1?: string | null;
+
+      line2?: string | null;
+
+      /**
+       * Locality or City.
+       */
+      locality?: string | null;
+
+      /**
+       * The postal code of the address.
+       */
+      postal_code?: string | null;
+
+      /**
+       * Region or State.
+       */
+      region?: string | null;
+    }
+
+    export interface AccountDetails {
+      account_number: string;
+
+      account_number_type?: 'iban' | 'clabe' | 'wallet_address' | 'pan' | 'other';
+    }
+
+    export interface RoutingDetails {
+      routing_number: string;
+
+      routing_number_type:
+        | 'aba'
+        | 'swift'
+        | 'au_bsb'
+        | 'ca_cpa'
+        | 'cnaps'
+        | 'gb_sort_code'
+        | 'in_ifsc'
+        | 'my_branch_code'
+        | 'br_codigo';
+
+      payment_type?:
+        | 'ach'
+        | 'au_becs'
+        | 'bacs'
+        | 'book'
+        | 'card'
+        | 'check'
+        | 'eft'
+        | 'interac'
+        | 'provxchange'
+        | 'rtp'
+        | 'sen'
+        | 'sepa'
+        | 'signet'
+        | 'wire';
+    }
+
+    export interface ContactDetails {
+      contact_identifier?: string;
+
+      contact_identifier_type?: 'email' | 'phone_number';
+    }
+  }
+
+  export interface LedgerTransaction {
+    /**
+     * Format: yyyy-mm-dd.
+     */
+    effective_date: string;
+
+    /**
+     * Must be unique within the ledger.
+     */
+    external_id: string;
+
+    ledger_entries: Array<LedgerTransaction.LedgerEntries>;
+
+    description?: string;
+
+    ledgerable_id?: string;
+
+    ledgerable_type?:
+      | 'counterparty'
+      | 'expected_payment'
+      | 'incoming_payment_detail'
+      | 'internal_account'
+      | 'line_item'
+      | 'paper_item'
+      | 'payment_order'
+      | 'payment_order_attempt'
+      | 'return'
+      | 'reversal';
+
+    /**
+     * Additional data represented as key-value pairs. Both the key and value must be
+     * strings.
+     */
+    metadata?: Record<string, string>;
+
+    /**
+     * To post a ledger transaction at creation, use `posted`.
+     */
+    status?: 'archived' | 'pending' | 'posted';
+  }
+
+  export namespace LedgerTransaction {
+    export interface LedgerEntries {
+      amount?: number;
+
+      /**
+       * 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`.
+       */
+      direction?: 'credit' | 'debit';
+
+      ledger_account_id?: string;
+
+      /**
+       * 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.
+       */
+      lock_version?: number;
+    }
+  }
+
+  export interface LineItems {
+    /**
+     * Value in specified currency's smallest unit. e.g. $10 would be represented
+     * as 1000.
+     */
+    amount: number;
+
+    /**
+     * The ID of one of your accounting categories. Note that these will only be
+     * accessible if your accounting system has been connected.
+     */
+    accounting_category_id?: string | null;
+
+    /**
+     * A free-form description of the line item.
+     */
+    description?: string | null;
+
+    /**
+     * Additional data represented as key-value pairs. Both the key and value must be
+     * strings.
+     */
+    metadata?: Record<string, string>;
+  }
+
+  export interface Documents {
+    file: string;
+
+    /**
+     * A category given to the document, can be `null`.
+     */
+    document_type?: string;
+  }
+}