GET /balancePlatforms/{id}/transferLimits

Filter and view the transfer limits configured for your balance platform using the balance platform's unique id and the available query parameters.

Servers

Path parameters

Name Type Required Description
id String Yes

The unique identifier of the balance platform.

Query parameters

Name Type Required Description
transferType String No

The type of transfer to which the limit applies. Possible values:

  • instant: the limit applies to transfers with an instant priority.
  • all: the limit applies to all transfers, regardless of priority.

Valid values:

  • "instant"
  • "all"
scope String No

The scope to which the transfer limit applies. Possible values:

  • perTransaction: you set a maximum amount for each transfer made from the balance account or balance platform.
  • perDay: you set a maximum total amount for all transfers made from the balance account or balance platform in a day.

Valid values:

  • "perDay"
  • "perTransaction"
status String No

The status of the transfer limit. Possible values:

  • active: the limit is currently active.
  • inactive: the limit is currently inactive.
  • pendingSCA: the limit is pending until your user performs SCA.
  • scheduled: the limit is scheduled to become active at a future date.

Valid values:

  • "inactive"
  • "active"
  • "pendingSCA"
  • "scheduled"

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.