Skip to main content

Using CSV Uploads for Payment Orders

Dani Weich
  • Updated

Within Modern Treasury, you have the option to either submit a single payment order or you can do a bulk payment order request.  With a bulk payment order, you have the ability to upload a maximum of 1,000 payment orders at one time.  

1st_pic.png

At the top right, if you select the Bulk Payment Order option, you will be redirected to the following page:

2nd_pic.png

Within this section, a Template CSV is available to be downloaded and then, in turn, uploaded in order to be processed. Below you will see the list of attributes that are included within the CSV and what is required versus not.

3rd.png

Note that values are case sensitive and should match the guidance shown below.

Payment Order Attributes

attribute Required Value Description
originating_account_id yes string
Internal Account ID		 This attribute can be located underneath the "Process CSV" button on the payment order upload screen. Your internal account will always be the originating account.
type yes string
View valid types 		Designates the payment type you would like to request for the payment orders (e.g. ach, wire, book, etc). Click here to view all valid payment types supported by the API.
subtype no string An additional layer of classification for the type of payment order you are doing. This attribute 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.

When Modern Treasury initiates an ACH payment on your behalf, the SEC Code is set automatically. When the receiving account's party_type is individual, the PPD code is used. When party_type is business or isn't set, CCD is used.
priority no
default: normal 		string
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
purpose no string This attribute means different things depending on the payment type:
  • For wire, this is usually the purpose which is transmitted via the InstrForDbtrAgt attribute in the ISO20022 file.
  • For CurrencyCloud, this is the payment.purpose_code attribute.
  • For eft, this attribute is the 3 digit CPA Code that will be attached to the payment.
amount yes or dollar_amount integer
format: cents

This attribute needs to be filled in if you want to designate the value in cents. Examples:

  • 10 = $0.10
  • 1000 = $10.00
  • 1234 = $12.34

If you use this attribute, do not use the dollar_amount attribute.
dollar_amount yes or amount float(2)
format: dollars without symbol ()

This attribute needs to be filled in the value of dollars. Examples:

  • 10 = $10
  • 10.00 = $10.00
  • 1234 = $1234.00

If you use this attribute, do not use the amount attribute.
direction yes string
debit or credit 		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 and check payment types will always be credit.
effective_date no string
format: yyyy-mm-dd 		The effective date is the date transactions are to be posted to the counterparty's account. If you wish to future date a payment order, you will want to fill in this attribute. If this attribute is not filled, it will default to the next business date.
description no string This attribute is solely for internal use anything included within this attribute will not be visible to the counterparty.
statement_descriptor no string The bank statement description should be used for your counterparties to see more detail within their bank statement. This oftentimes defaults to including your company name, but there is room to include at least 10 more characters.
remittance_information no string Remittance information is typically another attribute that can be utilized to describe the money that is being sent.

For ACH, this field will be passed through on an addenda record and can include up to 80 characters.

If this field is left blank then an addenda record would not be created. 

For wire payments the field will be passed through as the Originator to Beneficiary Information and can include up to 140 characters.
metadata no

string
format: key:value|key:value|...

 

Additional data represented as key-value pairs separated by a | (pipe character).

note: do not include special characters, outside of : and |
charge_bearer no string
shared, sender, or receiver

The party that will pay the fees for the payment order. Only applies to wire payment orders.

The values correspond to the SWIFT 71A values as follows:

  • shared: SHA (SHAred)
  • sender: OUR
  • receiver: BEN (BENeficiary)
foreign_exchange_contract no string If present, indicates a specific foreign exchange contract number that has been generated by your financial institution.
foreign_exchange_indicator no string
variable_to_fixed, fixed_to_variable, or null 		Indicates the type of FX transfer to initiate if the payment order currency matches the originating account currency.

Counterparty Attributes

The following attributes referring to counterparties will be dependent on whether a counterparty has or has not already been created within Modern Treasury.

Counterparty exists in Modern Treasury:

attribute Required Type Description
counterparty_account_id yes string Supports both internal and external accounts 

Counterparty does not exist in Modern Treasury:

Attribute Required Type Description
counterparty_name yes string Name of the counterparty
counterparty_routing_number yes string Routing number of the counterparty
counterparty_routing_type yes string Either aba, swift or ca_cpa.
counterparty_account_number yes   Account number of the counterparty
counterparty_account_number_type no
if domestic payment order		 string Supports iban and clabe. Otherwise null if the bank account number is in a generic format.
counterparty_account_type no string Can be checking, savings or other.
counterparty_party_type no string Either individual or business.
counterparty_address_line_1 no string Only required if this is a payment order for a wire.
counterparty_address_line_2 no string Only required if this is a payment order for a wire.
counterparty_address_locality no string Only required if this is a payment order for a wire (would be the city).
counterparty_address_region no string Only required if this is a payment order for a wire (would be the state).
counterparty_address_postal_code no string Only required if this is a payment order for a wire.
counterparty_address_country no string Only required if this is a payment order for a wire.

Continuous Accounting Attributes

attribute Required Type Description
accounting_class_id no string These IDs can be found in your organization settings page.

You should only use accounting_class_id or accounting_class_name (not both).
accounting_class_name no string These names can be found in your organization settings page.

You should only use accounting_class_id or accounting_class_name (not both).
accounting_account_id no string These IDs can be found in your organization settings page.

You should only use accounting_account_id or accounting_account_name (not both).
accounting_account_name no string These names can be found in your organization settings page.

You should only use accounting_account_id or accounting_account_name (not both).

Related articles

Powered by Zendesk