Create customer account sweep

Create a customer account sweep

SecurityoAuth2
Request
path Parameters
customerUID
required
number

Unique Customer Id

accountUID
required
number

Unique Account Id

direction
required
string

Sweep Direction

Enum: "in" "out" "inout"
Request Body schema: application/json
required

Create Customer Account Sweeps Request Fields.

Any of:
beneficiaryInId
required
number

Beneficiary Unique ID only consists of digits.

frequency
required
string

Frequency of payment.

Enum: "Daily" "Weekly" "Monthly"
minBalance
required
number

Minimum balance to maintain in account.

paymentDays
number

Required when the frequency is set to Weekly or Monthly. For Weekly frequency, valid values are 1 to 7, where 1 represents Sunday and 7 represents Saturday. For Monthly frequency, valid values range from 1 to 31, representing the specific day of the month.

speed
required
string

Speed associated with the payment based on the delivery time. The Speed names and associated payment rail can be configured or defined by the bank/financial institutions. The supported payment rails in FinzlyOS are ACH, Fedwire, RTP or FedNow. The following are the standard speed names and payment rails configured by default Economy - [ACH-REGULAR], Economy Plus [ACH-SAMEDAY], Express [FEDWIRE], Instant [FEDNOW or RTP].

Enum: "Economy" "Economy Plus" "Express" "Instant"
Responses
201

Created

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

500

Internal server error

503

Service unavailable

default

Successful

post/v1/customers/{customerUID}/accounts/{accountUID}/sweeps/{direction}
Request samples
application/json
{
  • "beneficiaryInId": 46456,
  • "frequency": "Weekly",
  • "minBalance": 100,
  • "paymentDays": 5,
  • "speed": "Economy"
}
Response samples
application/json
{
  • "errors": [
    ]
}