Search PositivePay Rules

Search positive pay rules

SecurityoAuth2
Request
query Parameters
page
required
number

page index. And it a mandatory.

Example: page=1
records
required
number

page size. And it a mandatory.

Example: records=10
Request Body schema: application/json
beneBankId
string

Bank unique id or routing number that is used to identify a specific bank

beneName
string

The name of the company or entity that originated the payment request

beneBankName
string

Bank name where the company account is held.

beneAccountNumber
string

A company bank account number

amount
number

Payment amount

customerName
string

Name of the customer who created the positive rule

customerAccountNumber
string

Customer bank account number on which the positive rule is defined.

effectiveDate
string

Rule effective date in mm-dd-yyyy format

expiryDate
string

Rule expiration date in mm-dd-yyyy format

status
string

Current state of the rule whether Active or Expired etc.

paymentRuleType
string

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

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

post/v2/positivepay/rules/search
Request samples
application/json
{
  • "beneBankId": "12345678",
  • "beneName": "XYZ Name",
  • "beneBankName": "XYZ Bank",
  • "beneAccountNumber": "12345678",
  • "amount": 10,
  • "customerName": "string",
  • "customerAccountNumber": "12387878",
  • "effectiveDate": "11-01-2022",
  • "expiryDate": "11-01-2022",
  • "status": "Active",
  • "paymentRuleType": "ACH"
}
Response samples
application/json
{
  • "status": "Success or Failure",
  • "code": "PP001",
  • "message": "Failed to get positive rules: <Reason>",
  • "pagination": {
    },
  • "data": [
    ]
}