Create Payment Order

post

https://app.moderntreasury.com/api/payment_orders

Create a new Payment Order

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

See Payment Orders for detailed information on each field.

Body Params

type

string

required

Select type from the list at Payment Orders

fallback_type

string

The payment type used to create the payment order 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)

subtype

string

An additional layer of classification for the type of payment order you are doing. This field is only used for ach and cross_border payment orders currently. Select subtype from the list at Payment Orders

amount

int64

required

Value in specified currency's smallest unit. e.g. $10 would be represented as 1000 (cents), and ¥10 would be represented as 10. Network and bank limits may apply.

direction

string

required

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.

originating_account_id

string

required

The ID of one of your organization's internal accounts

receiving_account_id

string

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

object

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. Note: This parameter is ignored when originating payments from a Modern Treasury Payments account; a receiving_account_id is required.

ledger_transaction

object

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. See Linking to other Modern Treasury objects.

ledger_transaction_id

string

Specifies the ID of a ledger transaction that will be linked to the payment order. If the payment order status and ledger transaction status do not match, the payment order creation will fail. The resulting ledger transaction will mirror the status of the payment order. See Linking to other Modern Treasury objects.

currency

string

Must conform to ISO 4217. Defaults to the currency of the originating account. For currency conversions, this must be the target currency.

process_after

date

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. Please reach out to your Customer Success team to determine if your bank connections support this feature.

effective_date

date

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

priority

string

Either normal or high. high priority is only available for ach, eft, and check payment types. For ACH and EFT payments, high represents a same-day transfer. For check payments, high can mean an overnight check rather than standard mail. For all other payment types, high priority payments are treated the same as normal priority payments.

description

string

An optional description for internal use.

statement_descriptor

string

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

string

For ach, this field will be passed through on an addenda record. For wire payments, this field will be passed through as the "Originator to Beneficiary Information", also known as OBI or Fedwire tag 6000. For rtp payments, this field will be included on the recipient's transaction.

purpose

string

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 required and is the 3 digit CPA Code that will be attached to the payment.

line_items

array of objects

An array of line items that must sum up to the amount of the payment order. For more information see Line Items

line_items

metadata

json

Additional data represented as key-value pairs. Both the key and value must be strings. See Metadata.

charge_bearer

string

The party that will pay the fees for the payment order. Read Charge Bearer to learn more about possible values and how they get serialized

foreign_exchange_indicator

string

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

string

If present, indicates a specific foreign exchange contract number that has been generated by your financial institution.

nsf_protected

boolean

Defaults to false

Default: false

A boolean to determine if NSF Protection is enabled for this payment order.

Note: This setting must also be turned on in your organization settings page and enabled per payment order.

originating_party_name

string

If present, this will replace your default company name on receiver's bank statement. Banks may institute maximum character lengths for different payment types. Characters above this limit may be truncated.

ultimate_originating_account_id

string

The id of the account to which the origination of this payment should be attributed to. You may pass the id of a virtual account or an internal account.

ultimate_originating_party_name

string

Name of the ultimate originator of the payment order.

ultimate_originating_party_identifier

string

Identifier of the ultimate originator of the payment order.

ultimate_originating_party_address

object

Address of the ultimate originator of the payment order.

ultimate_receiving_party_name

string

Name of the ultimate funds recipient.

ultimate_receiving_party_identifier

string

Identifier of the ultimate funds recipient.

documents

array of objects

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

send_remittance_advice

boolean

If true, an email will be sent to the counterparty when the payment order is sent to the bank. If false, the email will not be sent. If null, send_remittance_advice on the Counterparty will be used to determine whether the email is sent..

expires_at

date-time

RFP payments require an expires_at. This value must be past the effective_date.

vendor_attributes

json

Additional vendor specific fields for this payment. Data must be represented as key-value pairs. Please contact our support team ([email protected]) for a list of supported attributes.

external_id

string

An optional user-defined 180 character unique identifier

Response

200200