payment_action

FintechPaymentsACHWiresTreasury

Properties

Name	Type	Description
id	string
object	string
live_mode	boolean	This field will be true if this object exists in the live environment or false if it exists in the test environment.
created_at	string
updated_at	string
type	string	The type of the payment action. Determines the action to be taken.
status	string	The current status of the payment action. One of `pending`, `processing`, `sent`, `acknowledged`, `cancelled`, or `failed`.
actionable_id	string	The ID of the associated actionable object.
actionable_type	string	The type of the associated actionable object. One of `payment_order`, `expected_payment`.
internal_account_id	string	The ID of the internal account associated with the payment action.
details	object	The specifc details of the payment action based on type.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/payment_action",
  "title": "payment_action",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "format": "uuid"
    },
    "object": {
      "type": "string"
    },
    "live_mode": {
      "type": "boolean",
      "description": "This field will be true if this object exists in the live environment or false if it exists in the test environment."
    },
    "created_at": {
      "type": "string",
      "format": "date-time"
    },
    "updated_at": {
      "type": "string",
      "format": "date-time"
    },
    "type": {
      "type": "string",
      "description": "The type of the payment action. Determines the action to be taken."
    },
    "status": {
      "type": "string",
      "description": "The current status of the payment action. One of `pending`, `processing`, `sent`, `acknowledged`, `cancelled`, or `failed`."
    },
    "actionable_id": {
      "type": "string",
      "format": "uuid",
      "nullable": true,
      "description": "The ID of the associated actionable object."
    },
    "actionable_type": {
      "type": "string",
      "nullable": true,
      "description": "The type of the associated actionable object. One of `payment_order`, `expected_payment`."
    },
    "internal_account_id": {
      "type": "string",
      "format": "uuid",
      "description": "The ID of the internal account associated with the payment action."
    },
    "details": {
      "type": "object",
      "description": "The specifc details of the payment action based on type."
    }
  },
  "additionalProperties": false,
  "minProperties": 11,
  "required": [
    "id",
    "object",
    "live_mode",
    "created_at",
    "updated_at",
    "type",
    "status",
    "actionable_id",
    "actionable_type",
    "internal_account_id",
    "details"
  ]
}