---
title: "Create Payment Flow"
method: POST
path: "/payment_flows"
---

# Create Payment Flow

`POST /payment_flows`

Create a payment flow

## Request body

- object
  - `amount` integer, required — Value in specified currency's smallest unit. e.g. $10 would be represented as 1000. Can be any integer up to 36 digits.
  - `currency` string, required — The currency of the payment.
  - `direction` string, 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_id` string, required — The ID of a [counterparty](https://docs.moderntreasury.com/platform/reference/counterparty-object) associated with the payment. An external account created with this flow will be associated with this counterparty.
  - `originating_account_id` string, required — The ID of one of your organization's internal accounts.
  - `effective_date_selection_enabled` boolean — 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_date` string, date — The date that the payment is due. The end user can view this date when selecting an effective date.

## Response `201`

201

- object
  - `id` string
  - `object` string
  - `live_mode` boolean
  - `client_token` string
  - `status` string
  - `amount` integer
  - `currency` string
  - `direction` string
  - `counterparty_id` string
  - `receiving_account_id` unknown
  - `originating_account_id` string
  - `payment_order_id` unknown
  - `created_at` string
  - `updated_at` string

## Other responses

- `422` — 422

---

[API](https://skmtc.net/modern-treasury/apis/modern-treasury-api.md) · [All operations](https://skmtc.net/modern-treasury/apis/modern-treasury-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/modern-treasury/modern-treasury-api/revisions/ed0431a2dcd0/schema)
