Update PositivePay Rule

Update positive pay rule.

SecurityoAuth2
Request
path Parameters
ruleUID
required
string
Default: "11223"

Positive Pay Rule Unique ID

Request Body schema: application/json
paymentRuleType
string

Payment type associated with the rule such as ACH for Postive Pay, FEDWIRE for Drawdown, FEDNOW for Request for Pay etc.

Enum: "ACH" "FEDWIRE" "FEDNOW"
customerName
string

Customer short name associated with the payment positive rule.

customerAccountNumber
string

Bank Account Number.

achCompanyID
string

ACH company ID is a 10-digit identifier used by banks and Nacha, the operator of the ACH network, to identify the entity collecting payments or sending money via ACH (also referred to as an “originator”).

beneBankId
string

Bank unique id that is used to identify a specific bank.

beneName
string

A beneficiary is the person or entity that will receive the payment.

beneBankName
string

Beneficiary bank name.

beneAccountNumber
string

A beneficiary bank account number.

amount
number

Payment amount.

amountType
string

Type of amount associated with the postive pay rule.

Enum: "EXACT" "MAXIMUM"
frequency
string

Positive pay rule frequency

Enum: "Ongoing" "Onetime" "Daily" "Weekly" "Bi-weekly" "Monthly" "Quarterly" "Semi-annual" "Annual"
secCode
string

SEC code associated with the ACH postive rule. It is an optional field. If secCode is not provided in the request then the default value i.e 'ALL' will be applicable.

Enum: "ALL" "WEB" "PPD" "CCD" "CTX" "POP" "COR" "TEL" "CIE" "ARC" "BOC" "POS" "RCK" "ADV" "ATX" "DNE" "MTE" "SHR" "TRC" "TRX" "XCK" "IAT" "NA"
effectiveDate
string

Rule effective date in mm-dd-yyyy format

expiryDate
string

Rule effective date in mm-dd-yyyy format

Responses
200

Successfully processed request

400

bad input parameter environment

401

You are not authorized to access the resource

403

Accessing the resource you were trying to reach is forbidden

404

The resource you were trying to reach is not found

405

bad input parameter environment

500

Internal server error

503

Service unavailable

default

search results matching criteria

patch/v3/positivepay/rules/{ruleUID}
Request samples
application/json
{
  • "paymentRuleType": "ACH",
  • "customerName": "ABC Company",
  • "customerAccountNumber": "12387878",
  • "achCompanyID": "1234567899",
  • "beneBankId": "12345678",
  • "beneName": "XYZ Name",
  • "beneBankName": "Bank Name",
  • "beneAccountNumber": "12345678",
  • "amount": 10,
  • "amountType": "EXACT",
  • "frequency": "Annual",
  • "secCode": "CCD",
  • "effectiveDate": "12-31-2022",
  • "expiryDate": "12-31-2022"
}
Response samples
application/json
{
  • "data": {
    },
  • "errors": [
    ]
}