Create PositivePay Rule - V3

Create positive pay rule.

SecurityoAuth2
Request
Request Body schema: application/json
One of:
paymentRuleType
required
string
Enum: "FEDWIRE" "INSTANT"
customerName
required
string

Customer short name associated with the payment positive rule

customerAccountNumber
required
string

Bank Account Number

beneBankId
required
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. If the customer is processing org then beneName is required for "FEDNOW", otherwise it's always required.

beneBankName
string

Beneficiary bank name

beneAccountNumber
string

A beneficiary bank account number, other than customer processing org beneAccountNumber is required.

amount
required
number

Payment amount

amountType
required
string

Type of amount associated with the postive pay rule.

Enum: "EXACT" "MAXIMUM"
frequency
required
string

Positive pay rule frequency

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

Rule effective date in mm-dd-yyyy format

expiryDate
string

Rule expiry date in mm-dd-yyyy format

Responses
201

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

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