Create customer account sweep

Create a customer account sweep

SecurityoAuth2
Request
path Parameters
customerUID
required
number^(?!0+$)[0-9]+$

Unique Customer Id

accountUID
required
number^(?!0+$)[0-9]+$

Unique Account Id

direction
required
string

Sweep Direction

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

Create Customer Account Sweeps Request Fields.

Any of:

Configuration for a sweep that supports both sweep-in and sweep-out directions.

balanceType
required
string

Specifies the sweep type, which defines how the account balance is managed. The range type is applicable for both sweep directions

Enum: "Target" "Range" "Zero"
required
object

Configuration for sweeping funds into the account.

required
object

Configuration for sweeping funds out of the account.

required
object
required
object

Frequency configuration for sweep execution.

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
{
  • "balanceType": "Range",
  • "sweepFrom": {
    },
  • "sweepTo": {
    },
  • "range": {
    },
  • "frequency": {
    }
}
Response samples
application/json
{
  • "errors": [
    ]
}