Customer transaction limits

Checks and returns the applicable per-transaction, daily, weekly, and monthly limits for the specified customer based on the requested payment amount, delivery date and payment rail.

SecurityoAuth2
Request
path Parameters
customerId
required
number

Unique Customer Id

Request Body schema: application/json
required
paymentAmount
number <double>

Specifies the amount to be used for the payment. It is used to determine whether the payment exceeds any defined limits based on the value provided during payment initiation. If not specified, the amount defaults to zero.

deliveryDate
string

Format: String with valid format as: MM-DD-YYYY.

The date on which the payment is scheduled to be initiated. This is used to validate the customer's payment limits. If not provided, the current date will be used as the payment date.

paymentRail
required
string

The delivery method for the payment.

Acceptable values:

  • FEDWIRE: Fedwire payment
  • FEDNOW: FedNow real-time payment
  • RTP: Real-Time Payments
  • ACH: Automated Clearing House payment
Enum: "FEDWIRE" "FEDNOW" "RTP" "ACH"
secCode
string = 3 characters

An SEC code (Standard Entry Class Code) is a three-letter code that describes how a payment was authorized by the consumer or business receiving an ACH transaction.

This is an optional field and is applicable only when the delivery method is set to "ACH".

Enum: "POP" "CCD" "PPD" "WEB" "CTX"
entryType
string

Specifies the entry type of the ACH transaction. It defines the direction of funds movement.

This field is required only if:

  • secCode is provided, and
  • paymentRail is set to "ACH".

Allowed values:

  • CREDIT
  • DEBIT
Enum: "CREDIT" "DEBIT"
Responses
200

Successfully retrieved applicable transaction limits

204

No applicable limit data found for the given request.

400

Bad request — invalid or missing input fields.

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

500

Internal server error

post/v1/customers/{customerId}/limits
Request samples
application/json
{
  • "paymentAmount": 100.55,
  • "deliveryDate": "06-30-2025",
  • "paymentRail": "FEDNOW",
  • "secCode": "CCD",
  • "entryType": "CREDIT"
}
Response samples
application/json
{
  • "limits": [
    ]
}