Balance limits

The balance limit feature in nCore platform enables you to define the maximum and/or minimum limit on the funds an individual account can hold. Balance limit that you define shall be tied with the card product. Balance limit shall become applicable to the accounts associated with the card product.

Create balance limit

You can create a new balance limit as per your requirement by sending a POST request to /balancelimits endpoint as shown below.

POST /balancelimits

{ "description": "The balance limit – For account", "type": "PER_ACCOUNT", "min_amount": 1500, "max_amount": 1500, "currency": "USD" }

Retrieve balance limits

nCore offers two balance limits retrieval options.

Retrieve all balance limits

You can retrieve all existing balance limits by sending a GET request to /balancelimits endpoint shown below.

GET /balancelimits

Retrieve a specific balance limit

You can retrieve a specific balance limit by sending a GET request to /balancelimits/{id} endpoint, where id is the balance limit id.

GET /balancelimits/{id}

Update a balance limit

You can update a balance limit by sending a PUT request to /balancelimits/{id} endpoint as shown below.

PUT /balancelimits/{id}

Link balance limit with a card product

You can associate a balance limit to your card product by sending a POST requests to /cardproducts/{id}/balancelimits:link endpoint as shown below.

POST /cardproducts/{id}/balancelimits:link

Unlink a balance limit from a card product

You can unlink a balance limit from a card product by sending a POST request to /cardproducts/{id}/balancelimits:unlink endpoint as shown below.

POST /cardproducts/{id}/balancelimits:unlink

Retrieve linked balance limits

You can retrieve all balance limits which are linked with your card product. Send a GET request to /cardproducts/{id}/balancelimits endpoint as shown below.

GET /cardproducts/{id}/balancelimits

Link balance limit to account

You can link balance limit to the specific account. Send a POST request to /accounts/{id}/balancelimits:link endpoint as shown below.

POST /accounts/{id}/balancelimits:link

Unlink balance limit to account

You can unlink balance limit from the specific account. Send a POST request to /accounts/{id}/balancelimits:unlink endpoint as shown below.

POST /accounts/{id}/balancelimits:unlink

Get balance limits linked to account

You can get list of balance limits linked to specific account. Send a GET request to /accounts/{id}/balancelimits endpoint as shown below.

GET /accounts/{id}/balancelimits