TransferACHPositivePayRules

Get an ACH positive pay rule

Retrieve a single ACH positive pay rule by its ID.

get/ach-positive-pay-rules/{ach_positive_pay_rule_id}

Request

  • Base URL: https://api.column.com
  • URL: https://api.column.com/ach-positive-pay-rules/{ach_positive_pay_rule_id}
  • Auth: HTTP basic

Path parameters

ach_positive_pay_rule_idstring required

Response

Successful response

ach_company_idstring required

The ACH Company ID for the rule. This is a ten digit identifier.

ach_positive_pay_rule_idstring required

The unique ID of the ACH positive pay rule

amountinteger required

the amount threshold in cents that will be used in rule evaluation. Must not be set if amount_condition is set to ANY_AMOUNT

amount_conditionstring required

This required field configures the rule to make a specific kind of amount comparison. equal: The incoming debit will only be permitted if the transfer amount equals the rule amount. less_than_or_equal_to: The incoming debit will only be permitted if the transfer amount is less than or equal to the rule amount. any_amount: The incoming debit will be permitted for any amount.

bank_account_idstring required

ID of the bank account this rule applies to

descriptionstring required

Description of the rule. Maximum length: 255 characters.

Changes

No recorded changes to this operation across all 1 revision of this API.