v1

latestOpenAPI 3.1.02026-07-241910582.8 KB

Create Payment Action

post/payment_actions

Request body

typestring 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_idstring

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_typestring

The type of the payment being actioned on. Supported values: payment_order, expected_payment

internal_account_idstring

The ID of one of your organization's internal accounts

Response

200

idstring

objectstring

live_modeboolean

typestring

statusstring

actionable_idstring

actionable_typestring

internal_account_idstring

created_atstring

updated_atstring

Example response

{
  "id": "12345678-abcd-efgh-ijkl-123456789012",
  "object": "payment_action",
  "type": "stop",
  "status": "pending",
  "actionable_id": "12345678-abcd-efgh-ijkl-123456789012",
  "actionable_type": "payment_order",
  "internal_account_id": "12345678-abcd-efgh-ijkl-123456789012",
  "details": {
    "amount": 2000,
    "currency": "USD",
    "check_number": "12323423",
    "issue_date": "2026-01-01",
    "payee_name": "Harry Potter",
    "originating_account_number": "123213"
  },
  "created_at": "2025-05-27T20:48:14Z",
  "updated_at": "2025-05-27T20:48:14Z"
}