Rate Limit

Introduction

Rate Limits define the maximum number of requests a user can make to the FPay API each minute. By limiting the number of requests to FPay, we ensure that the API remains stable and available to all users.
Thus, if a user exceeds the limit on the number of authorized requests, will receive a 429 error and will temporarily be unable to make any more requests for a certain period of time. You should anticipate this situation and stop sending requests to servers when you receive a 429 error. If you consistently exceed your throughput limits, we may have to block your access permanently.
We encourage you to model the requests you send to FPay servers very carefully. to FPay's servers. You have at your disposal a very powerful tool for making requests to our APIs, which you should prefer when you want to obtain a list of results.

Example

Let's say you have 3 Deposit objects with the following identifiers:

"1234"
"5678"
"9990"

If you want to retrieve the latest versions of Deposit objects, for example, to check their status, instead of making 3 different requests to the FPay servers, you can do it in a single request. All you need to do is list the Deposit whose identifiers are listed above.
Here's the code to do it:

const depositsCollectionPromise = 
    fPay.deposit.list({
        filter: "id in {'31234', '5678', '9990'}"
    });

This way of querying is explained in detail on this page.