payment_flow_create_request

FintechPaymentsACHWiresTreasury

Properties

Name	Type	Description
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 associated with the payment. As part of the payment workflow an external account will be associated with this model.
originating_account_id	string	Required. The ID of one of your organization's internal accounts.
due_date	string	Optional. Can only be passed in when `effective_date_selection_enabled` is `true`. When set, the due date is shown to your end-user in the pre-built UI as they are selecting a payment `effective_date`

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/payment_flow_create_request",
  "title": "payment_flow_create_request",
  "type": "object",
  "properties": {
    "amount": {
      "type": "integer",
      "description": "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": {
      "type": "string",
      "description": "Required. The currency of the payment."
    },
    "direction": {
      "type": "string",
      "enum": [
        "credit",
        "debit"
      ],
      "description": "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": {
      "type": "string",
      "format": "uuid",
      "description": "Required. The ID of a counterparty associated with the payment. As part of the payment workflow an external account will be associated with this model."
    },
    "originating_account_id": {
      "type": "string",
      "format": "uuid",
      "description": "Required. The ID of one of your organization's internal accounts."
    },
    "due_date": {
      "type": "string",
      "format": "date",
      "description": "Optional. Can only be passed in when `effective_date_selection_enabled` is `true`. When set, the due date is shown to your end-user in the pre-built UI as they are selecting a payment `effective_date`."
    }
  },
  "required": [
    "amount",
    "currency",
    "direction",
    "counterparty_id",
    "originating_account_id"
  ]
}