MOmodern-treasury

Create Payment Flow

Changed on

Deprecated: use Create Embeddable Flow instead. Create a payment flow

post/payment_flows

Request

  • Base URL
    https://app.moderntreasury.com/api
  • URL
    https://app.moderntreasury.com/api/payment_flows
  • Auth
    HTTP basic

Request body

amountinteger required

Value in specified currency's smallest unit. e.g. $10 would be represented as 1000. Can be any integer up to 36 digits.

currencystring required

The currency of the payment.

directionstring required

Describes the direction money is flowing in the transaction. Can only be debit. A debit pulls money from someone else's account to your own.

counterparty_idstring required

The ID of a counterparty associated with the payment. An external account created with this flow will be associated with this counterparty.

originating_account_idstring required

The ID of one of your organization's internal accounts.

effective_date_selection_enabledboolean

Enables the end user to select an effective date for the payment (e.g. the date transactions are to be posted to the participants' account).

due_datestring date

The date that the payment is due. The end user can view this date when selecting an effective date.

Response

201

idstring
objectstring
live_modeboolean
client_tokenstring
statusstring
amountinteger
currencystring
directionstring
counterparty_idstring
receiving_account_idunknown
originating_account_idstring
payment_order_idunknown
created_atstring
updated_atstring

Example response

{
  "id": "d93b8ae4-b30e-42ce-bc5d-e1ca5785f863",
  "object": "payment_flow",
  "live_mode": true,
  "client_token": "pay-live-fmsXHyYikKHstYHeSB6Co5AjezMqKoFKFhKmwnY2tvJMUFmndkarJY7GcwYkcBvr",
  "status": "pending",
  "amount": 10000,
  "currency": "USD",
  "direction": "debit",
  "counterparty_id": "34b33f71-daaa-4ce3-b9f3-a275e7b9a6f7",
  "originating_account_id": "ceab8d17-1312-44fe-94e2-a858370c3f10",
  "created_at": "2023-02-18T03:50:54Z",
  "updated_at": "2023-02-18T03:50:54Z"
}

Changes