---
title: "Create Payment Action"
method: POST
path: "/payment_actions"
---

# Create Payment Action

`POST /payment_actions`

## Request body

- object
  - `type` string, required — The action decision for this specific payment action. The possible actions are determined based on the actionable. For a payment type of check, supported actions are `stop` and `issue`.
  - `actionable_id` string — The id of the payment to action on. If the `actionable_id` is present, the `actionable_type` must also be included. Data passed into the details will overwrite the information inferred from the actionable.
  - `actionable_type` string — The type of the payment being actioned on. Supported values: `payment_order`, `expected_payment`
  - `internal_account_id` string — The ID of one of your organization's internal accounts
  - `details` object — The `action` specific attributes of the off platform payment.
    - `amount` integer — `amount` is required to create a payment action for `check` payment types.
    - `check_number` string — `check_number` is required to initiate an action of `stop` or `issue` for `check` payment types.
    - `currency` string — `currency` is required to create a payment action for `check` payment types.
    - `issue_date` string, date — `issue_date` is required to create a payment action for `check` payment types. (YYYY-MM-DD)
    - `originating_account_number` string — `originating_account_number` is required to create a payment action for `check` payment types.
    - `payee_name` string — `payee_name` is required to create a payment action for `check` payment types.
    - `payee_name_2` string — Optional field to support a second `payee_name` line when initiating a positive pay action.

## Response `200`

200

- object
  - `id` string
  - `object` string
  - `live_mode` boolean
  - `type` string
  - `status` string
  - `actionable_id` string
  - `actionable_type` string
  - `internal_account_id` string
  - `details` object
    - `amount` integer
    - `currency` string
    - `check_number` string
    - `issue_date` string
    - `payee_name` string
    - `originating_account_number` string
  - `created_at` string
  - `updated_at` string

## Other responses

- `400` — 400

---

[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/versions/ed0431a2dcd0/schema)