A payment_order
is an instruction to move money to or from your bank account via payment types such as ACH, wire, RTP, and check. When a new payment order is created on Modern Treasury, we communicate with your bank to move the amount of money you specified.
Related Guides:
- Initiate an ACH payment
- Send an ACH prenote
- Initiate a Canadian EFT payment
- Send a wire transfer
- Sending a SWIFT wire
- Sending a payout over local rails
Attribute | Description |
---|---|
id string | Unique identifier for the payment order |
type string | One of
|
subtype string | An additional layer of classification for the type of payment order you are doing. This field is only used for For For For |
amount int64 | Value in specified currency's smallest unit. e.g. $10 (US Dollar) would be represented as For RTP, the maximum amount allowed by the network is $10,000,000. |
direction string | One of Describes the direction money is flowing in the transaction. A Note that rtp and check payments will always be |
status string | The current status of the payment order. See the for more on the different statuses. |
priority string | Either |
originating_account_id string | The ID of one of your organization's |
receiving_account_id string | The receiving account ID. Can be an or |
receiving_account_type string | The receiving account type. Can be one of |
ledger_transaction_id string | The ID of the ledger transaction linked to 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. |
description string | An optional description for internal use. |
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 |
process_after date | If present, Modern Treasury will not process the payment until after this time. If Format: ISO8601 timestamp |
statement_descriptor string | An optional descriptor which will appear in the receiver's statement. For |
remittance_information string | For |
purpose string | For that will be attached to the payment. |
metadata object | Additional data represented as key-value pairs. Both the key and value must be strings. See . |
counterparty_id string | If the payment order is tied to a specific , their id will appear, otherwise |
transaction_ids array | 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. |
current_return object | If the payment order's status is object's data. |
charge_bearer string | The party that will pay the fees for the payment order. Read 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 |
foreign_exchange_contract string | If present, indicates a specific foreign exchange contract number that has been generated by your financial institution. |
originating_party_name 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. |
ultimate_originating_account_id string | The account ID to which the origination of this payment should be attributed to. Can be a or . The originating account must be the parent account of the ultimate originating account. |
ultimate_originating_account_type string | The ultimate originating account type. Can be one of |
ultimate_originating_party_identifier string | Identifier of the ultimate originator of the payment order. |
ultimate_originating_party_name string | Name of the ultimate originator of the payment order. |
ultimate_receiving_party_identifier string | Identifier of the ultimate funds recipient. |
ultimate_receiving_party_name string | Name of the ultimate funds recipient. |
live_mode boolean | This field will be true if this object was created with a production API key or false if created with a test API key. |
nsf_protected boolean
| A boolean to determine if NSF Protection is enabled for this payment order.
|
reference_numbers array | An array of objects. |
vendor_failure_reason 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_attributes object | Additional vendor specific fields for this payment. Data must be represented as key-value pairs. Please contact for a list of supported attributes. |
send_remittance_advice boolean | Send an email to the counterparty when the payment order is sent to the bank. If is used. |
expires_at datetime | The datetime that a RFP type payment expires, |
external_id string | An optional user-defined 180 character unique identifier |
{
"id": "c5f4009c-bdd6-4cc1-84b2-17974ac9e77a",
"type": "ach",
"amount": 20000,
"direction": "credit",
"originating_account_id": "0f8e3719-3dfd-4613-9bbf-c0333781b59f",
"receiving_account_id": "5acec2ef-987b-4260-aa97-b719eeb0a8d5",
"receiving_account_type": "external_account",
"currency": "USD",
"effective_date": "2018-11-08",
"process_after": null,
"priority": "normal",
"description": "Repellendus deleniti atque quod.",
"statement_descriptor": "Rerum del.",
"remittance_information": "Accusamus tempore molestiae laboriosam.",
"metadata": {},
"status": "approved",
"counterparty_id": "37ba4454-dd33-4aa0-8906-0e2e4103e45c",
"send_remittance_advice": true,
"transactions_ids": [],
"current_return": null,
"charge_bearer": null,
"foreign_exchange_indicator": null,
"foreign_exchange_contract": null,
"subtype": null,
"purpose": null,
"nsf_protected": false,
"originating_party_name": "Acme Company",
"ultimate_originating_account_id": "388d37b2-3b15-48a8-8765-609241476a27",
"ultimate_originating_account_type": "virtual_account",
"ultimate_originating_party_name": "Jane Doe",
"ultimate_originating_party_identifier": "A1823N",
"ultimate_receiving_party_name": "Jane Doe",
"ultimate_receiving_party_identifier": "A1823N",
"live_mode": true,
"created_at": "2019-11-09T00:11:07Z",
"updated_at": "2019-11-09T00:11:07Z",
"vendor_attributes": null,
"external_id": null
}