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
amount
number

Payment amount

customerName
string

Short 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 Positive Pay, FEDWIRE for Drawdown, INSTANT for Request for Pay etc.

companyAccountNumber
string

A company bank account number.

companyName
string

A company is an entity that will receive the payment.

companyBankId
string

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

customerRoutingNumber
string

Receiver bank routing number.

amountType
string

Type of amount associated with the positive pay rule.

Enum: "EXACT" "MAXIMUM"
frequency
string

Positive pay rule frequency.

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

Transaction identification number used in ACH rule matching.

tranCode
string

Trancode.

Responses
200

Successfully processed request

400

Bad request

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

post/v2/positivepay/rules/search
Request samples
application/json
{
  • "amount": 10,
  • "customerName": "string",
  • "customerAccountNumber": "12387878",
  • "effectiveDate": "11-01-2022",
  • "expiryDate": "11-01-2022",
  • "status": "Active",
  • "paymentRuleType": "ACH",
  • "companyAccountNumber": "1122334",
  • "companyName": "Autobell",
  • "companyBankId": "071212128",
  • "customerRoutingNumber": "071212128",
  • "amountType": "EXACT",
  • "frequency": "Onetime",
  • "transactionIdNumber": "TXN12345",
  • "tranCode": "27"
}
Response samples
application/json
{
  • "status": "Success",
  • "data": [
    ],
  • "pagination": {
    }
}